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 -*-

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

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

Ping instances (os-fping) (DEPRECATED)

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

.. warning::

This API only works with ``nova-network`` which is

deprecated. It should be avoided in any new applications.

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, os-fping.inc -Updated response parameters in parameters.yaml. -Verified body text, methods, parameters. Change-Id: I35c9e95c8223072c37da33fddf9633bba82a2544

2016年05月19日 12:16:31 -04:00

Pings instances and reports which instances are alive.

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

Ping Instances

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

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:: GET /os-fping

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, os-fping.inc -Updated response parameters in parameters.yaml. -Verified body text, methods, parameters. Change-Id: I35c9e95c8223072c37da33fddf9633bba82a2544

2016年05月19日 12:16:31 -04:00

Runs the fping utility to ping instances and reports which instances are alive.

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

Specify the ``all_tenants=1`` query parameter to ping instances for all tenants. For example:

api-ref, os-fping.inc -Updated response parameters in parameters.yaml. -Verified body text, methods, parameters. Change-Id: I35c9e95c8223072c37da33fddf9633bba82a2544

2016年05月19日 12:16:31 -04:00

::

GET /os-fping?all_tenants=1

Specify the ``include`` and ``exclude`` query parameters to filter the results. For example:

::

GET /os-fping?all_tenants=1&include=uuid1,uuid2&exclude=uuid3,uuid4

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

Complete method verification of os-fping Verified the API document for os-fping with source for methods available and response codes. Part of bp:api-ref-in-rst Change-Id: Iab4fda784734337da25202ebba567a01ca63ae9e

2016年05月09日 21:18:24 +00:00

Policy defaults enable only users with the administrative role or the

owner of the server to perform this operation. Cloud providers can

change these permissions through the ``policy.json`` file.

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

Complete method verification of os-fping Verified the API document for os-fping with source for methods available and response codes. Part of bp:api-ref-in-rst Change-Id: Iab4fda784734337da25202ebba567a01ca63ae9e

2016年05月09日 21:18:24 +00:00

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

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

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

- all_tenants: all_tenants

- include: include

- exclude: exclude

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, os-fping.inc -Updated response parameters in parameters.yaml. -Verified body text, methods, parameters. Change-Id: I35c9e95c8223072c37da33fddf9633bba82a2544

2016年05月19日 12:16:31 -04:00

.. rest_parameters:: parameters.yaml

- servers: servers

- alive: alive

- id: server_id

- project_id: project_id

|

**Example Ping Instances**

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 ref for os-hosts, os-quota-sets and os-fping This patch fix API ref for correct sample files and status code for below APIs - os-hosts - os-quota-sets - os-fping Part of bp:api-ref-in-rst Change-Id: I7ecfe5adf4d8f1e9c767bac9194d9160f09fbee9

2016年04月19日 21:12:29 +08:00

.. literalinclude:: ../../doc/api_samples/os-fping/fping-get-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

Ping An Instance

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

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:: GET /os-fping/{instance_id}

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, os-fping.inc -Updated response parameters in parameters.yaml. -Verified body text, methods, parameters. Change-Id: I35c9e95c8223072c37da33fddf9633bba82a2544

2016年05月19日 12:16:31 -04:00

Runs the fping utility to ping an instance and reports whether the instance is alive.

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

Complete method verification of os-fping Verified the API document for os-fping with source for methods available and response codes. Part of bp:api-ref-in-rst Change-Id: Iab4fda784734337da25202ebba567a01ca63ae9e

2016年05月09日 21:18:24 +00:00

Policy defaults enable only users with the administrative role or the

owner of the server to perform this operation. Cloud providers can

change these permissions through the ``policy.json`` file.

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

Complete method verification of os-fping Verified the API document for os-fping with source for methods available and response codes. Part of bp:api-ref-in-rst Change-Id: Iab4fda784734337da25202ebba567a01ca63ae9e

2016年05月09日 21:18:24 +00:00

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

itemNotFound(404)

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

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

- instance_id: instance_id

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, os-fping.inc -Updated response parameters in parameters.yaml. -Verified body text, methods, parameters. Change-Id: I35c9e95c8223072c37da33fddf9633bba82a2544

2016年05月19日 12:16:31 -04:00

.. rest_parameters:: parameters.yaml

- server: server

- alive: alive

- id: server_id

- project_id: project_id

|

**Example Ping An Instance**

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 ref for os-hosts, os-quota-sets and os-fping This patch fix API ref for correct sample files and status code for below APIs - os-hosts - os-quota-sets - os-fping Part of bp:api-ref-in-rst Change-Id: I7ecfe5adf4d8f1e9c767bac9194d9160f09fbee9

2016年04月19日 21:12:29 +08:00

.. literalinclude:: ../../doc/api_samples/os-fping/fping-get-details-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

108 lines 2.3 KiB PHP Raw Normal View History Unescape Escape

108 lines

2.3 KiB

PHP

Raw Normal View History