Closed nerg4l closed 6 months ago
I'm still getting familiar with the available Uppy components.
These endpoints will only change if @uppy/companion
changes, am I wrong?
I think @uppy/aws-s3-multipart
could be used for the "Setup Uppy client". That component has a predefined set of routes.
Also, @uppy/companion
has great documentation for the routes. Example: https://github.com/transloadit/uppy/blob/960362b373666b18a6970f3778ee1440176975af/packages/%40uppy/companion/src/server/controllers/s3.js#L36-L50
Maybe it's enough to put these somewhere on uppy.io.
These endpoints will only change if
@uppy/companion
changes, am I wrong?
No we are updating the section on using it with your own server. At the moment the endpoints don't matter at all. For instance in createMultipartUpload
you have to use fetch
to your own backend. You're in control what endpoint you fetch, not Uppy.
As discussed before we should change the property name from companionUrl
to endpoint
and document what to do exactly so you don't have to write this all manually. But until this in there, we need to write docs for the current reality, brining me back to my two suggestions above.
From a user's point of view, I think the first option would be better.
Would you like to make the change?
I will update this PR later today. I can only work on it outside of European working hours.
The first PR to change the endpoints in the documentation.
https://github.com/transloadit/uppy/blob/960362b373666b18a6970f3778ee1440176975af/packages/%40uppy/companion/src/server/controllers/s3.js#L439-L447
Related to #213