78 Commits

Author SHA1 Message Date
melissaml
a08a88b0a7 fix a typo in docstring
Change-Id: I47544dee1e386aac27dc23321de3ed927db58a30
2018-10-05 17:29:32 +08:00
Brian Rosmaita
d8221bf16f api-ref: "hidden" images update
Update the api-ref for the "Operator maintained images lifecycle"
spec implemented in Rocky.

Change-Id: I8fcfb84579b655fd44759164508ce4532e4dd205
2018-08-16 19:05:52 +00:00
Brian Rosmaita
b6d5100de7 api-ref: update version history
Update version history to include the Rocky changes.

Change-Id: Ie673a52c72a5975ac059002c351782a1c6d8df90
2018-08-08 16:15:41 -04:00
Zuul
671cfed406 Merge "Add API version 2.8" 2018-08-08 20:03:56 +00:00
Erno Kuvaja
208935af96 Add API version 2.8
This change bumps the API to EXPERIMENTAL 2.8 when multi back-end
is enabled.

Change-Id: Ie0e1ed84db1b227eea1774138b2a83172ff85bec
2018-08-07 16:39:06 +01:00
Brian Rosmaita
6187728bec api-ref: make the discovery section more general
Move all the v2/info calls to the same section of the api-ref.

Change-Id: I05cd7d89585a71cc8f5448cc3c08905da1638638
2018-08-07 11:31:37 -04:00
Zuul
cbdd1ab222 Merge "Doc:Multiple stores support" 2018-08-06 14:07:09 +00:00
Abhishek Kekane
d6ac7460ca Doc:Multiple stores support
Added documentation and modified api-ref documents to
reflect multiple stores support changes.

Related to blueprint multi-store
Change-Id: I932297df8149968d31a5367a9ca71a5629045445
2018-08-03 11:17:59 +00:00
Erno Kuvaja
8e16e41f4d Bump Imges API version to 2.7
This API version bump contains the extensions for hidden images
and multihash feature support.

Change-Id: I3d394b344492a1f06a4999a3f61cecf5ace30f23
2018-08-01 19:42:11 +01:00
Brian Rosmaita
0b24dbd620 Multihash implementation for Glance
Partially implements blueprint multihash.

Requires glance_store 0.26.1

Co-authored-by: Scott McClymont <scott.mcclymont@verizonwireless.com>
Co-authored-by: Brian Rosmaita <rosmaita.fossdev@gmail.com>

Change-Id: Ib28ea1f6c431db6434dbab2a234018e82d5a6d1a
2018-07-31 21:28:38 -04:00
inspurericzhang
612e5cf12b Replace Chinese punctuation with English punctuation
Curly quotes(Chinese punctuation) usually input from Chinese input method.
When read from english context, it makes some confusion.

Change-Id: I9b8830179fb98f3a6bef479bbaa12df70311269a
2018-06-07 17:00:12 +08:00
Zuul
ca062fb39d Merge "[api-ref] "Show images" should be changed to "List images"" 2018-05-04 16:44:49 +00:00
Ha Van Tu
71a3ac6235 [api-ref] "Show images" should be changed to "List images"
"List images" had been taken by the v1 API, but now that its
api reference has been removed, that's no longer a problem.
Can also remove the superfluous "an"s that were used in the
v2 titles to prevent sphinx conflicts.

Co-authored-by: Ha Van Tu <tuhv@vn.fujitsu.com>
Co-authored-by: Brian Rosmaita <rosmaita.fossdev@gmail.com>

Change-Id: I2c1ce3f5c1279a93a08855c554e156c4fc115f61
Closes-Bug: #1615899
2018-05-01 14:52:53 +00:00
junboli
927aaf870d Follow the OpenStack Sphinx theme configuration
Follow docs[1] and update the sphinx theme configuration,
Also updated bug_tag values for api-ref and documentation.

[1] https://docs.openstack.org/openstackdocstheme/latest/

Co-authored-by: wanghui <wang_hui@inspur.com>

Closes-bug: #1768365
Change-Id: I76308497122f4522fe307b3c29b696780e073027
2018-05-01 15:03:56 +08:00
Brian Rosmaita
012cce529f Add info about building the v1 api-ref
Because the Image API is removed in Rocky, its API Reference has
been deleted.  Add information about why it's gone and how to build
it to the current API Reference.

Closes-bug: #1762387

Change-Id: Ic215e7367b49df1ac837a4a1fa56effa7d9f7a61
2018-04-12 18:09:45 -04:00
Brian Rosmaita
c48acba840 Update image schema with Image API 2.6 statuses
Updates the schemas/image(s) responses and the api-ref.  (The dev
docs are correct.)  Adds a test so this won't happen again.

Closes-bug: #1762031
Change-Id: Ifb0a07fcdb1c8d91f1ad700329a208200222a2a6
2018-04-07 14:25:26 -04:00
Zuul
a7f2b98fc0 Merge "api-ref: fix list-resource-type-assocs example" 2018-03-09 11:07:33 +00:00
Brian Rosmaita
c53d7f1943 api-ref: correct typo
The sixth OpenStack release was named 'Folsom'.

Change-Id: I0674d16b04df903ad9ea306a38e7dead7804338e
2018-03-07 03:14:33 -05:00
Brian Rosmaita
0b49605630 api-ref: fix list-resource-type-assocs example
In the metadefs section of the api-ref, the current example response
for the list-resource-type-associations call is incorrect.  Add a
correct example response.

Change-Id: I10e92ce96b40563b3c4d02ac5c542960564837ec
Closes-bug: #1751208
2018-03-06 12:45:58 -05:00
Erno Kuvaja
c241cc075c Remove v1 from API ref
as preparation of removing Images API v1, clean it out from the API
Ref documentaion.

Change-Id: I65ef76fec0029949f8de867d711e745b7aa7f81d
2018-03-06 12:44:40 +00:00
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