Commit Graph

24 Commits

Author SHA1 Message Date
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:
63e6dbb1eb

Change-Id: Ifa71b6375a63a9ddf182448a78192d6c76ed7fba
Partial-bug: #1618495
2016-09-22 12:14:10 -04: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
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
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
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