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
parent f1fa7eb15a
commit d4e2771440
58 changed files with 8201 additions and 3 deletions
@@ -0,0 +1,83 @@
+.. -*- rst -*-
+
+====================================================
+ 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
+^^^^^^^
+
+.. 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
+
+**Example Create security group rule: JSON request**
+
+.. literalinclude:: ../../doc/api_samples/os-security-group-rules/security-group-rule-create-req.json
+   :language: javascript
+
+Response
+^^^^^^^^
+
+.. 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
+
+**Example Create security group rule: JSON response**
+
+.. literalinclude:: ../../doc/api_samples/os-security-group-rules/security-group-rule-create-resp.json
+   :language: javascript
+
+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
+^^^^^^^
+
+.. rest_parameters:: parameters.yaml
+
+  - tenant_id: tenant_id
+  - security_group_rule_id: security_group_rule_id
+
+Response
+^^^^^^^^
+