airship/promenade
Code Issues Proposed changes
b1c8e02f46
promenade/docs/source/api.rst
Samantha Blanco 0604b0404f Improve Promenade validatedesign message 
Improves validatedesign return message by including count and list
of validation errors.

Change-Id: I7771eafedaa56c748f43fe1212926154933f247f
2018-04-03 10:53:25 -04:00

1.1 KiB
Raw Blame History

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