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

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

Availability zones (os-availability-zone)

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

api-ref, os-availability-zone.inc Verified parameters, body text, examples. -Added brief howto for creating an AZ and linked to Host Aggregates developer documentation. -Added new hosts object with details about service states. Change-Id: I721628f95d8623591447f88fa68a0f7601823308

2016年05月26日 16:48:31 -04:00

Lists and gets detailed availability zone information.

An availability zone is created or updated by setting the

availability_zone parameter in the ``create``, ``update``, or

``create or update`` methods of the Host Aggregates API.

Fix broken URLs Fix broken nova URLs that linked to the old developer/nova places and use the new link instead. Change-Id: Ideb50626e140201dded19fc82584440f1a407e47

2017年09月06日 22:01:01 +02:00

See `Host Aggregates

<https://docs.openstack.org/nova/latest/user/aggregates.html>`_

api-ref, os-availability-zone.inc Verified parameters, body text, examples. -Added brief howto for creating an AZ and linked to Host Aggregates developer documentation. -Added new hosts object with details about service states. Change-Id: I721628f95d8623591447f88fa68a0f7601823308

2016年05月26日 16:48:31 -04:00

for more details.

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

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

api-ref, os-availability-zone.inc Verified parameters, body text, examples. -Added brief howto for creating an AZ and linked to Host Aggregates developer documentation. -Added new hosts object with details about service states. Change-Id: I721628f95d8623591447f88fa68a0f7601823308

2016年05月26日 16:48:31 -04:00

Lists availability zone information.

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

api-ref, os-availability-zone.inc Verified parameters, body text, examples. -Added brief howto for creating an AZ and linked to Host Aggregates developer documentation. -Added new hosts object with details about service states. Change-Id: I721628f95d8623591447f88fa68a0f7601823308

2016年05月26日 16:48:31 -04:00

.. rest_parameters:: parameters.yaml

- availabilityZoneInfo: availability_zone_info

api-ref: Fix a parameter in os-availability-zone.inc In "Get Availability Zone Information", the 'hosts' response parameter is always 'null'. So fix the description. Change-Id: I23bd8b3a422aa03c3f56d7f2f10f6603acd0078a Closes-Bug: #1654427

2017年01月06日 07:59:11 +09:00

- hosts: hosts.availability_zone_none

api-ref, os-availability-zone.inc Verified parameters, body text, examples. -Added brief howto for creating an AZ and linked to Host Aggregates developer documentation. -Added new hosts object with details about service states. Change-Id: I721628f95d8623591447f88fa68a0f7601823308

2016年05月26日 16:48:31 -04:00

- zoneName: OS-EXT-AZ:availability_zone

- zoneState: availability_zone_state

- available: available

|

**Example Get availability zone information**

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

api-ref, os-availability-zone.inc Verified parameters, body text, examples. -Added brief howto for creating an AZ and linked to Host Aggregates developer documentation. -Added new hosts object with details about service states. Change-Id: I721628f95d8623591447f88fa68a0f7601823308

2016年05月26日 16:48:31 -04: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

api-ref, os-availability-zone.inc Verified parameters, body text, examples. -Added brief howto for creating an AZ and linked to Host Aggregates developer documentation. -Added new hosts object with details about service states. Change-Id: I721628f95d8623591447f88fa68a0f7601823308

2016年05月26日 16:48:31 -04:00

.. rest_parameters:: parameters.yaml

- availabilityZoneInfo: availability_zone_info

- hosts: hosts.availability_zone

- zoneName: OS-EXT-AZ:availability_zone

- zoneState: availability_zone_state

- available: available

|

**Example Get detailed availability zone information**

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

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

76 lines 2.0 KiB PHP Raw Normal View History Unescape Escape

76 lines

2.0 KiB

PHP

Raw Normal View History