14 Commits

Author SHA1 Message Date
ghanshyam
449da03245 Remove "DEPRECATED" tag from Obsolete APIs
APIs which are being Obsoleted and return 410 like nova-net
only APIs, have been moved to "Obsolete API" section in api-ref.

In favour of moving them in "Obsolete API" section, "DEPRECATED"
tag on those API ref can be removed to avoid confusion whether
these APIs are deprecated or gone.

Part of blueprint remove-nova-network

ref- https://review.openstack.org/#/c/567682/1/api-ref/source/os-fping.inc@4

Change-Id: I47eaf08a9c06e33d707fdfe88f6771e165f377b5
2018-07-18 22:23:45 -04:00
Stephen Finucane
db294b1e33 Remove support for /os-floating-ip-dns REST API
Drop support for the os-floating-ip-dns API which has been deprecated
since Newton:

  Idca478c566f9a7b5b30a3172453ce7c66d9fd8f0

This API now returns a 410 response for all routes.

Unit tests are removed and the functional API sample tests are just
asserting the 410 response now.

The API sample docs are left intact since the API reference still builds
from those and can be considered more or less branchless, so people
looking at the API reference can apply it to older deployments of nova
before os-floating-ip-dns was removed.

The release note added for previous nova-network API removals is
amended to note this additional change.

Part of blueprint remove-nova-network

Change-Id: I0c4b586292814b8483226aee315f41cbefc86a1e
2018-07-18 22:23:45 -04:00
Matt Riedemann
47f646ccf2 Fix API reference for os-floating-ip-dns
The generic warning in here about being a proxy to
neutron is incorrect since these APIs don't proxy
anything to neutron and won't work if you're using
neutron, so the warning is updated.

Part of blueprint remove-nova-network

Change-Id: I8b7638bb0835711ef174d6caf1b53e4a1808ef53
2018-06-26 09:41:07 -04: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
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
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
Anusha Unnam
6987a1f506 api-ref: os-floating-ip-dns.inc method verification
Verified the API document with source for methods available
and response codes used.

Part of bp:api-ref-in-rst

Change-Id: Ic462bbdd1f559a89aa43707cf510b6cf621ff4b0
2016-05-12 17:44:17 +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
ghanshyam
ca65bf4e91 Fix sample file path for fixed, floating ips API
This fix sample file path and some satatus code for
-fixed ips
-floating ips

Part of bp:api-ref-in-rst

Change-Id: I33341d67e678f70b1a4feb9b39a14f5ac81e8c65
2016-04-20 11:05:26 +09:00
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
2016-04-19 17:56:20 +09: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