openstack/nova
Code Issues Proposed changes

Method verification of os-security-group-default-rules

Browse Source 
Corrects the error status responses for
os-security-group-default-rules.inc

Part of bp:api-ref-in-rst

Change-Id: I668b6cffaa76db781a75ed0896717b58d58623c5
This commit is contained in:
Sujitha 2016-05-11 21:07:54 +00:00 committed by John Garbutt
parent 167a203d84
commit 05af505a1f
1 changed files with 41 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
api-ref/source/os-security-group-default-rules.inc
View File

@ -1,5 +1,4 @@
.. -*- rst -*-
.. needs:method_verification
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
@ -19,8 +18,7 @@ Lists default security group rules.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), notImplemented(501)
Request
-------
@ -46,6 +44,42 @@ Response
.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rules-list-resp.json
: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.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), notImplemented(501)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- security_group_default_rule_id: security_group_default_rule_id
Response
--------
.. 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**
.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rules-show-resp.json
:language: javascript
Create Default Security Group Rule
==================================
@ -53,12 +87,12 @@ Create Default Security Group Rule
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.
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.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Error response codes: badRequest(400), unauthorized(401), forbidden(403), conflict(409), notImplemented(501)
Request
-------
@ -94,43 +128,6 @@ Response
.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rules-create-resp.json
: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.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- security_group_default_rule_id: security_group_default_rule_id
Response
--------
.. 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**
.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rules-show-resp.json
:language: javascript
Delete Default Security Group Rule
==================================
@ -140,8 +137,7 @@ Deletes a security group rule.
Normal response codes: 204
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), notImplemented(501)
Request
-------