jdb/strawboss
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation for server module, stubbed out API methods.

Browse Source
This commit is contained in:
Jonathan Bernard
2017-05-11 10:48:43 -05:00
parent f6b347a4ed
commit e2c3aeca09
2 changed files with 59 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
api.rst
View File

@ -1,17 +1,20 @@
✓ GET /api/ping
✓ GET /api/auth-token
✓ GET /api/verify-auth -- returns 200 or 401 depend on validity of the provided auth
✓ GET /api/projects -- return project summaries
- POST /api/projects -- create a new project
* GET /api/project/<proj-id> -- return detailed project record (include steps)
- GET /api/project/<proj-id>/active -- return detailed information about all currently running runs
✓ GET /api/project/<proj-id>/versions -- list the versions of this project that have been built
- GET /api/project/<proj-id>/<step-id> -- return detailed step information (include runs)
* POST /api/project/<proj-id>/<step-id>/run/<ref> -- kick off a run
- GET /api/project/<proj-id>/<step-id>/run/<ref> -- return detailed run information
✓ GET /api/ping -- returns "pong"
✓ POST /api/auth-token -- create an return an auth token given {"username": "...", "password": "..."}
✓ GET /api/verify-auth -- returns 200 or 401 depend on validity of the provided auth (auth ping)
✓ GET /api/projects -- return project summaries
- POST /api/projects -- create a new project
- GET /api/project/<proj-id> -- TODO
- GET /api/project/<proj-id>/runs -- list summary information for all runs
- GET /api/project/<proj-id>/runs/active -- list summary information about all currently active runs
- GET /api/project/<proj-id>/runs/<run-id> -- list detailed information about a specific run
✓ GET /api/project/<proj-id>/versions -- list the versions of this project that have been built
* GET /api/project/<proj-id>/version/<ref> -- return detailed project definition (include steps) at a specific version
- GET /api/project/<proj-id>/step/<step-id> -- return detailed step information (include runs)
* POST /api/project/<proj-id>/step/<step-id>/run/<ref> -- kick off a run
Legend:
✓ implemented with passing tests
* implemented, needs testing
- not implemented
M missing (not even stubbed out)