diff --git a/placement-api-ref/source/resource_provider.inc b/placement-api-ref/source/resource_provider.inc index 884dc6b817..5b718d2e76 100644 --- a/placement-api-ref/source/resource_provider.inc +++ b/placement-api-ref/source/resource_provider.inc @@ -41,3 +41,47 @@ Response Example .. literalinclude:: get-resource_provider.json :language: javascript + +Update resource provider +======================== + +.. rest_method:: PUT /resource_providers/{uuid} + +Update the name of the resource provider identified by `{uuid}`. + +Normal Response Codes: 200 + +Error response codes: badRequest(400), itemNotFound(404), conflict(409) + +A `409 Conflict` response code will be returned if another resource +provider exists with the provided name. + +Request +------- + +.. rest_parameters:: parameters.yaml + + - uuid: resource_provider_uuid_path + - name: resource_provider_name + +Request example +--------------- + +.. literalinclude:: update-resource_provider-request.json + :language: javascript + +Response +-------- + +.. rest_parameters:: parameters.yaml + + - generation: resource_provider_generation + - uuid: resource_provider_uuid + - links: resource_provider_links + - name: resource_provider_name + +Response Example +---------------- + +.. literalinclude:: update-resource_provider.json + :language: javascript diff --git a/placement-api-ref/source/update-resource_provider-request.json b/placement-api-ref/source/update-resource_provider-request.json new file mode 100644 index 0000000000..72673db21b --- /dev/null +++ b/placement-api-ref/source/update-resource_provider-request.json @@ -0,0 +1 @@ + {"name": "Shared storage"} diff --git a/placement-api-ref/source/update-resource_provider.json b/placement-api-ref/source/update-resource_provider.json new file mode 100644 index 0000000000..684e3eadf4 --- /dev/null +++ b/placement-api-ref/source/update-resource_provider.json @@ -0,0 +1,27 @@ +{ + "generation": 0, + "links": [ + { + "href": "/placement/resource_providers/33f26ae0-dbf2-485b-a24a-244d8280e29f", + "rel": "self" + }, + { + "href": "/placement/resource_providers/33f26ae0-dbf2-485b-a24a-244d8280e29f/aggregates", + "rel": "aggregates" + }, + { + "href": "/placement/resource_providers/33f26ae0-dbf2-485b-a24a-244d8280e29f/inventories", + "rel": "inventories" + }, + { + "href": "/placement/resource_providers/33f26ae0-dbf2-485b-a24a-244d8280e29f/usages", + "rel": "usages" + }, + { + "href": "/placement/resource_providers/33f26ae0-dbf2-485b-a24a-244d8280e29f/traits", + "rel": "traits" + } + ], + "name": "Shared storage", + "uuid": "33f26ae0-dbf2-485b-a24a-244d8280e29f" +}