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

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

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

Rules for default security group (os-security-group-default-rules) (DEPRECATED)

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

.. warning::

This API only available 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

Lists, shows information for, and creates default security group rules.

List Default Security Group Rules

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

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-security-group-default-rules

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

Lists default security group rules.

Remove 40X and 50X from Normal response codes HTTP 40X-50X are not normal response codes at all. This patch removes them from api-ref. Part of bp:api-ref-in-rst Change-Id: I32a29c9e2a3d69720e3a88e17ba36fe45fa902d9

2016年04月18日 16:41:58 -07:00

Normal response codes: 200

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

Method verification of os-security-group-default-rules Corrects the error status responses for os-security-group-default-rules.inc Part of bp:api-ref-in-rst Change-Id: I668b6cffaa76db781a75ed0896717b58d58623c5

2016年05月11日 21:07:54 +00:00

Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), notImplemented(501)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

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

.. rest_parameters:: parameters.yaml

- from_port: from_port

- id: id

- ip_protocol: ip_protocol

- ip_range: ip_range

- cidr: cidr

- to_port: to_port

**Example List default security group rules: JSON response**

.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rules-list-resp.json

:language: javascript

Method verification of os-security-group-default-rules Corrects the error status responses for os-security-group-default-rules.inc Part of bp:api-ref-in-rst Change-Id: I668b6cffaa76db781a75ed0896717b58d58623c5

2016年05月11日 21:07:54 +00:00

Show Default Security Group Rule 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

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-security-group-default-rules/{security_group_default_rule_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

Method verification of os-security-group-default-rules Corrects the error status responses for os-security-group-default-rules.inc Part of bp:api-ref-in-rst Change-Id: I668b6cffaa76db781a75ed0896717b58d58623c5

2016年05月11日 21:07:54 +00:00

Shows details for a security group rule.

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 40X and 50X from Normal response codes HTTP 40X-50X are not normal response codes at all. This patch removes them from api-ref. Part of bp:api-ref-in-rst Change-Id: I32a29c9e2a3d69720e3a88e17ba36fe45fa902d9

2016年04月18日 16:41:58 -07:00

Normal response codes: 200

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

Method verification of os-security-group-default-rules Corrects the error status responses for os-security-group-default-rules.inc Part of bp:api-ref-in-rst Change-Id: I668b6cffaa76db781a75ed0896717b58d58623c5

2016年05月11日 21:07:54 +00:00

Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), notImplemented(501)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Request

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

-------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. rest_parameters:: parameters.yaml

Method verification of os-security-group-default-rules Corrects the error status responses for os-security-group-default-rules.inc Part of bp:api-ref-in-rst Change-Id: I668b6cffaa76db781a75ed0896717b58d58623c5

2016年05月11日 21:07:54 +00:00

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

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

.. rest_parameters:: parameters.yaml

- from_port: from_port

- id: id

- ip_protocol: ip_protocol

- ip_range: ip_range

- cidr: cidr

- to_port: to_port

Method verification of os-security-group-default-rules Corrects the error status responses for os-security-group-default-rules.inc Part of bp:api-ref-in-rst Change-Id: I668b6cffaa76db781a75ed0896717b58d58623c5

2016年05月11日 21:07:54 +00:00

**Example Show default security group rule: 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

Method verification of os-security-group-default-rules Corrects the error status responses for os-security-group-default-rules.inc Part of bp:api-ref-in-rst Change-Id: I668b6cffaa76db781a75ed0896717b58d58623c5

2016年05月11日 21:07:54 +00:00

.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rules-show-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

Method verification of os-security-group-default-rules Corrects the error status responses for os-security-group-default-rules.inc Part of bp:api-ref-in-rst Change-Id: I668b6cffaa76db781a75ed0896717b58d58623c5

2016年05月11日 21:07:54 +00:00

Create Default Security Group Rule

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

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-security-group-default-rules

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

Method verification of os-security-group-default-rules Corrects the error status responses for os-security-group-default-rules.inc Part of bp:api-ref-in-rst Change-Id: I668b6cffaa76db781a75ed0896717b58d58623c5

2016年05月11日 21:07:54 +00:00

Creates a default security group rule.

If you specify a source port ( ``from_port`` ) or destination port ( ``to_port`` ) value, you must specify an

IP protocol ( ``ip_protocol`` ) value. Otherwise, the operation returns the ``Bad Request (400)`` response code.

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 40X and 50X from Normal response codes HTTP 40X-50X are not normal response codes at all. This patch removes them from api-ref. Part of bp:api-ref-in-rst Change-Id: I32a29c9e2a3d69720e3a88e17ba36fe45fa902d9

2016年04月18日 16:41:58 -07:00

Normal response codes: 200

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

Method verification of os-security-group-default-rules Corrects the error status responses for os-security-group-default-rules.inc Part of bp:api-ref-in-rst Change-Id: I668b6cffaa76db781a75ed0896717b58d58623c5

2016年05月11日 21:07:54 +00:00

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

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Request

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

-------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. rest_parameters:: parameters.yaml

Method verification of os-security-group-default-rules Corrects the error status responses for os-security-group-default-rules.inc Part of bp:api-ref-in-rst Change-Id: I668b6cffaa76db781a75ed0896717b58d58623c5

2016年05月11日 21:07:54 +00:00

- id: id

- ip_protocol: ip_protocol

- from_port: from_port

- to_port: to_port

- cidr: cidr

**Example Create default security group rule: JSON request**

.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rules-create-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

.. rest_parameters:: parameters.yaml

- from_port: from_port

- id: id

- ip_protocol: ip_protocol

- ip_range: ip_range

- cidr: cidr

- to_port: to_port

Method verification of os-security-group-default-rules Corrects the error status responses for os-security-group-default-rules.inc Part of bp:api-ref-in-rst Change-Id: I668b6cffaa76db781a75ed0896717b58d58623c5

2016年05月11日 21:07:54 +00:00

**Example Create default security group rule: 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

Method verification of os-security-group-default-rules Corrects the error status responses for os-security-group-default-rules.inc Part of bp:api-ref-in-rst Change-Id: I668b6cffaa76db781a75ed0896717b58d58623c5

2016年05月11日 21:07:54 +00:00

.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rules-create-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

Delete Default Security Group Rule

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

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-security-group-default-rules/{security_group_default_rule_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

Deletes a security group rule.

Remove 40X and 50X from Normal response codes HTTP 40X-50X are not normal response codes at all. This patch removes them from api-ref. Part of bp:api-ref-in-rst Change-Id: I32a29c9e2a3d69720e3a88e17ba36fe45fa902d9

2016年04月18日 16:41:58 -07:00

Normal response codes: 204

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

Method verification of os-security-group-default-rules Corrects the error status responses for os-security-group-default-rules.inc Part of bp:api-ref-in-rst Change-Id: I668b6cffaa76db781a75ed0896717b58d58623c5

2016年05月11日 21:07:54 +00:00

Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), notImplemented(501)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Request

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

-------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. rest_parameters:: parameters.yaml

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

--------

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

147 lines 3.8 KiB PHP Raw Normal View History Unescape Escape

147 lines

3.8 KiB

PHP

Raw Normal View History