summaryrefslogtreecommitdiff
path: root/api-ref/source/os-consoles.inc
Commit message (Collapse)AuthorAgeFilesLines
* Remove 'os-consoles' APIStephen Finucane2019-11-221-54/+15
| | | | | | | | | | | | 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>
* Add description for /consolesjichenjc2017-03-291-0/+2
| | | | | | | | | /consoles is only used by Xenserver VNC Proxy, so we add a note in the api-ref doc. Related-Bug: 1682303 Change-Id: Id9b55068afa516fb089ce8ba1c1956e4c571a6a6
* Fix 'server' and 'instance' occurrence in api-refghanshyam2017-03-281-5/+5
| | | | | | | | | | | | | 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
* make 2.31 microversion wording betterjichenjc2016-12-211-2/+3
| | | | | | | use 'Now' is confusing, to make the wording more specific Change-Id: Ifc4a9a192055af55d65fb48e6cb0d9968a986deb Implements: blueprint api-ref-in-rst-ocata
* API Ref: update server_id paramsKaren Bradshaw2016-11-111-13/+7
| | | | | | | | | | | - 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
* Merge "api-ref: Fix a 'port' parameter in os-consoles.inc"Jenkins2016-11-101-1/+1
|\
| * api-ref: Fix a 'port' parameter in os-consoles.incTakashi NATSUME2016-11-091-1/+1
| | | | | | | | | | | | | | | | In 'Show Console Details' API, 'port' is not a port ID but a port number. Change-Id: Iefdd9e9a68fc197a99b8c5e2e36a82c062caa35f Closes-Bug: #1632153
* | [api-ref] Fix path parameter console_idKaren Bradshaw2016-10-311-1/+1
|/ | | | | | Replace path parameter id with console_id in DELETE method. Change-Id: Id008784fd91b5f5b4974564643cb0086799f9a8a
* Fix API doc for os-console-auth-tokensRadoslav Gerganov2016-10-061-7/+7
| | | | | | | | | 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
* api-ref: unify the no response output in delete operationChen Fan2016-07-251-1/+1
| | | | | Change-Id: Ia90a5ef1cd1b432e68130313960a015b45fe63e0 Implements: blueprint api-ref-in-rst
* Fix ConsoleAuthTokens to work for all console typesRadoslav Gerganov2016-06-221-1/+2
| | | | | | | | | | | | 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
* remove /v2.1/{tenant_id} from all urlsSean Dague2016-06-031-10/+10
| | | | | | | | | | | | 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
* api-ref: os-consoles.incKaren Bradshaw2016-05-301-10/+51
| | | | | | | | | -Verified methods, examples, parameters, body text. -Added console, consoles parameters. Part of blueprint api-ref-in-rst Change-Id: Ifd0b751e521a96ec82c78cd6354055d315596038
* Complete method Verification of consolesjichenjc2016-04-251-22/+17
| | | | | | | | | | 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
* add tags to files for the content verification phaseSean Dague2016-04-201-0/+4
| | | | | | | | | | 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
* Fix remaining json reference warningsSean Dague2016-04-201-3/+2
| | | | | | | | | 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
* Fix sample path for aggregate, certificate, consoleghanshyam2016-04-201-3/+3
| | | | | | | | | | | This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd
* move sphinx h3 to '-' instead of '^'Sean Dague2016-04-151-10/+10
| | | | | | | | | | | | | | | 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
* Import RST files for documentationSean Dague2016-04-131-0/+142
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