1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
|
.. -*- rst -*-
.. note: You can get a 400 on a GET if you pass a request body
(see router.py)
Image Schemas
*************
Gets a JSON-schema document that represents the various entities talked
about by the Images v2 API.
.. _images-schema:
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: 400, 401
Request
-------
This operation has no request parameters and does not accept a request body.
Response Example
----------------
.. literalinclude:: samples/schemas-images-list-response.json
:language: json
.. _image-schema:
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: 400, 401
Request
-------
This operation has no request parameters and does not accept a request body.
Response Example
----------------
.. literalinclude:: samples/schemas-image-show-response.json
:language: json
.. _image-members-schema:
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: 400, 401
Request
-------
This operation has no request parameters and does not accept a request body.
Response Example
----------------
.. literalinclude:: samples/schemas-image-members-list-response.json
:language: json
.. _image-member-schema:
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: 400, 401
Request
-------
This operation has no request parameters and does not accept a request body.
Response Example
----------------
.. literalinclude:: samples/schemas-image-member-show-response.json
:language: json
|