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

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

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

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

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

List Default Security Group Rules

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

.. rest_method:: GET /v2.1/{tenant_id}/os-security-group-default-rules

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

Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),

unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)

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

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

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

Create Default Security Group Rule

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

.. rest_method:: POST /v2.1/{tenant_id}/os-security-group-default-rules

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.

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

Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),

unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)

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

- tenant_id: tenant_id

- id: id

- ip_protocol: ip_protocol

- from_port: from_port

- to_port: to_port

- cidr: cidr

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

fix samples references in security group files This fixes the samples references in the security group files, commenting out 2 that don't exist at all. This drops the warnings to 145 against current master. Part of bp:api-ref-in-rst Change-Id: I0cb9932dc54cdffcbd9eda274a06d708e87409d8

2016年04月19日 12:06:49 -04:00

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

.. 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 Create default security group rule: JSON response**

fix samples references in security group files This fixes the samples references in the security group files, commenting out 2 that don't exist at all. This drops the warnings to 145 against current master. Part of bp:api-ref-in-rst Change-Id: I0cb9932dc54cdffcbd9eda274a06d708e87409d8

2016年04月19日 12:06:49 -04: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

Show Default Security Group Rule Details

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

.. rest_method:: GET /v2.1/{tenant_id}/os-security-group-default-rules/{security_group_default_rule_id}

Shows details for 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: 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

Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),

unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)

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

- tenant_id: tenant_id

- 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

--------

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

fix samples references in security group files This fixes the samples references in the security group files, commenting out 2 that don't exist at all. This drops the warnings to 145 against current master. Part of bp:api-ref-in-rst Change-Id: I0cb9932dc54cdffcbd9eda274a06d708e87409d8

2016年04月19日 12:06:49 -04: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

Delete Default Security Group Rule

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

.. rest_method:: DELETE /v2.1/{tenant_id}/os-security-group-default-rules/{security_group_default_rule_id}

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

Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),

unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)

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

- tenant_id: tenant_id

- 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

152 lines 3.9 KiB PHP Raw Normal View History Unescape Escape

152 lines

3.9 KiB

PHP

Raw Normal View History