Expand documentation on API endpoint Xenia queries

coralproject / ask-docs

Official Ask Documentation for The Coral Project

https://docs.coralproject.net/ask/

Other

11 stars 14 forks source link

Expand documentation on API endpoint Xenia queries #48

Closed gabelula closed 7 years ago

gabelula commented 8 years ago

We want people to use the pillar API to send data into Trust as well as Xenia for quering aggregations. This is a very good example for documentation on how to use a REST API:

https://stripe.com/docs/api/curl#intro

sfphoenix commented 8 years ago

@gabelula which elements in that Stripe url resonate most for you?

API call via curl
libraries in multiple languages
explanation of the endpoint usage
syntax highlighting
docs layout

The thing that stands out is the single page which allows for a quick search via 'Cmd+F' (Mac) or 'Ctrl+F' (Windows).

gabelula commented 8 years ago

it is clear on how to use the API
it includes libraries in multiple languages
explanation of the endpoint usage

sfphoenix commented 8 years ago

Thanks for the clarification @gabelula ;-)

kgardnr commented 8 years ago

@sfphoenix (cc @gabelula & @jde) - i think we should break this down into work for each API we have; and questionable if we should do it for pillar if we are planning on eventually deprecating? thoughts?

sfphoenix commented 7 years ago

Refining this issue to be placeholder for Xenia queries as Shelf (Pillar) API has a separate issue https://github.com/coralproject/docs/issues/37