Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document "/media" REST endpoint file upload mechanics #129

Open
CoherenceLabs opened this issue May 28, 2022 · 1 comment
Open

Document "/media" REST endpoint file upload mechanics #129

CoherenceLabs opened this issue May 28, 2022 · 1 comment

Comments

@CoherenceLabs
Copy link

The REST v2 /media endpoint reference would benefit from a mention of file content upload mechanics. The first technique documented in this gist I found (set the Content-Disposition HTTP header field to form-data; filename="thefile.jpg" and send the file's content as the HTTP body data) ended up working for me, but it would be helpful to have official documentation on this embedded in or linked from the /media endpoint reference.

@TimothyBJacobs
Copy link
Member

Yeah this could definitely be improved. Unfortuantely, however, the Reference documentation is entirely generated from the Schema of the nedpoint. So we don't actually have a way right now to add custom content to those pages.

The need for that functionality has come up a couple of times, however. So it's probably worth adding support for that somehow. Just not sure what it would look like at the moment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants