openstack/glance
Code Issues Proposed changes

api-ref: make the discovery section more general

Browse Source 
Move all the v2/info calls to the same section of the api-ref.

Change-Id: I05cd7d89585a71cc8f5448cc3c08905da1638638
This commit is contained in:
Brian Rosmaita 2018-08-07 11:31:37 -04:00
parent cacede14b4
commit 6187728bec
2 changed files with 64 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
api-ref/source/v2/discovery.inc
View File

@ -1,7 +1,69 @@
.. -*- rst -*-
Stores
******
Image Service Info (Discovery)
******************************
General information
~~~~~~~~~~~~~~~~~~~
These calls allow you to discover useful information about what
services you may consume from a particular deployment of the
OpenStack Image Service.
.. _import-discovery-call:
Import methods and values discovery
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/info/import
Returns information concerning the constraints around image import in
the cloud in which the call is made, for example, supported container
formats, supported disk formats, maximum image size, etc. This call
contains a ``import-methods`` field consisting of an array of string
identifiers indicating what import methods are supported in the cloud
in which the call is made.
*(Since Image API v2.6)*
.. note::
In the Image API v2.6-2.8, this discovery call contains
**only** the ``import-methods`` field.
Normal response codes: 200
Error response codes: 400, 401, 403
Request
-------
There are no request parameters.
This call does not allow a request body.
Response Parameters
-------------------
.. rest_parameters:: images-parameters.yaml
- import-methods: import-methods
Response Example
----------------
.. literalinclude:: samples/image-info-import-response.json
:language: json
.. _store-discovery-call:
List stores
~~~~~~~~~~~
.. rest_method:: GET /v2/info/stores
A multiple store backend support is introduced in the Rocky release
as a part of the EXPERIMENTAL Image API v2.8.
@ -16,17 +78,6 @@ In version 2.7 of the API, this call will return a 404 (Not Found).
Use the :ref:`API versions call <versions-call>` to determine
what API verisons are available in your cloud.
List of available store backends for glance.
.. _store-discovery-call:
List stores
~~~~~~~~~~~
.. rest_method:: GET /v2/info/stores
Lists stores.
Normal response codes: 200
Error response codes: 404

45
api-ref/source/v2/images-import.inc
View File

@ -273,48 +273,3 @@ Request Example - web-download import method
:language: json
.. _import-discovery-call:
Import methods and values discovery
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/info/import
Returns information concerning the constraints around image import in
the cloud in which the call is made, for example, supported container
formats, supported disk formats, maximum image size, etc. This call
contains a ``import-methods`` field consisting of an array of string
identifiers indicating what import methods are supported in the cloud
in which the call is made.
*(Since Image API v2.6)*
.. note::
In the Image API v2.6, this discovery call contains
**only** the ``import-methods`` field.
Normal response codes: 200
Error response codes: 400, 401, 403
Request
-------
There are no request parameters.
This call does not allow a request body.
Response Parameters
-------------------
.. rest_parameters:: images-parameters.yaml
- import-methods: import-methods
Response Example
----------------
.. literalinclude:: samples/image-info-import-response.json
:language: json