17 Commits

Author SHA1 Message Date
Takashi NATSUME
3f96ec6490 api-ref: Fix parameters in server-security-groups
Change-Id: Ie8dc3252603ce77910e1addb67cdc8844369dfca
Implements: blueprint api-ref-in-rst-pike
Closes-Bug: #1699732
2017-07-10 14:02:13 +00:00
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
Jenkins
36eb305b97 Merge "Add offset & limit docs & tests" 2017-02-09 14:17:36 +00:00
Diana Clarke
fdba403d09 Add offset & limit docs & tests
A number of endpoints enable pagination via 'limit' & 'offset' query
parameters, but don't document or test this functionality.

 - os-cells
 - os-security-groups
 - os-server-groups
 - os-snapshots
 - os-virtual-interfaces
 - os-volume-attachments
 - os-volumes

Change-Id: I5b0ad25f7282f4a13bbb6f21b76e986e1008936a
2017-02-02 12:28:06 -05: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
Jenkins
406b8c36f8 Merge "Separate api-ref for list security groups by server" 2016-07-27 01:41:54 +00: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
bceeecc296 Separate api-ref for list security groups by server
All proxy APIs are now deprecated which includes
sec grp APIs also.

But list sec grps by server API-
(/servers/{server_id}/os-security-groups) is not
deprecated so this should be separated from deprecated
sec grp APIs in api-ref.

Partially implements blueprint deprecate-api-proxies

Change-Id: I9f9e2cf5f8e390cecd9e1794a0af1a3fcc24f149
2016-07-21 16:42:57 +09: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
Augustina Ragwitz
775bda6445 Trivial: remove os-security-groups needs:method_verification line
These methods were already verified in another change. The author forgot to
remove the needs:method_verification line from their change.

See change#314255

Part of bp:api-ref-in-rst

Change-Id: I13fb305f58df0b864bc27db5107601e4ee8842de
2016-05-17 09:41:54 -07:00
Ronald Bradford
ca690257d4 Complete method verification of os-security-groups
Verified the API document with source for methods available and
response codes used.

Part of bp:api-ref-in-rst

Change-Id: Ie3e9e39f5547a3172483b42d21536acf46b445d3
2016-05-09 16:01:48 -04: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