0b1a33ec9ce903e2261dd5ae7b0db8e2968135dc
12 Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
|
Stephen Finucane
|
0b1a33ec9c |
nova-net: Update API reference guide
As highlighted in I77b1cfeab3c00c6c3d7743ba51e12414806b71d2, filtering either floating IPs or floating IP pools by floating IP name will actually fallback to filtering by ID. Update the API ref to reflect this. Change-Id: I00443ae111cbd1e1ec4d2c2ae1828ddaa095fd1a Signed-off-by: Stephen Finucane <sfinucan@redhat.com> |
||
|
Matt Riedemann
|
8d4db5b88a |
Update API reference for os-floating-ip-pools
The os-floating-ip-pools API is implemented for both nova-network and neutron. When using neutron, it justs lists external network names. Since it's a deprecated proxy to neutron we won't remove it as part of blueprint remove-nova-network, but we can update the API reference to explain how to achieve the equivalent functionality in the networking service API, so that's done here. Change-Id: Ieb4c7a0657929f66ed5b642c5941e65aee24372d |
||
|
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 |
||
|
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 |
||
|
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 |
||
|
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 |
||
|
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 |
||
|
jichenjc
|
797e7094eb |
api-ref verify os-floating-ip-pools.inc
verified the API doc for os-floating-ip-pools, adjus the wording for 'owner' of the server, Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: Id8bd213282bc53f1f9fbc24d1d2b03ea135c376e |
||
|
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 |
||
|
ghanshyam
|
6f8cda2f39 |
Fix json response example heading in api ref
Heading for json response example is wrong, it is json request instead of json response. Part of bp:api-ref-in-rst Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b |
||
|
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 |
||
|
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 |