diff options
Diffstat (limited to 'api-ref/source/configurations.inc')
| -rw-r--r-- | api-ref/source/configurations.inc | 164 |
1 files changed, 63 insertions, 101 deletions
diff --git a/api-ref/source/configurations.inc b/api-ref/source/configurations.inc index 188d9733..d65ce5bb 100644 --- a/api-ref/source/configurations.inc +++ b/api-ref/source/configurations.inc @@ -1,24 +1,20 @@ .. -*- rst -*- -===================================== -Configuration groups (configurations) -===================================== +==================== +Configuration groups +==================== -Creates and lists all configuration groups. -Create configuration group -~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. rest_method:: POST /v1.0/{project_id}/configurations +List configuration groups +~~~~~~~~~~~~~~~~~~~~~~~~~ -Creates a configuration group. +.. rest_method:: GET /v1.0/{project_id}/configurations -Normal response codes: 200 +Lists all configuration groups. -Error response codes: badRequest(400), unauthorized(401), forbidden(403), -itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422), -instanceFault(500), notImplemented(501), serviceUnavailable(503) +Normal response codes: 200 Request @@ -26,106 +22,90 @@ Request .. rest_parameters:: parameters.yaml - - datastore: datastore - - values: values - - name: name - project_id: project_id -Request Example ---------------- - -.. literalinclude:: samples/db-create-config-group-request.json - :language: javascript - - Response Example ---------------- -.. literalinclude:: samples/db-create-config-group-response.json +.. literalinclude:: samples/config-groups-list-response.json :language: javascript -List configuration groups -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. rest_method:: GET /v1.0/{project_id}/configurations +Create configuration group +~~~~~~~~~~~~~~~~~~~~~~~~~~ -Lists all configuration groups. +.. rest_method:: POST /v1.0/{project_id}/configurations -The list includes the associated data store and data store version -for each configuration group. +Creates a configuration group. Normal response codes: 200 -Error response codes: badRequest(400), unauthorized(401), forbidden(403), -itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422), -instanceFault(500), notImplemented(501), serviceUnavailable(503) - - Request ------- .. rest_parameters:: parameters.yaml - project_id: project_id + - datastore: datastore + - name: name + - values: values + + +Request Example +--------------- + +.. literalinclude:: samples/config-group-create-request.json + :language: javascript Response Example ---------------- -.. literalinclude:: samples/db-list-cfg-groups-response.json +.. literalinclude:: samples/config-group-create-response.json :language: javascript -List configuration group instances -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Show configuration group details +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. rest_method:: GET /v1.0/{project_id}/configurations/{configId}/instances +.. rest_method:: GET /v1.0/{project_id}/configurations/{configId} -Lists the instances associated with the specified configuration group. +Lists details about a configuration group, including its values. Normal response codes: 200 -Error response codes: badRequest(400), unauthorized(401), forbidden(403), -itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422), -instanceFault(500), notImplemented(501), serviceUnavailable(503) - Request ------- .. rest_parameters:: parameters.yaml - - configId: configId - project_id: project_id + - configId: configId Response Example ---------------- -.. literalinclude:: samples/db-config-group-instances-response.json +.. literalinclude:: samples/config-group-show-response.json :language: javascript -Delete configuration group -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. rest_method:: DELETE /v1.0/{project_id}/configurations/{configId} +List instances applied the configuration group +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Deletes a configuration group. +.. rest_method:: GET /v1.0/{project_id}/configurations/{configId}/instances -Normal response codes: 202 +Lists the instances associated with the specified configuration group. -Error response codes: badRequest(400), unauthorized(401), forbidden(403), -itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422), -instanceFault(500), notImplemented(501), serviceUnavailable(503) +Normal response codes: 200 Request @@ -133,8 +113,15 @@ Request .. rest_parameters:: parameters.yaml - - configId: configId - project_id: project_id + - configId: configId + + +Response Example +---------------- + +.. literalinclude:: samples/config-group-list-instances-response.json + :language: javascript @@ -148,49 +135,35 @@ Sets new values for a configuration group. Normal response codes: 200 -Error response codes: badRequest(400), unauthorized(401), forbidden(403), -itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422), -instanceFault(500), notImplemented(501), serviceUnavailable(503) - Request ------- .. rest_parameters:: parameters.yaml - - values: values - - configId: configId - project_id: project_id + - configId: configId + - values: values Request Example --------------- -.. literalinclude:: samples/db-patch-config-group-request.json +.. literalinclude:: samples/config-group-patch-request.json :language: javascript -Response Example ----------------- -.. literalinclude:: samples/db-patch-config-group-response-json-http.txt - :language: javascript - - - - -Show configuration group details -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. rest_method:: GET /v1.0/{project_id}/configurations/{configId} +Update configuration group +~~~~~~~~~~~~~~~~~~~~~~~~~~ -Lists details about a configuration group, including its values. +.. rest_method:: PUT /v1.0/{project_id}/configurations/{configId} +Sets new values for a configuration group. Also lets you change the name and +description of the configuration group. -Normal response codes: 200 -Error response codes: badRequest(400), unauthorized(401), forbidden(403), -itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422), -instanceFault(500), notImplemented(501), serviceUnavailable(503) +Normal response codes: 202 Request @@ -198,31 +171,30 @@ Request .. rest_parameters:: parameters.yaml - - configId: configId - project_id: project_id + - configId: configId + - values: values + - description: description + - name: name -Response Example ----------------- +Request Example +--------------- -.. literalinclude:: samples/db-config-group-details-response.json +.. literalinclude:: samples/config-group-put-request.json :language: javascript -Update configuration group +Delete configuration group ~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. rest_method:: PUT /v1.0/{project_id}/configurations/{configId} +.. rest_method:: DELETE /v1.0/{project_id}/configurations/{configId} -Sets new values for a configuration group. Also lets you change the name and -description of the configuration group. +Deletes a configuration group. Normal response codes: 202 -Error response codes: badRequest(400), unauthorized(401), forbidden(403), -itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422), -instanceFault(500), notImplemented(501), serviceUnavailable(503) Request @@ -230,15 +202,5 @@ Request .. rest_parameters:: parameters.yaml - - values: values - - description: description - - name: name - - configId: configId - project_id: project_id - - -Request Example ---------------- - -.. literalinclude:: samples/db-update-config-group-request.json - :language: javascript + - configId: configId
\ No newline at end of file |