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
Matthew Treinish
2bcee77e3b
Remove nova-cert
This commit removes nova-cert which has been deprecated since change
Id7a1fc943cbe6d860a50d3cc776717b55351004b. The APIs have been hard coded
to return a 410 whenever they're called now. For the API ref a new
section for obsolete apis is added to the bottom of the page and the
certificates api ref is moved there.

Implements bp remove-nova-cert

Change-Id: I2c78a0c6599b92040146cf9f0042cff8fd2509c3
2017-04-27 22:28:01 -04:00
Kevin_Zheng
250799551b Trival fix typos in api-ref
Trival fix typos in api-ref

Change-Id: I98347db828a919dd9fa8f3c3ad51c7a048909176
2016-12-21 21:50:55 +08:00
ghanshyam
60935aa688 Trivial: add 'DEPRECATED' for os-certificates API ref
os-certificates API has been deprecated in
I0ffa9200d8b4f52da4751e731aecffe09fd3d4be

This patch just add 'DEPRECATED' in its heading in api-ref
to make it more clear.

Change-Id: I5ef30330e033eeb0576d3b4d31441d5481cc7d2e
2016-08-01 15:08:42 +09:00
Sean Dague
789edad0e8 Deprecate os-certificates
Coming out of the Nova midcycle we decided we really needed to
deprecate the os-certificates API and service. It is not used by any
of the rest of Nova. It's an API that requires a dedicated daemon to
be run. It's making Nova assume the responsibility for generating
secure certificates, even though it's not really managing entropy in
any sane way (which is why nova-cert is a service, so you could stick
these on all your computes so as to not run out of entropy).

Change-Id: I0ffa9200d8b4f52da4751e731aecffe09fd3d4be
2016-07-26 10:42:41 -04:00
Sean Dague
c43e8bd9fa api-ref: add note about os-certificates API
The os-certificates API is weird, and only wasn't removed during the
ec2 drop because we exposed it in the osapi. It will be dropped in the
future, and we should tell people to not use it starting now.

Change-Id: I95f8a9620f7eb865298b656477f77257de91b2cc
2016-07-01 12:53:28 +00:00
Karen Bradshaw
7010aad4e1 api-ref: os-certificates.inc
Verified methods, parameters, body text.
Updated parameters.yaml to include: certificate,
data, private_key.

Part of: bp/api-ref-in-rst

Change-Id: I1003caa6bf52ce158e813481b383544fa550320b
2016-06-29 13:14:12 +00: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
8b1298ff58 api-ref: os-certificates.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: I52de3b6ac0e8a155a5a07458e1fb453824d3aad2
2016-05-10 22:34:38 +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
90d64f229c Fix sample path for aggregate, certificate, console
This fix all sample file path for
-os-aggregates
-os-certificates
-os-consoles

Part of bp:api-ref-in-rst

Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd
2016-04-20 10:35:37 +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