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
This patch marks the Images v1 API as DEPRECATED in the api-ref.
The v1 API was deprecated in Newton by the following commit:
63e6dbb1eb
Change-Id: Ifa71b6375a63a9ddf182448a78192d6c76ed7fba
Partial-bug: #1618495
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
OpenStack house style is no Latin, which includes "etc.".
This fixes the usage in the metadefs documentation.
Change-Id: Ic88bd2a9286b2647a927f2fb8ecdec480053a91c
Closes-Bug: 1610311
This patch corrects the versions response to be consistent with the
current (Mitaka) Images API versions.
Change-Id: I57f1caad34af17f9667d16e1574646f378e2c11a
Closes-bug: #1609795
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
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
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
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
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