x/stacktach
Code Issues Proposed changes

Merge pull request #276 from ramielrowe/docs

Browse Source 
A little more details in database api description
This commit is contained in:
Andrew Melton 2014-01-17 10:22:53 -08:00
commit e50a3c3f3a
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/dbapi.rst
View File

@ -4,7 +4,7 @@ The StackTach Database REST Interface
JSON Response Format
********************
The StackTach Database API uses a more standard data model for access of to database objects
The StackTach Database API uses a more standard data model for access to database objects. The Database API is read only, with the exception of usage confirmation, which is used to indicate that usage has been sent downstream.
The JSON response format uses an envelope with a single key to indicate the type of object returned. This object can be either a dictionary in the case of queries that return single objects, or a list when multiple objects are turned.
@ -37,6 +37,8 @@ Sample JSON response, multiple objects: ::
]
}
Write APIs
**********
db/confirm/usage/exists/batch/
=====================================
@ -95,6 +97,9 @@ db/confirm/usage/exists/batch/
Vary: Accept
Content-Type: application/json
Read APIs
*********
db/usage/launches/
==================