Add file-upload field to Blob POST end-point

[rma-rripken]

When using the Swagger-ui to upload blobs it is inconvenient/impossible to upload large blobs - the data would have to be b64 encoded and pasted into the swagger ui. The current solution works for small files and bits of text but not for anything substantial

Add a new multi-part form content type that the user could select and then the user could select a file on disk and enter the necessary form details (office, id, media, desc)

Instead of adding a new content type to the existing end-point another option is a new form-upload end-point

It seems like this should be workable in swagger javalin/javalin#859
Its unclear to me what the swagger-ui will look like if the existing end-point supports multipart-form and jsonv2 at the same time - will it show both sets of fields? That would be confusing and would make the separate end-point worthwhile.

[MikeNeilson]

That's definitely a /v2/blobs level change.

[krowvin]

@MikeNeilson

Should we make a project to track v2 issues to collect for that release?

[MikeNeilson]

@MikeNeilson

Should we make a project to track v2 issues to collect for that release?

Beyond just the issue that making a "project" within the org isn't the easiest thing (projects are org level) no, we're just doing releases from the main branch now so it'll get released when it gets released.

A milestone could work, but I'm not really should what the context would be.

[krowvin]

Mostly curious on how you want to handle grouping the fixes.

But I'm realizing you probably mean the header Accept v2

NOT

/cwms-data/v2?

[MikeNeilson]

Mostly curious on how you want to handle grouping the fixes.

But I'm realizing you probably mean the header Accept v2

NOT

/cwms-data/v2?

no I meant /cwms-data/v2/blobs. I think I'm trying to suggest you're getting too... granular? about it. Like why do we need to track/group that? We just do it and it shows up in swagger,

Now I'll grant how to group that in swagger will be... interesting. But that doesn't need a github project to deal with. Just some experimentation the first few elements.

[rma-rripken]

I asked AI (Junie) to add multipart-form support to the update method and the code looked right but I didn't launch it in Tomcat to try it out.

multipart-form was added as another accepted content-type.
I'm hoping that Swagger-ui only displays the form fields when multipart-form is selected but again, I havent tried it.
The controller combines the form-fields with the upload and builds a Blob object and then calls into the existing Dao method. So it reads the entire file into memory. Streaming the upload right into the database might be possible but that seems like a follow-up feature.

[MikeNeilson]

... I'm starting to wonder why everyone made such a big deal about being able to version the api, now. I mean yeah I was, maybe still am against, but the decision was made. There's even an ADR specifically for it.

As for Swagger UI selectively rendering fields, somehow I doubt it, we could've made things so much cleaner sooner if that was the case.

[rma-rripken]

I went ahead and tried running with the changes Junie suggested. The form portion of this does only show up in SwaggerUI when "application/x-www-form-urlencoded" is selected in the Request body drop down. I tried to Execute the request with a random local file and got an error. Sort of expected b/c I wasn't logged-in and I don't normally run CDA this way so maybe I'm missing something. I'll make a branch and push these changes in-case someone wants to continue from here. It at least seems possible to do.

[MikeNeilson]

huh, that's an odd failure. Doesn't look to have anything to do with either the upload file or being logged in.

But nice to know it will change the view.

[rma-rripken]

My branch is here but again, not tested. https://github.com/rma-rripken/cwms-data-api/tree/feature/blob_post_upload