womax/nova
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix samples references in security group files

Browse Source 
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
This commit is contained in:
Sean Dague
2016-04-19 12:06:49 -04:00
parent 4e415274f3
commit c52b7c6a9e
3 changed files with 18 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api-ref/source/os-security-group-default-rules.inc
+3 -4
View File
@@ -70,7 +70,7 @@ Request
**Example Create default security group rule: JSON request**
.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rule-create-req.json
.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rules-create-req.json
:language: javascript
Response
@@ -87,7 +87,7 @@ Response
**Example Create default security group rule: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rule-create-resp.json
.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rules-create-resp.json
:language: javascript
Show Default Security Group Rule Details
@@ -124,7 +124,7 @@ Response
**Example Show default security group rule: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rule-show-resp.json
.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rules-show-resp.json
:language: javascript
Delete Default Security Group Rule
@@ -149,4 +149,3 @@ Request
Response
--------
api-ref/source/os-security-group-rules.inc
+8 -7
View File
@@ -32,10 +32,11 @@ Request
- cidr: cidr
- group_id: group_id
**Example Create security group rule: JSON request**
.. TODO(sdague): we currently have no samples here
**Example Create security group rule: JSON request**
.. literalinclude:: ../../doc/api_samples/os-security-group-rules/security-group-rule-create-req.json
:language: javascript
.. literalinclude:: ../../doc/api_samples/os-security-group-rules/security-group-rule-create-req.json
:language: javascript
Response
--------
@@ -53,10 +54,11 @@ Response
- parent_group_id: parent_group_id
- name: name
**Example Create security group rule: JSON response**
.. TODO(sdague): we currently have no samples here
**Example Create security group rule: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-group-rules/security-group-rule-create-resp.json
:language: javascript
.. literalinclude:: ../../doc/api_samples/os-security-group-rules/security-group-rule-create-resp.json
:language: javascript
Delete Security Group Rule
==========================
@@ -80,4 +82,3 @@ Request
Response
--------
api-ref/source/os-security-groups.inc
+7 -8
View File
@@ -39,7 +39,7 @@ Response
**Example List security groups: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-groups-list-resp.json
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-groups-list-get-resp.json
:language: javascript
Create Security Group
@@ -66,7 +66,7 @@ Request
**Example Create security group: JSON request**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-create-req.json
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-post-req.json
:language: javascript
Response
@@ -83,7 +83,7 @@ Response
**Example Create security group: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-create-resp.json
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-groups-create-resp.json
:language: javascript
Show Security Group Details
@@ -120,7 +120,7 @@ Response
**Example Show security group: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-show-resp.json
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-groups-get-resp.json
:language: javascript
Update Security Group
@@ -147,7 +147,7 @@ Request
**Example Update security group: JSON request**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-update-req.json
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-post-req.json
:language: javascript
Response
@@ -164,7 +164,7 @@ Response
**Example Update security group: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-update-resp.json
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-groups-create-resp.json
:language: javascript
Delete Security Group
@@ -224,6 +224,5 @@ Response
**Example List security groups by server: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-groups-list-resp.json
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-groups-list-get-resp.json
:language: javascript