Commit Graph

14 Commits

Author SHA1 Message Date
He Jie Xu b2ee12ce19 Add link ref to nova api concept doc
This patch adds link to the api concept doc.

Change-Id: I3c9f7ebce7f4241a41492511b39f8649190b53eb
Partial-implements: blueprint api-ref-in-rst-ocata
2016-09-19 10:35:14 +08:00
Jenkins afa9084909 Merge "Deprecate os-certificates" 2016-07-28 20:02:06 +00: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
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
Jenkins 3f6ae25b27 Merge "api-ref: merge multiple create to servers.inc" 2016-07-19 01:50:38 +00:00
Sean Dague 039d0628a4 api-ref: merge multiple create to servers.inc
This creates a new way to describe multiple create as a dedicated
create call in the normal servers list. It only lists additional
parameters so that we're not copy / pasting between the 2 lists.

Part of bp:api-ref-in-rst

Change-Id: Ib15f224cf6a9432ae638c8b57a2156cd7b98215d
2016-07-04 13:57:18 +00:00
Sergey Nikitin 5417d83ec3 api-ref: added docs for microversion 2.26
Part of bp:tag-instances
Part of bp:api-ref-in-rst

Change-Id: Ifd0d518d086719eb248b442359c272b1799544c6
2016-06-23 23:42:39 +03: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
Sean Dague 36c688f694 api-ref: finish validation for os-server-external-events.inc
This completes the validation for the admin event interface, including
detailing the codes we currently return in the parameter list.

Because os-service was incorrectly using the 'status' key, when I
renamed status => event_status I needed to also create a
service_status to make things compile. It's accurate enough to move
forward.

Because this is really a Neutron only API, this is moved towards the
bottom of the API list, to make it clear this isn't really designed to
be used by end user apps.

Part of bp:api-ref-in-rst

Change-Id: I3ed46eec1c33a63b7a89d6d6b5eeda574effdc56
2016-05-13 13:35:24 +00:00
sharat.sharma 75280e582e Deprecated the concept of extensions in v2.1.
The extensions in api-ref-compute-v2.1 is deprecated. This patch
depricates the extension infrastructure in v2.1.

Change-Id: Ie7731c25ee7c5c662c22835add3314ffa51f37bc
Closes-Bug: #1490531
2016-04-27 15:26:03 +05:30
Sean Dague e51b8f43e1 Add 'Show All' / 'Hide All' toggle
This adds a global control that does show / hide of all collapseable
sections. Which is extremely useful in seeing the entire API at once.

Part of bp:api-ref-in-rst

Change-Id: I814e6b2c20c25bf3d4cb4e722bc8157ca0aa1b89
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
Sean Dague 329898ffbc Add sample API content
This adds sample API content for versions and servers resources,
including the parameters.yaml that is needed in both of these cases.

It also makes a new tox.ini target 'api-ref' for building these docs,
which will be used as part of the publishing pipeline.

Change-Id: I310ed352dc5dd81d01f2fd5f1a2fab662c29f0dc
2016-03-29 16:35:33 -04:00