From cd95b4d63f63e7862cf4c45a81e6ae3ee6d25377 Mon Sep 17 00:00:00 2001 From: Andrey Volkov Date: Fri, 24 Mar 2017 18:42:56 +0300 Subject: [PATCH] [placement] Split api-ref topics per file For more convinient text management each ROUTE_DECLARATIONS has its own inc file in api-ref. Change-Id: Ia2fd62ae7f401cad34ee7c2b355c9a5ab1c93f6b --- placement-api-ref/source/index.rst | 83 +------------------ .../source/resource_providers.inc | 48 +++++++++++ placement-api-ref/source/root.inc | 32 +++++++ 3 files changed, 82 insertions(+), 81 deletions(-) create mode 100644 placement-api-ref/source/resource_providers.inc create mode 100644 placement-api-ref/source/root.inc diff --git a/placement-api-ref/source/index.rst b/placement-api-ref/source/index.rst index 6e0dd3ac01d7..38744938fba1 100644 --- a/placement-api-ref/source/index.rst +++ b/placement-api-ref/source/index.rst @@ -12,84 +12,5 @@ Openstack Placement API concepts, please refer to the .. rest_expand_all:: -======== -Versions -======== - -List Versions -============= - -.. rest_method:: GET / - -Fetch information about all known major versions of the placement API, -including information about the minimum and maximum microversions. - -.. note:: At this time there is only one major version of the placement API: - version 1.0. - -Normal Response Codes: 200 - -Response --------- - -.. rest_parameters:: parameters.yaml - - - versions: versions - - id: version_id - - min_version: version_min - - max_version: version_max - -Response Example ----------------- - -.. literalinclude:: get-root.json - :language: javascript - -================== -Resource Providers -================== - -Resource providers are entities which provide consumable inventory of one or -more classes of resource (such as disk or memory). They can be listed (with -filters), created, updated and deleted. - -List Resource Providers -======================= - -.. rest_method:: GET /resource_providers - -List an optionally filtered collection of resource providers. - -Normal Response Codes: 200 - -Request -------- - -Several query parameters are available to filter the returned list of -resource providers. If multiple different parameters are provided, the results -of all filters are merged with a boolean `AND`. - -.. rest_parameters:: parameters.yaml - - - resources: resources_query - - member_of: member_of - - uuid: resource_provider_uuid_query - - name: resource_provider_name_query - -Response --------- - -.. rest_parameters:: parameters.yaml - - - resource_providers: resource_providers - - generation: resource_provider_generation - - uuid: resource_provider_uuid - - links: resource_provider_links - - name: resource_provider_name - - -Response Example ----------------- - -.. literalinclude:: get-resource_providers.json - :language: javascript +.. include:: root.inc +.. include:: resource_providers.inc diff --git a/placement-api-ref/source/resource_providers.inc b/placement-api-ref/source/resource_providers.inc new file mode 100644 index 000000000000..916006e5b87f --- /dev/null +++ b/placement-api-ref/source/resource_providers.inc @@ -0,0 +1,48 @@ +================== +Resource Providers +================== + +Resource providers are entities which provide consumable inventory of one or +more classes of resource (such as disk or memory). They can be listed (with +filters), created, updated and deleted. + +List Resource Providers +======================= + +.. rest_method:: GET /resource_providers + +List an optionally filtered collection of resource providers. + +Normal Response Codes: 200 + +Request +------- + +Several query parameters are available to filter the returned list of +resource providers. If multiple different parameters are provided, the results +of all filters are merged with a boolean `AND`. + +.. rest_parameters:: parameters.yaml + + - resources: resources_query + - member_of: member_of + - uuid: resource_provider_uuid_query + - name: resource_provider_name_query + +Response +-------- + +.. rest_parameters:: parameters.yaml + + - resource_providers: resource_providers + - generation: resource_provider_generation + - uuid: resource_provider_uuid + - links: resource_provider_links + - name: resource_provider_name + + +Response Example +---------------- + +.. literalinclude:: get-resource_providers.json + :language: javascript diff --git a/placement-api-ref/source/root.inc b/placement-api-ref/source/root.inc new file mode 100644 index 000000000000..edf9e6347944 --- /dev/null +++ b/placement-api-ref/source/root.inc @@ -0,0 +1,32 @@ +======== +Versions +======== + +List Versions +============= + +.. rest_method:: GET / + +Fetch information about all known major versions of the placement API, +including information about the minimum and maximum microversions. + +.. note:: At this time there is only one major version of the placement API: + version 1.0. + +Normal Response Codes: 200 + +Response +-------- + +.. rest_parameters:: parameters.yaml + + - versions: versions + - id: version_id + - min_version: version_min + - max_version: version_max + +Response Example +---------------- + +.. literalinclude:: get-root.json + :language: javascript