490cb84ba0
REST API using falcon library Middleware for authentication (stubbed until Keystone is avail) Middleware for context and logging Request logging and initial error logging README updates |
||
---|---|---|
.. | ||
__init__.py | ||
api.py | ||
base.py | ||
designs.py | ||
middleware.py | ||
readme.md | ||
tasks.py |
Control
This is the external facing API service to control the rest of Drydock and query Drydock-managed data.
Anticipate basing this service on the falcon Python library
Endpoints
/tasks
POST - Create a new orchestration task and submit it for execution GET - Get status of a task DELETE - Cancel execution of a task if permitted
/designs
POST - Create a new site design so design parts can be added
/designs/{id}
GET - Get a current design if available. Param 'source=compiled' to calculate the inheritance chain and compile the effective design.
/designs/{id}/parts
POST - Submit a new design part to be ingested and added to this design GET - View a currently defined design part PUT - Replace an existing design part Not Implemented
/designs/{id}/parts/{kind}/{name}
GET - View a single design part. param 'source=compiled' to calculate the inheritance chain and compile the effective configuration for the design part.