13bc298f60
This patchset updates docs to doc to align with OpenStack standard. Follow-up patchset will be needed to publish documentation to OpenStack [0]. [0] https://docs.openstack.org/doc-contrib-guide/project-guides.html Change-Id: I0f2346801bc3749e74fcc3104cc2258626747185
1.1 KiB
1.1 KiB
Promenade API
/v1.0/health
Allows other components to validate Promenade's health status.
GET /v1.0/health
Returns the health status.
Responses:
- 204 No Content
/v1.0/join-scripts
Generates join scripts and for Drydock.
GET /v1.0/join-scripts
Generates script to be consumed by Drydock.
Query parameters
- hostname
-
Name of the node
- ip
-
IP address of the node
- design_ref
-
Endpoint containing configuration documents
- dynamic.labels
-
Used to set configuration options in the generated script
- static.labels
-
Used to set configuration options in the generated script
Responses:
- 200 OK: Script returned as response body
- 400 Bad Request: One or more query parameters is missing or misspelled
/v1.0/validatedesign
Performs validations against specified documents.
POST /v1.0/validatedesign
Performs validation against specified documents.
Message Body
- href
-
Location of the document to be validated
Responses:
- 200 OK: Documents were successfully validated
- 400 Bad Request: Documents were not successfully validated