coralproject / ask-docs

Official Ask Documentation for The Coral Project
https://docs.coralproject.net/ask/
Other
11 stars 14 forks source link

Update Shelf (Pillar) API documentation #37

Open aiboyles opened 8 years ago

aiboyles commented 8 years ago

The Pillar API document currently has a template listing all available endpoints: https://github.com/coralproject/docs/blob/master/docs_dir/pillar/api.md

Each endpoint should have the following information:

Some endpoints already have some information filled in (such as parameters), but it may not be correct.

jde commented 7 years ago

When looking into api documentation, take a look at this: http://swagger.io/ It allows us to describe our apis, document them and allow people to play with them.

sfphoenix commented 7 years ago

Pillar Endpoints - import, tag, search, update, form, galleries, etc

sfphoenix commented 7 years ago

Endpoints need to be documented with resource names, properties and example calls.

sfphoenix commented 7 years ago

Thanks for the feedback @gabelula. I've updated the title of this issue and will be creating additional issue items for Askd and Corald 👍