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

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

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

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

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

Creates and deletes security group rules.

Create Security Group Rule

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

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

Creates a rule for a security group.

Normal response codes: 200

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

- parent_group_id: parent_group_id

- ip_protocol: ip_protocol

- from_port: from_port

- to_port: to_port

- cidr: cidr

- group_id: group_id

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

.. TODO(sdague): we currently have no samples here

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

- security_group_rule: security_group_rule

- ip_protocol: ip_protocol

- from_port: from_port

- to_port: to_port

- ip_range: ip_range

- cidr: cidr

- id: id

- group: group

- parent_group_id: parent_group_id

- name: name

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

.. TODO(sdague): we currently have no samples here

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

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-rules/security-group-rule-create-resp.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

Delete Security Group Rule

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

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

Deletes a security group rule.

Normal response codes: 202

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

89 lines 2.2 KiB PHP Raw Normal View History Unescape Escape

89 lines

2.2 KiB

PHP

Raw Normal View History