openstack/nova - nova - OpenDev: Free Software Needs Free Tools

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月12日 09:03:46 -04:00

.. -*- rst -*-

Show Console Output (Os-Getconsoleoutput Action)

================================================

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月02日 08:50:03 -04:00

.. rest_method:: POST /servers/{server_id}/action

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月12日 09:03:46 -04:00

Shows console output for a server instance.

api-ref: perform all 4 phases of verification for action console output This provides the verification of the action console output. * Return codes updated based on what's in the code * Parameters fixed (length -1 is not actually a thing, it's suggestion for future enhancement; console output described; server_id should be in path). * Add preamble for request example * Clean up language on preamble Part of bp:api-ref-in-rst Change-Id: I7071a1e528b0aa8df16589facee4ed4fd62f7b4b

2016年05月09日 15:49:38 -04:00

This returns the text of the console since boot in a REST

response. The console content may be large, you can limit it with the

optional ``length`` parameter.

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月12日 09:03:46 -04:00

Normal response codes: 200

api-ref: perform all 4 phases of verification for action console output This provides the verification of the action console output. * Return codes updated based on what's in the code * Parameters fixed (length -1 is not actually a thing, it's suggestion for future enhancement; console output described; server_id should be in path). * Add preamble for request example * Clean up language on preamble Part of bp:api-ref-in-rst Change-Id: I7071a1e528b0aa8df16589facee4ed4fd62f7b4b

2016年05月09日 15:49:38 -04:00

Error response codes: unauthorized(401), forbidden(403),

notFound(404), conflict(409), methodNotImplemented(501)

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月12日 09:03:46 -04:00

Request

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月14日 13:10:59 -04:00

-------

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月12日 09:03:46 -04:00

.. rest_parameters:: parameters.yaml

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月02日 08:50:03 -04:00

api-ref: perform all 4 phases of verification for action console output This provides the verification of the action console output. * Return codes updated based on what's in the code * Parameters fixed (length -1 is not actually a thing, it's suggestion for future enhancement; console output described; server_id should be in path). * Add preamble for request example * Clean up language on preamble Part of bp:api-ref-in-rst Change-Id: I7071a1e528b0aa8df16589facee4ed4fd62f7b4b

2016年05月09日 15:49:38 -04:00

- server_id: server_id_path

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月12日 09:03:46 -04:00

- os-getConsoleOutput: os-getConsoleOutput

- length: length

api-ref: perform all 4 phases of verification for action console output This provides the verification of the action console output. * Return codes updated based on what's in the code * Parameters fixed (length -1 is not actually a thing, it's suggestion for future enhancement; console output described; server_id should be in path). * Add preamble for request example * Clean up language on preamble Part of bp:api-ref-in-rst Change-Id: I7071a1e528b0aa8df16589facee4ed4fd62f7b4b

2016年05月09日 15:49:38 -04:00

**Example Get console output**

This requests the last 50 lines of the server in question.

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月12日 09:03:46 -04:00

Fix api sample references in 2 more files. The api sample reference is not correct fix incorrect return value. 1. servers-action-console-output.inc 2. servers-action-crash-dump.inc Part of bp:api-ref-in-rst Change-Id: Id0d946478a6a59f63f22117944309d3eb66013d3

2016年04月19日 17:12:00 +08:00

.. literalinclude:: ../../doc/api_samples/os-console-output/console-output-post-req.json

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月12日 09:03:46 -04:00

:language: javascript

Response

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月14日 13:10:59 -04:00

--------

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月12日 09:03:46 -04:00

api-ref: perform all 4 phases of verification for action console output This provides the verification of the action console output. * Return codes updated based on what's in the code * Parameters fixed (length -1 is not actually a thing, it's suggestion for future enhancement; console output described; server_id should be in path). * Add preamble for request example * Clean up language on preamble Part of bp:api-ref-in-rst Change-Id: I7071a1e528b0aa8df16589facee4ed4fd62f7b4b

2016年05月09日 15:49:38 -04:00

.. rest_parameters:: parameters.yaml

- output: console_output

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月12日 09:03:46 -04:00

**Example Get console output: JSON response**

Fix api sample references in 2 more files. The api sample reference is not correct fix incorrect return value. 1. servers-action-console-output.inc 2. servers-action-crash-dump.inc Part of bp:api-ref-in-rst Change-Id: Id0d946478a6a59f63f22117944309d3eb66013d3

2016年04月19日 17:12:00 +08:00

.. literalinclude:: ../../doc/api_samples/os-console-output/console-output-post-resp.json

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月12日 09:03:46 -04:00

:language: javascript

openstack/nova - nova - OpenDev: Free Software Needs Free Tools

47 lines 1.1 KiB PHP Raw Normal View History Unescape Escape

47 lines

1.1 KiB

PHP

Raw Normal View History