10 Commits

Author SHA1 Message Date
Matt Riedemann
1241e3ec2a Stop using "nova" in API samples when creating a server
The "availability_zone" parameter for server create in the
API reference and the availabilty zone user docs both say
that users should not use the default availability zone (nova)
yet our server create API samples use "nova" which is...bad.

This change fixes the API samples and related tests to use
a fake "us-west" availability zone. For any samples that were
requesting an AZ when creating a server, those are changed from
requesting "nova" to requesting "us-west" and a new
AvailabilityZoneFixture is added to stub out the code used to
validate the requested AZ and what is shown in server detail
responses.

Some unused samples are removed from the os-availability-zone
directory and the API reference and AZ user docs are updated for
formatting and linking to other docs for reference.

Change-Id: I3161157f15f05a3ffaaf1b48e7beb6b3e59c5513
Closes-Bug: #1817963
2019-03-01 10:43:08 -05:00
Andreas Jaeger
4e6eec5c9b Fix broken URLs
Fix broken nova URLs that linked to the old developer/nova places and
use the new link instead.

Change-Id: Ideb50626e140201dded19fc82584440f1a407e47
2017-09-07 15:42:31 +02:00
Takashi NATSUME
7c66d4184b api-ref: Fix a parameter in os-availability-zone.inc
In "Get Availability Zone Information",
the 'hosts' response parameter is always 'null'.
So fix the description.

Change-Id: I23bd8b3a422aa03c3f56d7f2f10f6603acd0078a
Closes-Bug: #1654427
2017-01-18 10:02:18 +00:00
Karen Bradshaw
a7fa4f426e api-ref, os-availability-zone.inc
Verified parameters, body text, examples.
-Added brief howto for creating an AZ and linked
to Host Aggregates developer documentation.
-Added new hosts object with details about service
 states.
Change-Id: I721628f95d8623591447f88fa68a0f7601823308
2016-06-20 09:43:51 -04:00
Sean Dague
c9f5ad3bcf remove /v2.1/{tenant_id} from all urls
As discussed at summit, the version part of the URL is not really
relevant, or a thing a user should be filling out themselves, this
should instead be set by the service catalog and extracted from the
token.

This removes it's reference in all documented REST urls, and adds a
new section describing how one gets the base URL for all calls.

Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-03 08:47:33 -04:00
jichenjc
ffee1b3444 Complet Method Verification of availability-zone
verified the API doc for os-availability-zone, Added
one description for default policy
Also, remove some common error code like 500, 503 etc

detail log: http://paste.openstack.org/show/495423/

Part of bp:api-ref-in-rst

Change-Id: Icb898f0482e8a17289cd5047ef1c64a2481ccabb
2016-04-23 01:56:55 +08:00
Sean Dague
d929b9fc76 add tags to files for the content verification phase
This adds a set of tags in comments to the beginning of files so that
we can process them according to the documentation here:
https://wiki.openstack.org/wiki/NovaAPIRef

Part of bp:api-ref-in-rst

Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
2016-04-20 16:21:58 -04:00
jichenjc
fb7b7e7f95 Fix hosts and az api samples
Those 2 files has incorrect api samples, this patch fixs it.

Part of bp:api-ref-in-rst

Change-Id: I71033531fefdb27b191a3a5abb3cba6fbb48b6c1
2016-03-23 13:58:30 +08:00
Sean Dague
9526462326 move sphinx h3 to '-' instead of '^'
In the sphinx document h3 is supposed to be '-' not '^':

=, for sections
-, for subsections
^, for subsubsections

We have to enforce consistency here because we're processing included
files which all have to agree, otherwise it's a sphinx error.

Part of bp:api-ref-in-rst

Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-15 07:43:06 -04:00
Sean Dague
d4e2771440 Import RST files for documentation
This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API document. This is the starting point for fixing the
documentation.

Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-13 07:34:45 -04:00