Merge "[placement] Split api-ref topics per file"

This commit is contained in:
Jenkins 2017-03-27 09:32:51 +00:00 committed by Gerrit Code Review
commit d454afe4cd
3 changed files with 82 additions and 81 deletions

View File

@ -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

View File

@ -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

View File

@ -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