UploadAttachments - REST API changed, no hints in docs

[desperateCoder]

Hi!
As a Maintainer of the Android Deck app i encounter some problems with uploading Attachments:
Starting from version 1.17.0 the endpoint expects the file data as a string (?!) while the docs state, that it should be uploaded as multipart/form-data.

Here's what i see in the logs:
"File":"/var/www/[redacted subfolder]/[redacted domain]/httpdocs/apps/deck/lib/Controller/AttachmentApiController.php","Line":49,"message":"Failed to call controller method: OCA\Deck\Controller\AttachmentApiController::create(): Argument #3 ($data) must be of type string, null given

Can someone please clarify how i am supposed to call the Endpoint from now on? 🤔

Here's my current implementation (still using v1.0, using v1.1 didn't change anything unfortunately):

final MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", attachment.getName(), RequestBody.create(MediaType.parse(getMimeType(attachment)), attachment));
final MultipartBody.Part typePart = MultipartBody.Part.createFormData("type", null, RequestBody.create(MediaType.parse(TEXT_PLAIN), type));

this.requestHelper.request(() -> provider.getDeckAPI().uploadAttachment(remoteBoardId, remoteStackId, remoteCardId, typePart, filePart), responseCallback);

As a Sidenote: The API doc is outdated and incomplete for years, I had to do a massive amount of reverse engineering and look up the code of this repo. Go ahead and try creating a Card via curl using only the information provided by the API docs, you will see what i mean... So a little bit love for the docs would be much appreciated! ❤️

EDIT:
By the way, the Response of the server in that case is a HTTP 400 with the body[] - that's it. Would be really great to actually know whats wrong. 🙈

[grnd-alt]

Thanks for reporting this! the docs on this are indeed not very nice...
The data attribute should not be enforced to be a string as the file is taken from the file param as you did it correctly in your code example.
As a work around you can write an empty string as the data attribute and it should work (looks like the data field is not used, will have to figure what that's about....)

Here's a working curl command that worked for me:
curl --request POST
--url http://nextcloud.local/index.php/apps/deck/api/v1.1/boards/1/stacks/1/cards/1/attachments
--header 'authorization: <auth>'
--header 'content-type: multipart/form-data'
--header 'ocs-apirequest: true'
--form file=<filepath>
--form type=file
--form 'data=Hello World'

I will close this issue and create two more: one for cleaning up the docs, and one for cleaning up the code paths in attachments.

[desperateCoder]

@grnd-alt awesome, thanks for the quick reply! And adding an empty string as data part indeed fixed the upload!

looks like the data field is not used, will have to figure what that's about...

I subscribed to #7682 - so if the api docs get updated, the future of this param will be written there, right?

Why i'm asking: my current impl sends the extra data param for a deck version >=1.17.0. if it gets removed in 1.17.1, it would break our app again. So if it isn't mentioned in #7682, a small hint would be much appreciated!

Thanks again for the super fast support, we'll release the changes asap so the new version is supported by the Android app 😊

[grnd-alt]

@desperateCoder Yes changes to the API will be reflected there or in a PR to the docs that will most likely also be mentioned in the issue.

but tbh I don't think there will be a change that breaks that, afaik sending to many params does not cause a Bad request response, so the endpoint should still work either way when sending "data".