CRICDatabase / searchable-image-database-nodejs

Backend in Node.js for CRIC Searchable Image Database

GNU Affero General Public License v3.0

1 stars 5 forks source link

Document collection endpoints in https://stoplight.io #148

Closed rgaiacs closed 3 years ago

rgaiacs commented 4 years ago

Blocks:

We are using https://stoplight.io to manage the OpenAPI.

POST

[ ] /collections
[ ] ~~/collections/{id_collection}/public~~ as we will use slang instead of id_collection.
[ ] /collections/{slang}/public

GET

[ ] /collections
[ ] /collections/{slang}

PUT

[ ] /collections/{slang}

DELETE

[ ] /collections/{slang}
[ ] ~~/collections/{id_collection}/public~~ as we will use slang instead of id_collection.
[ ] /collections/{slang}/public

rgaiacs commented 4 years ago

@costascaio please note that we are using /collections/foo instead of /collections/1. This is similar to how GitHub API works.