EUDAT-B2STAGE / http-api

RESTful HTTP-API for the B2STAGE service inside the EUDAT project
https://eudat-b2stage.github.io/http-api/
MIT License
7 stars 7 forks source link

Better docs #99

Closed muccix closed 6 years ago

muccix commented 7 years ago

Detailed description of the fields and possible values in the responses. As we have done for the input field, do the same table for the response.

muccix commented 7 years ago

Replace pid with pid_await in PUT /api/registerd

muccix commented 7 years ago

Added the possibility to request a HEAD to verify whether the object already exists (to avoid to try to upload a big file already present)

pdonorio commented 7 years ago

Notes:

  1. we should create a content index, see the b2handle as example
  2. With this issue let's try to fix all docs issues
pdonorio commented 7 years ago

Also a way to test responses when uploading with streaming should be clarified somewhere.

pdonorio commented 7 years ago

Re-test and document the new /api/publish endpoint in usage.

pdonorio commented 7 years ago

See #41, there could be "iRODS instance setup in a way so it should NOT be able to put data". So we must say in the docs that this is not allowed with the current HTTP API release.

pdonorio commented 7 years ago

Specify that with streaming upload of a file to a collection path the trailing slash is mandatory due to Flask internals. This does not occurs with normal (form) upload.

pdonorio commented 6 years ago

There's some testing to check and real feedback on the quickstart

pdonorio commented 6 years ago

Replace pid with pid_await in PUT /api/registered

Done with 1f24a2c67b9d4be61cb4ac52ea283cd26d5000f0

pdonorio commented 6 years ago

Clarify also that b2safe and b2access authentication are mutually exclusive

pdonorio commented 6 years ago

@muccix you can now see the new index

pdonorio commented 6 years ago

Add instructions to create the account for the HTTP API in B2ACCESS to the docs


  1. Go to https://b2access.eudat.eu/home/
  2. Click on the register a new account link
  3. Oauth 2.0 Client Registration Form
  4. As “OAuth client return URL” indicate https://YOUR_SERVER/auth/authorize

When you receive your credentials you should apply them in the project_configuration.yaml

pdonorio commented 6 years ago

Add:

pdonorio commented 6 years ago

Ready to release 1.0.2