24 Commits

Author SHA1 Message Date
Dharini Chandrasekar
9033cbe149 Update api-ref for Range request support
This patch updates the api-ref to indicate that ``Range`` shall be
accepted in the request header and upon a successful serving of the
partial image data, the response headers would include ``Content-Range``.

Change-Id: I99ecc345793c7f3045400e57711f01cae2181f6f
Depends-On: b7ebc792c32995751744be3f36cbc9a0c1eead2a
2017-04-06 03:43:24 +00:00
Andreas Jaeger
4e9299cee9 Fix api-ref with Sphinx 1.5
Sphinx 1.5 fails with a warning that a code-block cannot be highlighted.
It's indeed not json, use 'none' to fix the build.

Change-Id: I02bfe805c419fcc49ac43b66f4f7b1a0d1d54755
2017-03-04 15:56:45 +00:00
Brian Rosmaita
76aeab31f0 Update api-ref for image visibility changes
Add text to the api-ref to document the changes introduced by
"Implement and Enable Community Images", whose change identifier
is I94bc7708b291ce37319539e27b3e88c9a17e1a9f.

Change-Id: Ib18c6ac226267ec15b399b71dbfefed33a1dbffd
2017-01-30 12:29:59 -05:00
Dharini Chandrasekar
36a1b7c82e Update api-ref for partial download requests.
Change [1] fixed partial downloads in glance and changed the
status codes to be more appropriate. Updating api-ref to reflect
what the v2 code will now do.

[1] I3cd47b998be79604511b3cd4879209820cf776b7

Change-Id: I70e3f60c3ce3d0eeb7b457496dbbe623b2ff473e
2017-01-26 21:03:36 +00:00
Brian Rosmaita
3a96347fe2 Eliminate reference to metadefs 'namespace_id'
In most places, the api-ref refers to the 'namespace_name' in URLs,
but in two places in the metadefs-namespaces-properties file, the
term 'namespace_id' is used.  This patch fixes those two occurrences
in the interest of consistency, but also because it is causing a
warning that's interpreted as an error in the latest version of
os_api_ref [0].

[0] http://lists.openstack.org/pipermail/openstack-dev/2017-January/110606.html

Change-Id: I86435a216c9c8d8bd391fb662049662d7d303ae5
2017-01-23 20:46:05 +00:00
Jenkins
33f943b2f7 Merge "Add ploop to supported disk_formats" 2017-01-09 19:21:49 +00:00
Maxim Nestratov
ab7152ea28 Add ploop to supported disk_formats
Lite-Spec-Id:Ib45de5ff2fe7fc4e1c2d6f8cb6772e017ef891c2
Change-Id: Ice74c4bf9ed2efae519930f33b2fa2b3c162e8c4
2016-12-22 21:14:14 +03:00
Kevin_Zheng
0cf83ca24d Fix some typos in api-ref
Trival fix some typos in api-ref

Change-Id: Ia684e0f4dbf7075a05b78f0384754ad04d55bcad
2016-12-21 22:12:27 +08:00
Jenkins
04b3339fac Merge "Update api-ref to add newly supported 'vhdx' disk format option." 2016-11-22 20:51:04 +00:00
Jenkins
cec64292df Merge "Update api-ref with 409 response to image update." 2016-11-11 23:08:38 +00:00
Alexander Bashmakov
e170225f3f Update api-ref with 409 response to image update.
With the change [1] that went into Newton to disallow image location
updates except for 'queued' and 'active' states, this patch adds
appropriate api-ref documentation. Related change [2] bumps the minor
API version to 2.4.

[1] https://review.openstack.org/324012
[2] https://review.openstack.org/350809

Change-Id: I593ad2d3c7402c4fb87a475c8d44060baed5ff69
Closes-Bug: 1621236
2016-11-08 22:03:02 +00:00
Jenkins
d1939eb86f Merge "change the example URLs in api-ref for Glance" 2016-11-04 10:22:18 +00:00
Alexander Bashmakov
61a62c6050 Remove redundant word.
Trivial fix.

Change-Id: Ib64bad4ab2bf5ca2e5893eea1eda5acd721b3f74
2016-10-06 14:05:32 -07:00
Luong Anh Tuan
4f64751285 Fix typo: remove redundant 'the'
Change-Id: I65c54b4718825a42d8f88017e832d50378b187ee
2016-10-03 11:29:29 +07:00
Jin Li
af70dc6548 change the example URLs in api-ref for Glance
Change all example urls in api-ref/source to
http://glance.openstack.example.org
and document about this standard URL format

Change-Id: I429c1e256fa3bfdc15adbee129b04ef9c028e82d
Closes-Bug: #1611490
2016-09-22 19:16:13 -07:00
Alexander Bashmakov
3a1f861620 Update api-ref to add newly supported 'vhdx' disk format option.
Images API reference is updated to reflect that the 'vhdx'
disk_format is now one of the default formats supported by Glance.
This change also introduces substitution of image parameter
description from a single source file in order to avoid copy and
paste errors. Only the disk_format parameter is affected in this,
other parameters may be consolidated in subsequent patch(es).

Co-Authored-By: Anne Gentle <agentle@cisco.com>
Co-Authored-By: Andreas Jaeger <jaegerandi@gmail.com>
Co-Authored-By: Alexander Bashmakov <alexander.bashmakov@intel.com>

Change-Id: Ib50b8e184364b6ee7d8af4ed3d4959ba76568049
Spec-Lite: https://review.openstack.org/#/c/347626
Closes-Bug: #1608643
2016-09-19 12:41:05 -07:00
Travis Tripp
5829139ccf Fix use of etc. in metadefs docs.
OpenStack house style is no Latin, which includes "etc.".
This fixes the usage in the metadefs documentation.

Change-Id: Ic88bd2a9286b2647a927f2fb8ecdec480053a91c
Closes-Bug: 1610311
2016-08-05 16:42:20 -06:00
Jenkins
a4c82db8bb Merge "api-ref: Replace image-update response example" 2016-07-26 17:07:39 +00:00
bria4010
8161bde357 api-ref: Replace image-update response example
The image-update sample response in the current api-ref is a bit
weird (too many null values).  This patch replaces it with a more
typical response.

Change-Id: I1f837d8fa0e42b9f9f1c421555339924d72cb9fe
Closes-bug: #1606253
2016-07-26 12:38:12 +00:00
bria4010
57458276a9 api-ref: Refresh images schemas
The schemas in the current api-ref are outdated.  This patch adds
the schemas contained in the 13.0.0.0b2 release.

Change-Id: I45615e049339b3df8d1c6cda74d7408a177aba4e
Closes-bug: #1606250
2016-07-26 12:36:21 +00:00
Jenkins
fcfb2b5383 Merge "WADL to RST migration (part 2 - images)" 2016-07-23 20:50:17 +00:00
bria4010
c028c2d23e WADL to RST migration (part 2 - images)
This brings the Images API Reference to the glance tree as part of the
effort described here:
https://wiki.openstack.org/wiki/Documentation/Migrate#API_Reference_Plan

This patch contains the content of the Images v2 API reference converted
to RST. The content has been corrected where I noticed divergences with
reality (which actually happened a lot, so this patch contains a lot of
revisions).

Tasks and metadefs are submitted as separate patches.

Change-Id: If69c469da7f28f090a2286ec0b115d9bcaac4fbf
Closes-Bug: #1550457
Closes-Bug: #1589264
Closes-Bug: #1592715
2016-07-18 17:52:40 -04:00
bria4010
368f7dbcc5 WADL to RST migration (part 2 - metadefs)
This brings the Images API Reference to the glance tree as part of
the effort described here:
https://wiki.openstack.org/wiki/Documentation/Migrate#API_Reference_Plan

This patch includes the Metadefs API reference, with the content
revised and corrected.

Change-Id: I8c10893e92edb7c608b58d33539ab57ab4f57d3e
Closes-bug: #1599314
2016-07-11 16:22:11 -04:00
bria4010
011235fb2f WADL to RST migration (part 2 - tasks)
This brings the Images API Reference to the glance tree as part of
the effort described here:
https://wiki.openstack.org/wiki/Documentation/Migrate#API_Reference_Plan

This patch contains the tasks part of the Images v2 API reference.

Change-Id: I02ea9052c00c069a03c58b17893a5e93828e172d
2016-06-29 12:29:01 -04:00