58 Commits

Author SHA1 Message Date
Zuul
0f76384785 Merge "Correct length limit for custom property value" 2018-02-21 13:18:29 +00:00
Brian Rosmaita
601f82ac24 Correct length limit for custom property value
The api-ref states that the both the key and value of a custom
property are limited to 255 chars.  This limit applies only to
the key.

Change-Id: I3bacca8b25f2a8339f6d8758e45c690da9968555
Closes-bug: #1748900
2018-02-19 22:11:44 -05:00
Brian Rosmaita
4cf65d5795 api-ref: update interoperable image import info
Generalizes the discussion to include the new web-download import
method and includes a new sample import request.

Change-Id: Icb6cd920f31c6e8e4eecf17880dd3244e5d1a61b
Closes-bug: #1748229
2018-02-17 16:29:51 -05:00
Zuul
f09651df2b Merge "Update api-ref for v.2.6" 2018-02-08 19:59:22 +00:00
Zuul
b9e95a8db3 Merge "Update the valid disk bus list for qemu and kvm hypervisors" 2018-02-08 19:47:08 +00:00
Brian Rosmaita
32f8724f6e Update api-ref for v.2.6
2.6 was experimental in Pike but is current in Queens.

Change-Id: I4f8c4ff72808aac1fc52c65673d28530aa9939f2
Closes-bug: #1748218
2018-02-08 12:32:48 -05:00
chenxing
f8a5a40224 Update the valid disk bus list for qemu and kvm hypervisors
The Nova project has added 'sata' as a valid disk bus for qemu and
kvm hypervisors, see https://review.openstack.org/#/c/459794/6

DocImpact: add to metadefs release note

Related-Bug: #1686136
Change-Id: If8e23756616e46391827ac3d85d287940862613f
2017-12-06 03:16:27 +00:00
Brian Rosmaita
8026e7f588 Update api-ref about 403 for image location changes
Add deleting the only location or attempting to set the locations
to an empty list as another reason why a user might get a 403
response to a PATCH call.

Change-Id: I2edb072ded11d1b710af0309f0372d1b16042a54
Closes-bug: #1542724
2017-10-19 18:45:42 -04:00
Dinesh Bhor
2562da28c6 Fix 500 if user passes name with more than 80 characters
Following apis are returning 500 error if user passes name with more
than 80 characters:
* md-tag-create
* md-tag-update
* md-object-create
* md-object-update
* md-property-create
* md-property-update

This happens because there is a discrepancy in db column length and
glance-api length check in schema validation. In database the 'name'
field for these API's is defined as of maximum 80 characters and in
schema it is defined as of maximum 255 characters. So if user passes
name with more than 80 characters and less than 255 characters
database fails to store that value and shouts with following error
which leads to 500 error to API user:

(pymysql.err.DataError) (1406, u"Data too long for column 'name' at
row 1")

Fixed this issue by changing the maximum allowed length for 'name'
from 255 to 80 in schema validation.

APIImpact
DocImpact
Closes-Bug: #1719252
Change-Id: I4ae67457c3e4f5a6bfc3c1db2d305a9b7587395f
2017-10-05 10:24:22 +05:30
Sean McGinnis
6c7537163e Clean up api-ref index page
The v1 API is deprecated, so moving that to be the last item in
the ToC. Also adding a search link to the top to make it easier
to find things within the API documentation.

Change-Id: Id558679ef9e7012ad4fbe8ea25e9bc544851d4c2
2017-09-27 15:23:32 -05:00
Brian Rosmaita
7101d9ceea api-ref: add 'protected' query filter
Adds documentation for the 'protected' query filter introduced
in Pike.

Change-Id: I7c63ae1715e1bd35587f0f0954596ae1263d428b
Closes-bug: #1713177
2017-08-25 21:13:21 -04:00
Jenkins
64bbb06990 Merge "api-ref: add interoperable image import docs" 2017-08-21 18:49:30 +00:00
Brian Rosmaita
8005ee994c api-ref: add interoperable image import docs
Adds documentation of the interoperable image import process
introduced in Pike in the EXPERIMENTAL Image API v2.6.

Change-Id: Ifbedc2e5e566db084bc7028ed4239485f0d68b18
2017-08-21 10:42:36 -04:00
Jenkins
68a45793be Merge "api-ref: update container_format, disk_format" 2017-08-18 16:50:06 +00:00
Rui Yuan Dou
8886dcd114 Update invalid path and link for Image Properties
Change-Id: I67e84be3ceb4b6810f8b7c39d953b36c04641afb
2017-08-16 09:07:51 +08:00
Brian Rosmaita
af8c371a8c Bump Images API to v2.6
The MVP of image import functionality will be introduced as an
EXPERIMENTAL 2.6 version of the Images API.  The current version
will remain at 2.5.

This patch:
* Updates the version response
* Updates version negotiation code
* Updates unit and functional tests
* Updates the api-ref
* Adds a releasenote

Change-Id: Ied573897157e05f7b0438baeb1553326fb06613a
2017-08-06 09:19:13 -04:00
Brian Rosmaita
08cd24d28c api-ref: update container_format, disk_format
This patch updates the disk_format description to include "ploop"
(added in Ocata).  It also rewrites the container_format description
to indicate that the actual values depend on how the API being queried
is configured.

This patch does not update the api-ref for the deprecated v1 API.

Change-Id: I3385b3f628b74b109c05108e331085c54b0126a1
2017-08-03 18:47:13 -04:00
Christian Berendt
a625e4e14b Fix broken link to the "Image service property keys" doc
Change-Id: I045d72ae2822717f7125c5116d804fdb66e1a097
2017-06-19 12:04:33 +02:00
M V P Nitesh
f615dd2a69 Fix doc generation for Python3
Fix the Sphinx html_last_updated_fmt for Python3.
The html_last_updated_fmt option is interpeted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Change-Id: I2d79405579e55ae77c8f8e353a15c49474061e1e
2017-04-17 18:13:43 +05:30
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
xurong00037997
21ba912ed9 Use https instead of http for git.openstack.org
Change-Id: I2d39eca95d7cd3e31d8ad2ecee381fabfe8ad0f6
2017-02-14 04:20:22 +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
Jenkins
b7c8936aa3 Merge "Bump minor API version" 2017-01-28 00:20:40 +00: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
Brian Rosmaita
c8028768e6 Bump minor API version
Change-Id I94bc7708b291ce37319539e27b3e88c9a17e1a9f (Community
Images) entails a minor version bump in the v2 API.

Change-Id: I2b7cd5ec9b974ebc738feb89ef22c428fbe3be06
Depends-On: I94bc7708b291ce37319539e27b3e88c9a17e1a9f
2017-01-19 18:16:51 -05: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
Jenkins
60c1e1a635 Merge "Fix typo: remove redundant 'the'" 2016-10-06 15:37:10 +00:00
Jenkins
9bd264cd03 Merge "[api-ref] configure LogABug feature" 2016-10-04 02:28:10 +00:00
Luong Anh Tuan
4f64751285 Fix typo: remove redundant 'the'
Change-Id: I65c54b4718825a42d8f88017e832d50378b187ee
2016-10-03 11:29:29 +07:00
Jenkins
f58b859392 Merge "api-ref: add versions history" 2016-09-30 16:39:09 +00:00
Jenkins
84ad7c3df9 Merge "api-ref: deprecate images v1 api" 2016-09-30 13:39:10 +00:00
KATO Tomoyuki
ce6cb2d3d5 [api-ref] configure LogABug feature
To report a bug into the glance project, not default openstack-manuals.

Change-Id: Icb757e40e32f3a3e8b17a1eaf8494894114ae173
2016-09-27 23:36:54 +09: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
Brian Rosmaita
cd65bfd0c7 api-ref: deprecate images v1 api
This patch marks the Images v1 API as DEPRECATED in the api-ref.
The v1 API was deprecated in Newton by the following commit:
63e6dbb1eb006758fbcf7cae83e1d2eacf46b4ab

Change-Id: Ifa71b6375a63a9ddf182448a78192d6c76ed7fba
Partial-bug: #1618495
2016-09-22 12:14:10 -04: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
Brian Rosmaita
5ac85fdd75 api-ref: add versions history
The 'versions' response contains the status of the Images API versions,
but does not indicate the releases when the statuses went into effect.
This patch adds a Version History to the 'versions' api-ref page.  The
language used (for example, "Bexar changes") is consistent with what's
been adopted for other parts of the images api-ref (see the discussion
on https://review.openstack.org/#/c/356693/ )

This patch is current for Newton:
- v1 deprecation: already merged as commit
  63e6dbb1eb006758fbcf7cae83e1d2eacf46b4ab
- v2 minor version bump: the dependency stated below

Depends-On: I5d1c4380682efa4c15ff0f294f269c800fe6762a

Change-Id: Id920a3284a4be23032cc4a23e04726fab6d24361
Closes-bug: #1621161
Partial-bug: #1618495
2016-09-14 16:42:50 -04:00
Ha Van Tu
b6dd4f9aef [api-ref] Remove temporary block
The os-api-ref 1.0.0 is out. We can remove the support to older
version now.
Reference:
https://github.com/openstack/senlin/commit/
6d41feb58dd836d426c9b6f025846dbbf7295097
https://review.openstack.org/#/c/362170/

Change-Id: Icb11e2530980f4a4fa0db790fa1a430dda0f6a04
2016-09-07 12:05:56 +07:00
Graham Hayes
89e4edc717 Get ready for os-api-ref sphinx theme change
Change-Id: Id506b6a919a5cc24960a14e67c99c6b4798e3947
2016-08-19 16:43:59 +01:00
Jenkins
20a10d5fb7 Merge "api-ref: correct versions response example" 2016-08-10 22:28:08 +00: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
Brian Rosmaita
7da4675321 api-ref: correct versions response example
This patch corrects the versions response to be consistent with the
current (Mitaka) Images API versions.

Change-Id: I57f1caad34af17f9667d16e1574646f378e2c11a
Closes-bug: #1609795
2016-08-04 09:29:16 -04:00