Commit Graph

19 Commits

Author SHA1 Message Date
Stephen Finucane
3062a1199d Remove 'os-consoles' API
This exposes the 'nova-console' service via a REST API, a service that
can only be used with XVP VNC consoles, which in turn require the
'nova-xvpvncproxy' service. We we would like to remove the
'nova-console' and 'nova-xvpvncproxy' services, so start here.

Part of blueprint remove-xvpvncproxy

Change-Id: I2ee3b8c44e5d85e9b3c811ed3c5e6cddc563054f
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-11-22 16:09:36 +00:00
jichenjc
086a0c0213 Add description for /consoles
/consoles is only used by Xenserver VNC Proxy, so we add a note
in the api-ref doc.

Related-Bug: 1682303

Change-Id: Id9b55068afa516fb089ce8ba1c1956e4c571a6a6
2017-03-29 01:37:56 +08:00
ghanshyam
49cade591f Fix 'server' and 'instance' occurrence in api-ref
some api-ref have sentence like '..for a server instance'
which is inconsistent and confusing as we use server for VM terminology.
I think here 'instance' word is being considered object of server which
is wrong.

We should always mention server only.

part of bp:api-ref-in-rst-pike

Change-Id: I32afe56cfc66b34b76d1f7e1b507d3d5e722e6a1
2017-03-28 02:54:11 +00:00
jichenjc
271d9f6803 make 2.31 microversion wording better
use 'Now' is confusing, to make the wording more specific

Change-Id: Ifc4a9a192055af55d65fb48e6cb0d9968a986deb
Implements: blueprint api-ref-in-rst-ocata
2016-12-21 15:08:18 +08:00
Karen Bradshaw
168a500570 API Ref: update server_id params
- Update server_id params to be of type path.
- Cleaned up os-getConsoleOutput action string.
- Made empty response body description more consistent.
  Review and change as needed.

Implements: bp/api-ref-in-rst-ocata

Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
2016-11-11 14:01:51 -05:00
Jenkins
e7fa14e5b3 Merge "api-ref: Fix a 'port' parameter in os-consoles.inc" 2016-11-10 16:55:42 +00:00
Takashi NATSUME
cc84595c23 api-ref: Fix a 'port' parameter in os-consoles.inc
In 'Show Console Details' API,
'port' is not a port ID but a port number.

Change-Id: Iefdd9e9a68fc197a99b8c5e2e36a82c062caa35f
Closes-Bug: #1632153
2016-11-09 00:28:36 +00:00
Karen Bradshaw
414afadec3 [api-ref] Fix path parameter console_id
Replace path parameter id with console_id in DELETE method.

Change-Id: Id008784fd91b5f5b4974564643cb0086799f9a8a
2016-10-31 15:45:05 -04:00
Radoslav Gerganov
d04e41e72b Fix API doc for os-console-auth-tokens
There are multiple errors in the API doc for os-console-auth-tokens
(name, description, params). This patch fixes them.

Closes-Bug: #1602293

Change-Id: Ia3d678b4d9fc5b768088224d0338c8e97c761b3c
2016-10-06 18:09:52 +03:00
Chen Fan
f27a0e7ccc api-ref: unify the no response output in delete operation
Change-Id: Ia90a5ef1cd1b432e68130313960a015b45fe63e0
Implements: blueprint api-ref-in-rst
2016-07-25 16:13:45 +08:00
Radoslav Gerganov
3c3925e71a Fix ConsoleAuthTokens to work for all console types
The current API allows getting connection info only for tokens which
correspond to RDP consoles. It should work for all types of tokens. This
patch introduces a new microversion which fixes this problem.

APIImpact

blueprint fix-console-auth-tokens

Change-Id: I27a65e0cd8b5eb51ecdc84cbf310ae107ff131dc
2016-06-22 17:11:09 +03: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
Karen Bradshaw
a29c26308e api-ref: os-consoles.inc
-Verified methods, examples, parameters, body text.
-Added console, consoles parameters.

Part of blueprint api-ref-in-rst

Change-Id: Ifd0b751e521a96ec82c78cd6354055d315596038
2016-05-30 15:13:15 +08:00
jichenjc
205a91a772 Complete method Verification of consoles
verified the API doc for os-consoles and os-console-auth-token,
Adjust GET/POST sequence in the doc Also,
remove some common error code like 500, 503 etc

Part of bp:api-ref-in-rst

Change-Id: If03d3b23246cc8af639c4a08bb22129937efeaeb
2016-04-25 04:00:05 +08: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
f208917c52 Fix remaining json reference warnings
This fixes the last json reference warning which exist. It also trims
out the baremetal API calls that we don't support any more (we only
have the readonly proxy). That was erroneously added to the compute
API docs in refactors of api-site last cycle.

Change-Id: I08be639b610304049b0959902ed8876559111274
2016-04-20 08:42:24 -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
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