f81cf9a905
Follow PTI [1] for doc building: * Create doc/requirements.txt file with all docs requirements. * Switch to openstackdocstheme and update conf.py for this. * Move doc8 to pep8 section since it's a linter. Additionally: * Fix all build errors with doc building. * Update requirements list with license info. * Use hacking instead of flake directly. * Remove unused _static files, those are not needed. * Update git URLs, fix contributor guide URL * Move README.md to RST, everything else in this repo is RST * Publish documents to docs.o.o - note that https://adjutant.readthedocs.io/en/latest/ was last updated in March 2018 This adds jobs for building of release notes - only building since there's no content yet - and publishing of documentation. Publishing of api-ref can be done via: https://review.opendev.org/675766 [1] https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation Change-Id: I82f56ef5ea800899b2a8db795b6cf2b21d03ac7a
2.1 KiB
Version 1 API reference
This is the reference for Adjutant when it is using the default configuration. Different deployments may exclude certain task views or include their own additional ones.
The core functionality of Adjutant is built around the concept of tasks and actions.
Actions are both concepts in the database and code that can execute whatever logic is necessary at each stage.
Tasks can bundle a number of actions and have 3 main steps.
- A user submits a request to the specified endpoint.
- An admin approves the request, or it is automatically approved. At this point the admin can also update invalid data inside the task.
- If necessary a user will be emailed a token and will submit additional data (ie passwords or a confirmation) to finish the task.
Depending on the task and the data provided some steps may be skipped.
Authentication
The 'X-Auth-Token' header value should be provided for authentication with a valid Keystone token.
HTTP Status Codes
- 200
- 200: task-view
- 202
- 400
- 401
- 403
- 404
- 405
- 409
- 500
- 503
Service Discovery
Version Discovery Endpoint
Unauthenticated.
JSON containing details of the currently available versions (just v1 for now)
Normal response code: 200
Version One Details Endpoint
Unauthenticated.
Details V1 version details and the available taskviews and their fields. See below for further details on the individual taskviews.
Normal response code: 200
Additional API Documentation
While in debug mode the service will supply online browsable documentation via Django REST Swagger.
This is viewable at: ../docs