ac4cc65cb5
Contains .inc files which have all the contents of the .rst files but are grouped together for easier editing. Contains parameters.yaml, which has all parameters in one file. Contains request and response samples (JSON and XML) that are pointed to from the .inc files. Change-Id: I42d5451300f95774a3ec4df66bc95cb36795844d
146 lines
2.4 KiB
ReStructuredText
146 lines
2.4 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=======================================================
|
|
Image schemas (schemas, image, images, member, members)
|
|
=======================================================
|
|
|
|
Gets a JSON-schema document that represents an images or image
|
|
entity.
|
|
|
|
|
|
Show images schema
|
|
==================
|
|
|
|
.. rest_method:: GET /v2/schemas/images
|
|
|
|
(Since Images v2.0) Shows a JSON schema document that represents an images entity.
|
|
|
|
An images entity is a container of image entities.
|
|
|
|
The following schema is solely an example. Consider only the
|
|
response to the API call as authoritative.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/schemas-images-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Show image member schema
|
|
========================
|
|
|
|
.. rest_method:: GET /v2/schemas/member
|
|
|
|
(Since Images v2.1) Shows a JSON schema document that represents an image member entity.
|
|
|
|
The following schema is solely an example. Consider only the
|
|
response to the API call as authoritative.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/schema-image-member-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Show image members schema
|
|
=========================
|
|
|
|
.. rest_method:: GET /v2/schemas/members
|
|
|
|
(Since Images v2.1) Shows a JSON schema document that represents an image members entity.
|
|
|
|
An image members entity is a container of image member entities.
|
|
|
|
The following schema is solely an example. Consider only the
|
|
response to the API call as authoritative.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/schemas-image-members-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Show image schema
|
|
=================
|
|
|
|
.. rest_method:: GET /v2/schemas/image
|
|
|
|
(Since Images v2.0) Shows a JSON schema document that represents an image entity.
|
|
|
|
The following schema is solely an example. Consider only the
|
|
response to the API call as authoritative.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/schema-image-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
|