Commit Graph

12 Commits

Author SHA1 Message Date
Cyril Roelandt cddcb8e5ac api-ref: Fix RST formatting
The list is currently not displayed properly.

Change-Id: Ie7edcfb18d91ee6e68bdba019b153819235222df
2023-09-14 01:13:21 +02:00
chenwei 0934cf0305 Update api-ref: versions response for master branch
Closes bug: #1962480

Change-Id: Iba5a720fcd1408dc81f7da8a6b814fe952a5ddf9
2022-06-13 18:28:16 +08:00
Erno Kuvaja 515412b59f Set API version 2.9 CURRENT
This change removes experimental status from Api versions
>2.7 setting 2.8 (multi-store support) to SUPPORTED and
2.9 (caching) to CURRENT.

NOTE: 2.8 will show up in list only if the glance-api service
is configured with multi-store. The API versions list can be
used to determine if the multi-store functionality is availabe
in the endpoint.

Change-Id: I37350fc46191074d42edc73c2451eae73261957d
2019-10-01 17:45:26 +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
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 c53d7f1943 api-ref: correct typo
The sixth OpenStack release was named 'Folsom'.

Change-Id: I0674d16b04df903ad9ea306a38e7dead7804338e
2018-03-07 03:14:33 -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
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
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 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
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
  63e6dbb1eb
- 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
bria4010 ee1b6dce3c WADL to RST migration (part 1)
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 introduces (a) the tox environment to generate the api-ref,
and (b) the content of the Images v1 API reference converted to RST.
The content has been corrected where I noticed divergences with reality.

Note to reviewers: The conversion project is ongoing, that is, the doc
team is continuing to develop tools (for example, to display the response
codes in a table) and converging on a style for these docs.  So this isn't
a final product, there will be more patches later.  While this patch is
not perfect, it is pareto-optimal with respect to content (it's at least
as good as the current guide, and better in at least one place).  Thus
my advice, should you choose to take it, is that we should merge this
patch to get these docs in-tree, and make improvements as additional
patches that can focus on particular API calls rather than try to get
everything perfect on this patch.

Change-Id: I51dfaf1832108466f115ab183838c5f28e138312
2016-06-21 13:29:24 -04:00