13 Commits

Author SHA1 Message Date
Vu Cong Tuan
605d617d55 Repair links in Nova documentation
Some reference links are out of date.
There's 404 error when trying to access them.

For example:
http://developer.openstack.org/api-ref/networking/
v2-ext/index.html#security-groups-security-groups

Change-Id: Iead6a6f32cdb2c9067bb5425333ad043514edbce
2017-05-23 17:17:52 +07:00
jichenjc
deac17c4f9 Better wording for micorversion 2.36
make it follow other descriptions, use start from to make
it clear 2.36 is the first microversion deprecate those proxy

Implements: blueprint api-ref-in-rst-ocata

Change-Id: Iadf4bb6fa8e4a959a734f354206e2e1f4739e367
2016-12-10 18:49:13 +08:00
ghanshyam
b4d0b9a11c Mention proxy API deprecation microversion in api-ref
Proxy APIs are deprecated in microversion 2.36 which means
all proxy APIs will return 404 after 2.35 version.

It will be nice to mention that explicitly in api-ref too.

Partially implements blueprint deprecate-api-proxies

Change-Id: Iad210d215fb98bc247f049b23b97d8d7d4265c82
2016-08-01 14:59:53 +09:00
Matt Riedemann
d2bd83bec9 Fix links to network APIs from api-ref
This fixes the direct links to the security groups, security
group rules and floating IPs (layer 3) extensions in the
neutron api-ref.

Part of blueprint deprecate-api-proxies

Change-Id: Ib2c4ed478714b187fde8b7c42da15cc56b26675e
2016-07-25 17:13:05 -04:00
ghanshyam
40ea165e81 Publish proxy APIs deprecation in api ref doc
As first step to deprecate the proxy APIs,
this commit publish the deprecation of proxy APIs
in api ref doc.

Partially implements blueprint deprecate-api-proxies

Change-Id: Ie19ec5e27fef956061786646e8f9cc4e44d8ef0f
2016-06-14 15:31:18 +09: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
Matt Riedemann
31e798dc21 Add a note about egress rules to os-security-group-rules api-ref
There have been at least a couple of bugs about not being able
to create egress security group rules in Nova, which is because
nova-network does not support them. Neutron does, but Nova does
not proxy this to Neutron, nor will it.

So add a note in the api-ref docs for creating security group
rules about the egress rule limitation with nova-network.

Change-Id: Idc79cd1718b52db8611fd108b23f176f925221a6
Related-Bug: #1579749
Related-Bug: #1267140
2016-05-14 11:48:14 -04:00
Matt Riedemann
ad739f8e13 api-ref: parameter validation for os-security-group-rules
Cleans up a bunch of the types and descriptions for the
parameters.

Removes some extraneous unused parameters.

Added descriptions for the request and response to point out
that group_id and cidr are optional but one or the other is
required and depending on what comes in the request influences
what comes back in the response.

Part of blueprint api-ref-in-rst

Change-Id: I1084fa7ec46373cc989d1d93bb667ac59a62e38a
2016-05-11 11:23:40 -04:00
Ronald Bradford
3860d7e671 Complete method verification of os-security-group-rules
Verified the API document with source for methods available and
response codes used.

Part of bp:api-ref-in-rst

Change-Id: I7e332f1b18083a7d5edb07d7fb65b3757bea131a
2016-05-10 10:12:48 +00: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
Sean Dague
c52b7c6a9e fix samples references in security group files
This fixes the samples references in the security group files,
commenting out 2 that don't exist at all.

This drops the warnings to 145 against current master.

Part of bp:api-ref-in-rst

Change-Id: I0cb9932dc54cdffcbd9eda274a06d708e87409d8
2016-04-19 14:08:33 -04: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