158 Commits

Author SHA1 Message Date
Hervé Beraud
20ed3307d1 Add doc/requirements
We need to specify doc requirements in doc/requirements.txt
to avoid problems with the pip resolver [1] for the release team [2][3].
Removed specific doc requirements from test-requirements.txt.

The problem here is that this repos haven't doc/requirements.txt file
and by default in this case zuul will use the test-requirements.txt file
to
pull requirements [4].

This requirements file contains extra requirements like flake8 that
collided with those allowed in our job environment and so the new pip
resolver fails to install these requirements and the job exits in error.

This project meet the conditions leading to the bug.

/!\/!\/!\
Notice that I voluntarily added the doc directory even if no docs
are generated here because zuul will try to pull this requirements from
there first and the contained requirements are needed for reno but AFAIK
the releasenotes dir is ignored by zuul. c.f [4] for further details.
/!\/!\/!\

[1] http://lists.openstack.org/pipermail/release-job-failures/2021-January/001500.html
[2] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019611.html
[3] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019612.html
[4] https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-sphinx/tasks/main.yaml#L36

Change-Id: Ib224dfe036543c8ec7fe3074fe4280586d35de97
2021-01-07 13:45:33 +00:00
Clark Boylan
65dc79c937 Complete api-site split from openstack-manuals.
Moved the files relavent to the new api-site repo into their own
repository with the requested directory structure. Also, update
.gitreview file to ensure pushes go to the correct upstream repo.
2012-09-25 10:20:38 -07:00
annegentle
9119c16f74 Adds tested .json and .xml files for Compute API.
Ready for review - builds and removed foo bar to make
metadata more realistic.

Rebase against master.

Change-Id: I4d177faa8e3b60e0eb0de19ab128b29d68ec83a9
2012-09-21 20:25:03 -05:00
annegentle
1683dda14c Edit the os-diagnostics extension after realizing I had added
server_id twice.

Change-Id: If67fda82546b46ab49e80394b5d0aa52b996b751
2012-09-21 16:02:18 -05:00
razique
fcc06266e1 Fixes bug # 1035483 : server_diagnostics is undocumented
Fixes filename pointer to .json file.

Rebases against master.

Change-Id: Ic6eb6ec7374ac76fb03e2c79ae10f71243bcec0e
2012-09-21 15:58:30 -05:00
dcramer
9be241f36f Rip out old normalize wadl stuff and use latest version of the clouddocs plugin.
fix bug 1036237

Change-Id: I270e8cd9a14b322173dc08453466375c1b000abb
2012-09-20 11:35:40 -05:00
Jenkins
c7eaa8ee31 Merge "Update createserverext after sec group changes" 2012-09-19 13:41:09 +00:00
Jenkins
4b58037f98 Merge "Fix generate/import keypair example in API doc" 2012-09-17 18:44:46 +00:00
Tom Fifield
81fdbbed2c Update include reference to nova cli guide
fixes bug 1051537

This change updates the include reference to the nova cli guide so
that it now builds.

Change-Id: Ie4fa2a9b0edd0a6ccdf42bbc379c90c4522ca42b
2012-09-16 20:54:27 +10:00
Tom Fifield
1abe32e3a8 Fix generate/import keypair example in API doc
fixes bug 1020614

As per the bug report, the example in the keypairs extension
was incorrect. If the optional public key is specified (i.e. a
keypair import), a private key will not be returned.

The most common case is to specify only a name and get back a
full keypair, so this patch modifies the examples to portray this.

Change-Id: I9c8f2269ee5374ef609a91bbc938066363a033cd
2012-09-16 20:22:57 +10:00
Tom Fifield
0f35dcd7b5 Update createserverext after sec group changes
fixes bug 1039771

The patch this bug report mentions removes duplicated security group
functionality from createserverext, as it's in the servers endpoint.

This patch just removes the appropriate content

Change-Id: I191f2b7c37efd54430f6c2eda170708c3695aa38
2012-09-13 20:23:22 +10:00
daisy-ycguo
54ac8419f9 Add createBackup, os-migrateLive, and os-resetState api
fixes bug 1042652

createBackup, os-migrateLive, and os-resetState is a part of
Compute API extension: admin-actions.
Add their documents to api.openstack.org.

Change-Id: I6f7636a9987f7a37d3479a0446d80639bd4911b0
2012-09-12 17:06:17 +08:00
Tom Fifield
09fdab05d1 Adding Network creation to OS API docs
fixes bug 1039114

As in the bug report: There's a new network creation call in the
compute API. This patch adds it in with some example requests and
responses.

Patch2: rebases after change that introduce add network

Change-Id: Ib3a5499aa9c0b3f05cc8d2b1b959ccfc460f1057
2012-09-11 21:52:06 +10:00
Jenkins
48e886bd5b Merge "add GET (show) to OS API keypairs extension docs" 2012-09-10 09:43:26 +00:00
Tom Fifield
20e955a623 add GET (show) to OS API keypairs extension docs
fixes bug 1038346

As per the bug report, the API docs was missing the
GET (show) in the keypairs extension. This patch adds it
and provides a simple example

Change-Id: If7bee1a7ebf9aaa5ab6d20b67b6234248ba49e27
2012-09-07 15:52:57 +10:00
Tom Fifield
d3a1cd8422 Adds the network association api docs
fixes bug 1038341

As per the bug report, there was an extension to the network API
for associating networks. This updates the API docs to reflect
this change.

See also blueprint os-api-network-associate

Change-Id: I1d23e662cf691c88a3514c09ce7a6692183cf1c3
2012-09-05 22:27:22 +10:00
annegentle
9c1c5aef79 Adds os-hypervisors doc for api site.
fix bug 1031837
fix bug 1027287

Change-Id: I1116be389a963a70b15c5d5f3282fcd13bd2b18d
2012-08-31 16:17:05 -05:00
Diane Fleming
ffbf965ab3 Bug #1035491
Change-Id: I4bb182ecc57e8290e600525255738834569f33b4
2012-08-30 10:54:05 -05:00
Joe Gordon
10e7007293 Fix os-aggregates for api.openstack.org
Finish bug 1015821

* Get Details
* Update Aggregate
* Fix return codes

Patchset fixes nesting problem.

Change-Id: Ie59334c0c1f17de3184b7d016188bc86ebf2f799
2012-08-28 20:52:10 -05:00
Jenkins
db9c61d386 Merge "Add GET for flavors ext in compute API" 2012-08-27 15:06:59 +00:00
Tom Fifield
ef727025a9 Add GET for flavors ext in compute API
fixes bug 1015802

As per the bug report, the api site was missing a GET call
that lets you see a list of flavors available.

Change-Id: Ie05736201728bf1dcae78cd00c41edc5c5c854c6
2012-08-25 21:26:23 +10:00
daisy-ycguo
290d945d37 Add compute API extension: admin-actions
bug 1029560

Add compute API extension: admin-actions, including pause, unpause, suspend,
resume, migrate, resetNetwork, injectNetworkInfo, lock, unlock.

Change-Id: Ib6110ba5aaf98f0b2e66d0e10adbec9ab8c0430a
2012-08-22 17:18:23 +08:00
annegentle
4a3c79b6ef Adds starting point for an OpenStack CLI guide.
Patchset reorganizes based on feedback.

Patchset 4 and 5 addresses Diane's feedback, separating out version, help,
and so on.
Patchset 6 renames some files, adds some glance CLI commands in an
outline, unfinished.

Fixes
bug 1019718
bug 1031578
bug 988902

Change-Id: I530b29eca200830d866b09431e522efdc3454f2c
2012-08-20 11:39:30 -05:00
Diane Fleming
2469744031 Bug #1030039 - added os-volumes, os-snapshots, os-volume-types
Patchset:
moved the os-volume wadl to be a compute extension
renamed the volume API wadl to just volume-api.wadl
so that the os-volume extension wadl can be os-volume.wadl
fixes some problems with xml:lang referring to E instead of EN
Updates the pom to find the right new file name

Change-Id: I5f09526b329037a5862157751694d90abf9af13e
2012-08-15 16:44:10 -05:00
annegentle
062276cb46 Fix bug 1036213
Removes all tabpress.com scripts from all outputs.

Change-Id: I7ae2a4697de2ea94d1e9a02c253c34683329ddcb
2012-08-13 19:39:15 -05:00
annegentle
49173aea57 Ensures all Compute extensions refer to v2 instead of v1.1.
Change-Id: I2c9fda4a328bfb912a1e2a77d0f11a902c7ed231
2012-08-01 12:27:10 -05:00
Ying Chun Guo
c5ede86ab6 Add WADL of Object Storage API
Add WADL of Object Storage API, display them on api.openstack.org site.

bug 935245

Patchset 2 adds periods for punctuation on entries, fixes minor typos.

Patchset 3 adds the COPY object command.

Change-Id: I5ea38cd29db87f4e1bf0f21de958601d54c7a2aa
2012-08-01 11:36:41 -05:00
Tom Fifield
71d9e6bbd8 clouddocs-maven-plugin version bump for two docs
Changes the version of the api-quick-start and api-programming docs'
clouddocs-maven-plugin to the latest stable version (1.3.1).

checked for build success on ubuntu 12.04

related to bug 1021543

Change-Id: I308a30a3b3f9a530a59a2efa905d27839e750d74
2012-07-29 11:55:53 +08:00
annegentle
28479a8ef9 Updates api.openstack.org to v2 instead of v1.1 for Compute API.
Adds some additional details to createServer.
 - Fix bug 933547 by adding imageRef, flavorRef to create Server
 - Adds metadata and personality to create Server command

Change-Id: I8970bec78164fec7bcab93960ca145273f858824
2012-07-23 15:55:49 -05:00
Alex Meade
1661312470 Add documentation for recently added os-used-limits extension.
The os-used-limits extension adds information for limits that have been used so
far to the /limits GET response.

The ext was added in this patch: https://review.openstack.org/#/c/9544/

Change-Id: I8bdb1b9ebdbc4b92a8e9a3143e8ed5d4724ac264
2012-07-17 11:07:49 -04:00
Joe Gordon
953c6c50ec Add {create, delete}_aggregate calls to api-site
Partially fix bug 1015821

Change-Id: I10e27256dd05b05ae3ecc91fa9f108bc4801935e
2012-07-09 18:43:47 -07:00
Tom Fifield
a21914c5f4 Adds swap and rxtx_factor to flavour documentation
"rxtx_factor" and "swap" were added 6 months ago, but were missing
from the flavour documentation.

This change adds them to the xsd and xml/json examples.

fixes bug 999932

Feedback welcome - especially if you have an idea what rxtx_factor
is ;)

Patch 2 - explains rxtx_factor and fixes JSON example

Change-Id: Ib2e36156ed596532c0e625d8f45b14870dbc7d15
2012-06-28 16:03:04 +10:00
annegentle
bc62604625 This patch adds the correct response .json file for the os-aggregates wadl
Patch also attempts to fix the figures missing from the new externals chapter
in the Compute Administration Manual.

Change-Id: I62c1b83d4145eac8066c988f21d270c0ede23967
2012-06-22 12:48:17 -05:00
Jenkins
84cab8b767 Merge "Add instance_id in the Tenant Usage API." 2012-06-22 07:55:33 +00:00
Lin Hua Cheng
5e2f30c9c2 Add instance_id in the Tenant Usage API.
Fixes Bug #1016274

Tenant Usage API has been updated to include
instance_id in the response (bug 1003093).
The example has been updated to add the
new field.

Change-Id: I7d60be4f809d8d5f5fba39d5cd96e2db616387af
2012-06-21 22:40:35 -07:00
Joe Gordon
3ef395162d Partially fix bug 1015821
Add aggregates-list to api-site

Patch set 2 fixes wadl so that mvn generate-sources builds
successfully. Just simplified some of the resources.

Also added more definition for "what is an aggregate anyway?"
so please review and edit as needed. I'm pretty sure
an aggregate is defined by the cloud provider, right? 1:wq

Change-Id: I097df5d2051b053508dabcc9d001771a94415dae
2012-06-22 00:03:57 -05:00
Tom Fifield
db403294aa Fixes code sample in "Getting the API Endpoint"
fixes bug 987624
The code sample in "Getting the API Endpoint URL" had a number of
errors, such as missing auth node, incorrect use of variables etc
This patch fixes that so it should actually work

Patch set 2 adds auth wrapper to all locations in both the xml and mdown document,
plus fixes a "you password" typo.

I think this auth wrapper is needed for Trystack also so ignore my previous comment
about a note needed for diablo v essex clouds.

Patch set 3 fixes the end curly braces (need 3 not 4) and adds a note to address
the empty service catalaog that template-backed clouds return.

Change-Id: I57d055c9a63db73f6b8fb4b59ccdaf36b98e4a19
2012-06-20 09:41:34 -05:00
Tom Fifield
7026129f33 Fix broken link in compute api doc
fixes bug 1005408
Simple change to URL to fix broken link in compute api doc

Change-Id: Ie9d4d71d391804bfd378793b74b3ee8024638ee7
2012-06-16 20:41:05 +10:00
annegentle
4a1934f298 Fix bug 1002984
Fix up the wording problems with images and version names.

Patches fix the actual examples too.

Remove maverick mentions.

Change-Id: I6abdd9953d1e62bd734bd97b49d36a45bd1cb937
2012-05-23 11:09:04 -05:00
Tom Fifield
8ce1d758fc bug 948242 make doc use 'Administration' consistently
Changes the title and reference to titles of documents previously called
 "Admin Guide/Manual" to be "Administration Guide/Manual", as suggested in
bug 948242

Patched to get the Quantum Administrator Manual title to wrap correctly in PDF output.

Change-Id: I360d74c5ad16650c7b838541bb976680c0297b26
2012-05-16 11:05:20 -05:00
Jenkins
9e3d2e585d Merge "Updated code file names to all lowercase. Fixed minor errors." 2012-05-09 14:19:47 +00:00
dcramer
95301d0801 Adjusting paths to wadls from index.xml in preparation for
the auto-normalization functionality coming in 1.3.0
of the clouddocs plugin.

Change-Id: I64f870f58c2d41999a801400714c5ef4a794986a
2012-05-08 21:17:42 -05:00
Diane Fleming
3ed6742a23 Updated code file names to all lowercase. Fixed minor errors.
Rebased against master

Change-Id: I353835eded3360761997281ac2133a1c6e61a4f6
2012-05-08 12:01:11 -05:00
Jenkins
976c1f0e7c Merge "bug #995727 Correct the wrong href values in a WADL file" 2012-05-08 16:51:01 +00:00
annegentle
a5293c80f3 Fix another changePassword reference
Change-Id: I86dd59a677526b6c2a657abace146113fb3ead88
2012-05-07 10:22:17 -05:00
annegentle
bef8ea7875 Fix changePassword > changepassword
for sample xml in the compute API wadl that builds the api.openstack.org site.

Change-Id: I8f28db62182f2498e01561434e5bc29424eae4f4
2012-05-07 10:07:34 -05:00
annegentle
f7d5893090 Fix api site build
Remove server action list wadl that was not needed.

Change-Id: I53bec6b387748a3a40f6feb3b3da4ed4bb67d56a
2012-05-07 09:40:27 -05:00
annegentle
500f7d8deb Fix pom.xml for api site so it will build
Should not point to a SNAPSHOT release of the Cloud docs plugin, apparently.

Change-Id: I1bfd2bdef7e0577c47a1eeffad70b40f8153479d
2012-05-07 09:08:32 -05:00
daisy-ycguo
3c4e8667cb bug #995727 Correct the wrong href values in a WADL file
Change-Id: I4576d72e3afbaac43a515befa55d7a0e25a39b97
2012-05-07 14:20:37 +08:00
Jenkins
4622bf4b2b Merge "Fixing floating-ip-dns extention doc." 2012-05-04 16:33:36 +00:00