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

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

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

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

Host aggregates (os-aggregates)

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

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

Creates and manages host aggregates. An aggregate assigns metadata to

groups of compute nodes. Aggregates are only visible to the cloud

provider.

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

List Aggregates

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

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

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

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 aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Lists all aggregates. Includes the ID, name, and availability zone for each aggregate.

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 aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +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: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

.. rest_parameters:: parameters.yaml

- aggregates: aggregates

- availability_zone: aggregate_az

- created_at: created

- deleted_at: deleted_at

- deleted: deleted

- hosts: aggregate_host_list

- id: aggregate_id_body

- metadata: aggregate_metadata

- name: aggregate_name

- updated_at: updated_consider_null

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

**Example List Aggregates: JSON response**

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 aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

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

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Create Aggregate

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

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

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 /os-aggregates

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 aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Creates an aggregate in an 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

Normal response codes: 200

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Error response codes: badRequest(400), unauthorized(401), forbidden(403), conflict(409)

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

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- aggregate: aggregate

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

- name: aggregate_name

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- availability_zone: aggregate_az_optional

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

**Example Create Aggregate: JSON request**

.. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-post-req.json

:language: javascript

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: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

.. rest_parameters:: parameters.yaml

- aggregate: aggregate

- availability_zone: aggregate_az

- created_at: created

- deleted_at: deleted_at

- deleted: deleted

- id: aggregate_id_body

- name: aggregate_name

- updated_at: updated_consider_null

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

**Example Create Aggregate: JSON response**

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 aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-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

Show Aggregate Details

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

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-aggregates/{aggregate_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

Shows details for an aggregate. Details include hosts and metadata.

Normal response codes: 200

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

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

- aggregate_id: aggregate_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: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

.. rest_parameters:: parameters.yaml

- aggregate: aggregate

- availability_zone: aggregate_az

- created_at: created

- deleted_at: deleted_at

- deleted: deleted

- hosts: hosts

- id: aggregate_id_body

- metadata: aggregate_metadata

- name: aggregate_name

- updated_at: updated_consider_null

Fix json response example heading in api ref Heading for json response example is wrong, it is json request instead of json response. Part of bp:api-ref-in-rst Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b

2016年04月19日 17:52:18 +09:00

**Example Show Aggregate Details: JSON response**

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 sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

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

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Update Aggregate

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

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

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:: PUT /os-aggregates/{aggregate_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

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Updates either or both the name and availability zone for an aggregate.

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 aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

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

itemNotFound(404), conflict(409)

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

- aggregate_id: aggregate_id

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- aggregate: aggregate

- name: aggregate_name_optional

- availability_zone: aggregate_az_optional

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 aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

**Example Update Aggregate: JSON request**

.. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-update-post-req.json

:language: javascript

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: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

.. rest_parameters:: parameters.yaml

- aggregate: aggregate

- availability_zone: aggregate_az

- created_at: created

- deleted_at: deleted_at

- deleted: deleted

- hosts: hosts

- id: aggregate_id_body

- metadata: aggregate_metadata

- name: aggregate_name

- updated_at: updated_consider_null

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

**Example Update Aggregate: JSON response**

.. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-update-post-resp.json

:language: javascript

Delete Aggregate

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

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

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:: DELETE /os-aggregates/{aggregate_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

complete Method Verification of aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Deletes an aggregate.

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 aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Error response codes: badRequest(400), 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

- aggregate_id: aggregate_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

Add Host

========

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 /os-aggregates/{aggregate_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

Adds a host to an aggregate.

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

Specify the ``add_host`` action and host name in the request body.

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 aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

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

itemNotFound(404), conflict(409)

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

- aggregate_id: aggregate_id

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- add_host: aggregate_add_host

- host: host_name_body

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 Add Host: JSON request**

Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-add-host-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: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

.. rest_parameters:: parameters.yaml

- aggregate: aggregate

- availability_zone: aggregate_az

- created_at: created

- deleted_at: deleted_at

- deleted: deleted

- hosts: hosts

- id: aggregate_id_body

- metadata: aggregate_metadata

- name: aggregate_name

- updated_at: updated_consider_null

Fix json response example heading in api ref Heading for json response example is wrong, it is json request instead of json response. Part of bp:api-ref-in-rst Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b

2016年04月19日 17:52:18 +09:00

**Example Add Host: JSON response**

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 sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/aggregates-add-host-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

Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

Remove Host

===========

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

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 /os-aggregates/{aggregate_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

Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

Removes a host from an aggregate.

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: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

Specify the ``remove_host`` action and host name in the request body.

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 aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

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

itemNotFound(404), conflict(409)

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

- aggregate_id: aggregate_id

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- remove_host: aggregate_remove_host

- host: host_name_body

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 sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

**Example Remove Host: JSON request**

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 sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-remove-host-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: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

.. rest_parameters:: parameters.yaml

- aggregate: aggregate

- availability_zone: aggregate_az

- created_at: created

- deleted_at: deleted_at

- deleted: deleted

- hosts: hosts

- id: aggregate_id_body

- metadata: aggregate_metadata

- name: aggregate_name

- updated_at: updated_consider_null

Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

**Example Remove Host: JSON response**

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 sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/aggregates-remove-host-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

Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

Create Or Update Aggregate Metadata

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

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

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 /os-aggregates/{aggregate_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

Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

Creates or replaces metadata for an aggregate.

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 sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

Specify the ``set_metadata`` action in the request body.

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 aggregates This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a

2016年04月25日 12:46:22 +08:00

Error response codes: badRequest(400), 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

- aggregate_id: aggregate_id

api-ref: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

- set_metadata: set_metadata

- metadata: metadata_set_required

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 sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

**Example Create Or Update Aggregate Metadata: JSON request**

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 sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-metadata-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: parameter verification for os-aggregates checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac

2016年05月12日 20:23:17 +08:00

.. rest_parameters:: parameters.yaml

- aggregate: aggregate

- availability_zone: aggregate_az

- created_at: created

- deleted_at: deleted_at

- deleted: deleted

- hosts: hosts

- id: aggregate_id_body

- metadata: aggregate_metadata

- name: aggregate_name

- updated_at: updated_consider_null

Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

**Example Create Or Update Aggregate Metadata: JSON response**

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 sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd

2016年04月20日 10:35:37 +09:00

.. literalinclude:: ../../doc/api_samples/os-aggregates/aggregates-metadata-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

343 lines 7.6 KiB PHP Raw Normal View History Unescape Escape

343 lines

7.6 KiB

PHP

Raw Normal View History