openstack/api-site
Code Issues Proposed changes

Add DSCP markings to the API Guide

Browse Source 
This is to add DSCP marking rules to the API guide

Depends-On: Ic3baefe176df05f049a2e06529c58fd65fe6b419
Partial-Bug: #1468353

Change-Id: Ib92b172dce48276b90ec75ee5880ddd69040d7c8
This commit is contained in:
James Reeves 2016-02-02 10:08:10 -05:00
parent 5d4c1a279f
commit 65f6dc79e5
20 changed files with 292 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
api-ref/src/wadls/networking-api/src/common.ent
View File

@ -313,6 +313,17 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY dscp_rule_idTemplateParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="rule_id" style="template"
type="csapi:UUID">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The UUID of the DSCP rule.
</para>
</wadl:doc>
</param>'>
<!ENTITY security_group_idTemplateParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
required="true"
@ -903,6 +914,19 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY qos_policy_idRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
required="false" name="qos_policy_id" style="plain"
type="csapi:UUID">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Admin-only. The UUID of the QoS policy associated with this network.
The policy will need to have been created before the network to associate
it with.
</para>
</wadl:doc>
</param>'>
<!ENTITY admin_state_upResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
required="true"
@ -986,6 +1010,14 @@
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The UUID of the tenant.</para></wadl:doc>
</param>'>
<!ENTITY qos_policy_idResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
required="true" name="qos_policy_id" style="plain"
type="csapi:UUID">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The UUID of the QoS policy.</para></wadl:doc>
</param>'>
<!ENTITY tenant_idParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="tenant_id" style="plain" type="csapi:UUID">
@ -1074,6 +1106,48 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY dscp_marking_ruleObject '
<param xmlns="http://wadl.dev.java.net/2009/02"
required="true"
name="dscp_marking_rule" style="plain" type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
A <code>dscp_marking_rule</code> object.
</para>
</wadl:doc>
</param>'>
<!ENTITY dscp_marking_rulesObject '
<param xmlns="http://wadl.dev.java.net/2009/02"
required="true"
name="dscp_marking_rules" style="plain" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
A list of DSCP marking rule objects.
</para>
</wadl:doc>
</param>'>
<!ENTITY dscp_marking_rulesRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="dscp_marking_rules" style="plain" type="xsd:list">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
A list of DSCP marking rules associated with the QoS policy.
</para>
</wadl:doc>
</param>'>
<!ENTITY dscp_markRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="dscp_mark" style="plain" type="xsd:int">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The DSCP mark value.
</para>
</wadl:doc>
</param>'>
<!ENTITY qos-policyObjectParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="policy" style="plain" type="xsd:dict">
@ -1219,6 +1293,28 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY dscp_marking_rulesResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
required="true"
name="dscp_marking_rules" style="plain" type="xsd:list">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
A list of DSCP marking rules associated with the QoS policy.
</para>
</wadl:doc>
</param>'>
<!ENTITY dscp_markResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
required="true"
name="dscp_mark" style="plain" type="xsd:int">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The DSCP mark value.
</para>
</wadl:doc>
</param>'>
<!ENTITY qos-policy-descriptionResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
required="true" name="description" style="plain"

1
api-ref/src/wadls/networking-api/src/samples/networks/network-create-response.json
View File

@ -5,6 +5,7 @@
"name": "net1",
"admin_state_up": true,
"tenant_id": "9bacb3c5d39d41a79512987f338cf177",
"qos_policy_id": "6a8454ade84346f59e8d40665f878b2e",
"router:external": false,
"mtu": 0,
"shared": false,

1
api-ref/src/wadls/networking-api/src/samples/networks/network-multi-create-response.json
View File

@ -5,6 +5,7 @@
"name": "net1",
"admin_state_up": true,
"tenant_id": "9bacb3c5d39d41a79512987f338cf177",
"qos_policy_id": "6a8454ade84346f59e8d40665f878b2e",
"segments": [
{
"provider:segmentation_id": 2,

1
api-ref/src/wadls/networking-api/src/samples/networks/network-show-response.json
View File

@ -8,6 +8,7 @@
"router:external": false,
"admin_state_up": true,
"tenant_id": "4fd44f30292945e481c7b8a0c8908869",
"qos_policy_id": "6a8454ade84346f59e8d40665f878b2e",
"created_at": "2016-03-08T20:19:41",
"mtu": 0,
"shared": true,

1
api-ref/src/wadls/networking-api/src/samples/networks/network-update-response.json
View File

@ -6,6 +6,7 @@
"provider:physical_network": null,
"admin_state_up": true,
"tenant_id": "4fd44f30292945e481c7b8a0c8908869",
"qos_policy_id": "6a8454ade84346f59e8d40665f878b2e",
"provider:network_type": "local",
"router:external": false,
"mtu": 0,

2
api-ref/src/wadls/networking-api/src/samples/networks/networks-bulk-create-response.json
View File

@ -7,6 +7,7 @@
"provider:physical_network": null,
"admin_state_up": true,
"tenant_id": "4fd44f30292945e481c7b8a0c8908869",
"qos_policy_id": "6a8454ade84346f59e8d40665f878b2e",
"mtu": 0,
"shared": false,
"id": "bc1a76cb-8767-4c3a-bb95-018b822f2130",
@ -19,6 +20,7 @@
"provider:physical_network": null,
"admin_state_up": true,
"tenant_id": "4fd44f30292945e481c7b8a0c8908869",
"qos_policy_id": "6a8454ade84346f59e8d40665f878b2e",
"mtu": 0,
"shared": false,
"id": "af374017-c9ae-4a1d-b799-ab73111476e2",

2
api-ref/src/wadls/networking-api/src/samples/networks/networks-list-response.json
View File

@ -9,6 +9,7 @@
"provider:physical_network": null,
"admin_state_up": true,
"tenant_id": "4fd44f30292945e481c7b8a0c8908869",
"qos_policy_id": "6a8454ade84346f59e8d40665f878b2e",
"provider:network_type": "local",
"router:external": true,
"mtu": 0,
@ -25,6 +26,7 @@
"provider:physical_network": null,
"admin_state_up": true,
"tenant_id": "26a7980765d0414dbc1fc1f88cdb7e6e",
"qos_policy_id": "bfdb6c39f71e4d44b1dfbda245c50819",
"provider:network_type": "local",
"router:external": true,
"mtu": 0,

2
api-ref/src/wadls/networking-api/src/samples/networks/networks-multi-list-response.json
View File

@ -6,6 +6,7 @@
"name": "net1",
"admin_state_up": true,
"tenant_id": "9bacb3c5d39d41a79512987f338cf177",
"qos_policy_id": "6a8454ade84346f59e8d40665f878b2e",
"segments": [
{
"provider:segmentation_id": 2,
@ -32,6 +33,7 @@
"router:external": true,
"admin_state_up": true,
"tenant_id": "26a7980765d0414dbc1fc1f88cdb7e6e",
"qos_policy_id": "bfdb6c39f71e4d44b1dfbda245c50819",
"provider:network_type": "local",
"shared": true,
"id": "db193ab3-96e3-4cb3-8fc5-05f4296d0324",

1
api-ref/src/wadls/networking-api/src/samples/networks/networks-multi-show-response.json
View File

@ -5,6 +5,7 @@
"name": "net1",
"admin_state_up": true,
"tenant_id": "9bacb3c5d39d41a79512987f338cf177",
"qos_policy_id": "6a8454ade84346f59e8d40665f878b2e",
"segments": [
{
"provider:segmentation_id": 2,

5
api-ref/src/wadls/networking-api/src/samples/qos/dscp_marking_rule-create-request.json Normal file
View File

@ -0,0 +1,5 @@
{
"dscp_marking_rule": {
"dscp_mark": "26"
}
}

7
api-ref/src/wadls/networking-api/src/samples/qos/dscp_marking_rule-create-response.json Normal file
View File

@ -0,0 +1,7 @@
{
"dscp_marking_rule": {
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c794",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"dscp_mark": "26"
}
}

7
api-ref/src/wadls/networking-api/src/samples/qos/dscp_marking_rule-show-response.json Normal file
View File

@ -0,0 +1,7 @@
{
"dscp_marking_rule": {
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c794",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"dscp_mark": "26"
}
}

5
api-ref/src/wadls/networking-api/src/samples/qos/dscp_marking_rule-update-request.json Normal file
View File

@ -0,0 +1,5 @@
{
"dscp_marking_rule": {
"dscp_mark": "16"
}
}

7
api-ref/src/wadls/networking-api/src/samples/qos/dscp_marking_rule-update-response.json Normal file
View File

@ -0,0 +1,7 @@
{
"dscp_marking_rule": {
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c794",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"dscp_mark": "16"
}
}

9
api-ref/src/wadls/networking-api/src/samples/qos/dscp_marking_rules-list-response.json Normal file
View File

@ -0,0 +1,9 @@
{
"dscp_marking_rules": [
{
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c794",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"dscp_mark": "26"
}
]
}

7
api-ref/src/wadls/networking-api/src/samples/qos/policies-list-response.json
View File

@ -13,6 +13,13 @@
"max_kbps": "10000",
"max_burst_kbps": "0"
}
],
"dscp_marking_rules": [
{
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c794",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"dscp_mark": "26"
}
]
}
]

7
api-ref/src/wadls/networking-api/src/samples/qos/policy-show-response.json
View File

@ -12,6 +12,13 @@
"max_kbps": "10000",
"max_burst_kbps": "0"
}
],
"dscp_marking_rules": [
{
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c794",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"dscp_mark": "26"
}
]
}
}

3
api-ref/src/wadls/networking-api/src/samples/qos/rule_types-list-response.json
View File

@ -2,6 +2,9 @@
"rule_types": [
{
"type": "bandwidth_limit"
},
{
"type": "dscp_marking"
}
]
}

5
api-ref/src/wadls/networking-api/src/wadl/networks.wadl
View File

@ -140,6 +140,7 @@
&statusResponseParameter;
&subnetsResponseParameter;
&tenant_idResponseParameter;
&qos_policy_idResponseParameter;
&router-externalResponseParameter;
&mtuResponseParameter;
&availability_zonesResponseParameter;
@ -167,6 +168,7 @@
&nameRequestParameter;
&sharedRequestParameter;
&tenant_idRequestParameter;
&qos_policy_idRequestParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" required="false" name="router:external" style="plain"
type="xsd:boolean">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -197,6 +199,7 @@
&statusResponseParameter;
&subnetsResponseParameter;
&tenant_idResponseParameter;
&qos_policy_idResponseParameter;
&router-externalResponseParameter;
&mtuResponseParameter;
&availability_zonesResponseParameter;
@ -273,6 +276,7 @@
&statusResponseParameter;
&subnetsResponseParameter;
&tenant_idResponseParameter;
&qos_policy_idResponseParameter;
&router-externalResponseParameter;
&updated_atResponseParameter;
&mtuResponseParameter;
@ -317,6 +321,7 @@
&statusResponseParameter;
&subnetsResponseParameter;
&tenant_idResponseParameter;
&qos_policy_idResponseParameter;
&router-externalResponseParameter;
&mtuResponseParameter;
&availability_zonesResponseParameter;

123
api-ref/src/wadls/networking-api/src/wadl/qos.wadl
View File

@ -44,6 +44,16 @@
<method href="#deleteBandwidthLimitRule"/>
</resource>
</resource>
<resource id="dscp_marking_rules" path="dscp_marking_rules">
<method href="#listDscpMarkingRules"/>
<method href="#createDscpMarkingRule"/>
<resource id="dscp_rule_id" path="{dscp_rule_id}">
&rule_idTemplateParameter;
<method href="#showDscpMarkingRule"/>
<method href="#updateDscpMarkingRule"/>
<method href="#deleteDscpMarkingRule"/>
</resource>
</resource>
</resource>
</resource>
</resource>
@ -75,10 +85,12 @@
&qos-policy-descriptionResponseParameter;
&qos-policy-sharedResponseParameter;
&bandwidth_limit_rulesResponseParameter;
&dscp_marking_rulesResponseParameter;
&qos-policy-rule-idResponseParameter;
&qos-policy-rule-policy_idResponseParameter;
&max_kbpsResponseParameter;
&max_burst_kbpsResponseParameter;
&dscp_markResponseParameter;
</representation>
</response> &fault401; &fault500; &fault503;
</method>
@ -148,10 +160,12 @@
&qos-policy-descriptionResponseParameter;
&qos-policy-sharedResponseParameter;
&bandwidth_limit_rulesResponseParameter;
&dscp_marking_rulesResponseParameter;
&qos-policy-rule-idResponseParameter;
&qos-policy-rule-policy_idResponseParameter;
&max_kbpsResponseParameter;
&max_burst_kbpsResponseParameter;
&dscp_markResponseParameter;
</representation>
</response> &fault401; &fault500; &fault503;
</method>
@ -315,4 +329,113 @@
</wadl:doc>
<response status="204"/> &fault400; &fault401; &fault413; &fault500; &fault503;
</method>
<method name="GET" id="listDscpMarkingRules">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="List DSCP marking rules for QoS policy">
<para role="shortdesc">
Lists all DSCP marking rules for a QoS policy.
</para>
<para>
The list may be empty.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/qos/dscp_marking_rules-list-response.json"/>
</wadl:doc>
&dscp_marking_rulesResponseParameter;
&qos-policy-rule-idResponseParameter;
&qos-policy-rule-policy_idResponseParameter;
&dscp_markResponseParameter;
</representation>
</response> &fault401; &fault500; &fault503;
</method>
<method name="POST" id="createDscpMarkingRule">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create DSCP marking rule">
<para role="shortdesc">
Creates a DSCP marking rule for a QoS policy.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/qos/dscp_marking_rule-create-request.json"/>
</wadl:doc>
&dscp_marking_ruleObject;
&qos-policy-rule-policy_idRequestParameter;
&dscp_markRequestParameter;
</representation>
</request>
<response status="201">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/qos/dscp_marking_rule-create-response.json"/>
</wadl:doc>
&dscp_marking_ruleObject;
&qos-policy-rule-idResponseParameter;
&qos-policy-rule-policy_idResponseParameter;
&dscp_markResponseParameter;
</representation>
</response> &fault401; &fault404; &fault409; &fault413; &fault500; &fault503;
</method>
<method name="GET" id="showDscpMarkingRule">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Show DSCP marking rule details">
<para role="shortdesc">
Shows details for a DSCP marking rule for a QoS policy.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/qos/dscp_marking_rule-show-response.json"/>
</wadl:doc>
&dscp_marking_ruleObject;
&qos-policy-rule-idResponseParameter;
&qos-policy-rule-policy_idResponseParameter;
&dscp_markResponseParameter;
</representation>
</response> &fault401; &fault500; &fault503;
</method>
<method name="PUT" id="updateDscpMarkingRule">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update DSCP marking rule">
<para role="shortdesc">
Updates a DSCP marking rule for a QoS policy.
</para>
<para>
If the request is valid, the service returns the
<code>Accepted (202)</code> response code.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/qos/dscp_marking_rule-update-request.json"/>
</wadl:doc>
&dscp_marking_ruleObject;
&qos-policy-rule-policy_idRequestParameter;
&dscp_markRequestParameter;
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/qos/dscp_marking_rule-update-response.json"/>
</wadl:doc>
&dscp_marking_ruleObject;
&qos-policy-rule-idResponseParameter;
&qos-policy-rule-policy_idResponseParameter;
&dscp_markResponseParameter;
</representation>
</response> &fault400; &fault401; &fault413; &fault500; &fault503;
</method>
<method name="DELETE" id="deleteDscpMarkingRule">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete DSCP marking rule">
<para role="shortdesc">
Deletes a DSCP marking rule for a QoS policy.
</para>
</wadl:doc>
<response status="204"/> &fault400; &fault401; &fault413; &fault500; &fault503;
</method>
</application>