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

This website requires JavaScript.

openstack/nova

Code Issues Proposed changes

Files

95ed8cdb4cad857a2bf28e48c2e3cf7ea89d5013

nova /api-ref /source /os-availability-zone.inc

50 lines

1.3 KiB

PHP

Raw Normal View History

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

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:10:51 -04:00

.. needs:parameter_verification

.. needs:example_verification

.. needs:body_verification

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

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

Availability zones (os-availability-zone)

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

Shows availability zone information.

Get Availability Zone Information

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

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-availability-zone

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

Gets availability zone information.

Normal response codes: 200

Complet Method Verification of availability-zone verified the API doc for os-availability-zone, Added one description for default policy Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495423/ Part of bp:api-ref-in-rst Change-Id: Icb898f0482e8a17289cd5047ef1c64a2481ccabb

2016年04月23日 01:56:55 +08:00

Error response codes: 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

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

**Example Get availability zone information: JSON response**

Fix hosts and az api samples Those 2 files has incorrect api samples, this patch fixs it. Part of bp:api-ref-in-rst Change-Id: I71033531fefdb27b191a3a5abb3cba6fbb48b6c1

2016年03月23日 13:58:30 +08:00

.. literalinclude:: ../../doc/api_samples/os-availability-zone/availability-zone-list-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

Get Detailed Availability Zone Information

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

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-availability-zone/detail

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

Gets detailed availability zone information.

Complet Method Verification of availability-zone verified the API doc for os-availability-zone, Added one description for default policy Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495423/ Part of bp:api-ref-in-rst Change-Id: Icb898f0482e8a17289cd5047ef1c64a2481ccabb

2016年04月23日 01:56:55 +08:00

Policy defaults enable only users with the administrative role 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

Complet Method Verification of availability-zone verified the API doc for os-availability-zone, Added one description for default policy Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495423/ Part of bp:api-ref-in-rst Change-Id: Icb898f0482e8a17289cd5047ef1c64a2481ccabb

2016年04月23日 01:56:55 +08:00

Error response codes: 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

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

**Example Get detailed availability zone information: JSON response**

Fix hosts and az api samples Those 2 files has incorrect api samples, this patch fixs it. Part of bp:api-ref-in-rst Change-Id: I71033531fefdb27b191a3a5abb3cba6fbb48b6c1

2016年03月23日 13:58:30 +08:00

.. literalinclude:: ../../doc/api_samples/os-availability-zone/availability-zone-detail-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

Copy Permalink