Skip to content
This repository has been archived by the owner on Dec 17, 2019. It is now read-only.

document that kind of object that is required for the /files route #158

Open
Pomax opened this issue Sep 22, 2015 · 4 comments
Open

document that kind of object that is required for the /files route #158

Pomax opened this issue Sep 22, 2015 · 4 comments

Comments

@Pomax
Copy link
Contributor

Pomax commented Sep 22, 2015

The documentation on https://github.com/mozilla/publish.webmaker.org/wiki/Files-Resource is quite good, but does not mention what kind of object layout is required for the buffer parameter.

After working with @sedge, it seems the clearest way to success is building a FormData object, sent as multi-part file, which will require some more text + examples to explain how to properly make calls to this route succeed

@ashleygwilliams
Copy link
Contributor

+1

@gideonthomas
Copy link
Contributor

In addition to this, we need to document the */files/tar and */files/meta routes too along with explicitly calling out the fact that the json routes are still available

@sedge
Copy link
Contributor

sedge commented Sep 24, 2015

Maybe what we actually need is a client library for interacting with the publish server?

@Pomax
Copy link
Contributor Author

Pomax commented Sep 30, 2015

not sure we need quite that much: having detailed docs lets people simply drop routes and a payload into a request call, without needing to load additional utilities

@gideonthomas gideonthomas added the P2 label Jan 8, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants