diff --git a/api-ref/source/v2/auto-topology.inc b/api-ref/source/v2/auto-topology.inc new file mode 100644 index 000000000..53feeab5f --- /dev/null +++ b/api-ref/source/v2/auto-topology.inc @@ -0,0 +1,73 @@ +.. -*- rst -*- + +========================= +Auto Allocated Topologies +========================= + +Show details and delete the auto allocated topology for a given project. +This API is only available when the ``auto-allocated-topology`` extension +is enabled. + + +Show auto allocated topology details +==================================== + +.. rest_method:: GET /v2.0/auto-allocated-topology/{project_id} + +Shows details for an auto allocated topology. + +Use the ``fields`` query parameter to control which fields are +returned in the response body. For information, see `Filtering and +Column Selection `__. + +Normal response codes: 200 + +Error response codes: 401, 404 + +Request +------- + +.. rest_parameters:: parameters.yaml + + - project_id: project_id-path + - fields: fields + +Response Parameters +------------------- + +.. rest_parameters:: parameters.yaml + + - id: id_autotopology + - tenant_id: project_id-autotopology + +Response Example +---------------- + +.. literalinclude:: samples/auto-topology/topo-show-response.json + :language: javascript + + +Delete the auto allocated topology +================================== + +.. rest_method:: DELETE /v2.0/auto-allocated-topology/{project_id} + +Deletes the auto allocated topology. + +Normal response codes: 204 + +Error response codes: 401, 403, 404 + +Request +------- + +.. rest_parameters:: parameters.yaml + + - project_id: project_id-path + +Response +-------- + +There is no body content for the response of a successful DELETE request. diff --git a/api-ref/source/v2/index.rst b/api-ref/source/v2/index.rst index 3a0be4ae3..4cf00fac2 100644 --- a/api-ref/source/v2/index.rst +++ b/api-ref/source/v2/index.rst @@ -84,3 +84,7 @@ Logging Networking Agents ################# .. include:: agents.inc +####################### +Auto Allocated Topology +####################### +.. include:: auto-topology.inc diff --git a/api-ref/source/v2/networks.inc b/api-ref/source/v2/networks.inc index c8ed1a55c..2b8af67b8 100644 --- a/api-ref/source/v2/networks.inc +++ b/api-ref/source/v2/networks.inc @@ -88,6 +88,12 @@ The ``external-net`` extension adds the ``router:external`` attribute to networks. This boolean attribute indicates the network has an external routing facility that's not managed by the networking service. +Auto Allocated Topology +======================= + +The ``auto-allocated-topology`` extension adds the ``is_default`` boolean +attribute to networks. This value indicates the network should be used when +auto allocating topologies. Show network details ==================== @@ -144,6 +150,7 @@ Response Parameters - updated_at: updated_at_resource - vlan_transparent: vlan_transparent - description: description + - is_default: network_is_default Response Example ---------------- @@ -194,6 +201,7 @@ Request - segments: segments - shared: network-shared-request - description: description-request + - is_default: network_is_default-request Request Example --------------- @@ -240,6 +248,7 @@ Response Parameters - subnets: network-subnets - tenant_id: project_id - description: description + - is_default: network_is_default Response Example ---------------- @@ -339,6 +348,7 @@ Response Parameters - tenant_id: project_id - vlan_transparent: vlan_transparent - description: description + - is_default: network_is_default Response Example ---------------- @@ -394,6 +404,7 @@ Request - tenant_id: project_id-request - vlan_transparent: vlan_transparent-request - description: description-request + - is_default: network_is_default-request Request Example --------------- @@ -441,6 +452,7 @@ Response Parameters - tenant_id: project_id - vlan_transparent: vlan_transparent - description: description + - is_default: network_is_default Response Example ---------------- @@ -533,6 +545,7 @@ Response Parameters - tenant_id: project_id - vlan_transparent: vlan_transparent - description: description + - is_default: network_is_default Response Example ---------------- diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml index 77cdad674..85004fc3a 100644 --- a/api-ref/source/v2/parameters.yaml +++ b/api-ref/source/v2/parameters.yaml @@ -2954,6 +2954,12 @@ id_9: in: body required: true type: string +id_autotopology: + description: | + The ID of the network for the auto allocated topology. + in: body + required: true + type: string id_resource: description: | The ID for the resource. @@ -4065,6 +4071,18 @@ network_ip_availability-subnet_id: in: body required: true type: string +network_is_default: + description: | + The network is default pool or not. + in: body + required: true + type: boolean +network_is_default-request: + description: | + The network is default or not. + in: body + required: false + type: boolean network_type: description: | The type of physical network that maps to this @@ -4374,6 +4392,12 @@ project_id: in: body required: true type: string +project_id-autotopology: + description: | + The ID of the project owning the auto allocated topology. + in: body + required: true + type: string project_id-body-optional: description: | The ID of the project that owns the resource. diff --git a/api-ref/source/v2/samples/auto-topology/topo-show-response.json b/api-ref/source/v2/samples/auto-topology/topo-show-response.json new file mode 100644 index 000000000..0d586948f --- /dev/null +++ b/api-ref/source/v2/samples/auto-topology/topo-show-response.json @@ -0,0 +1,4 @@ +{ + "id": "31483d41-5c2b-481c-beef-ab501bd2e0da", + "tenant_id": "7623217f-dd15-44ec-994a-581a6e41c113" +} diff --git a/api-ref/source/v2/samples/networks/network-create-response.json b/api-ref/source/v2/samples/networks/network-create-response.json index a6a59be9f..72b7e615f 100644 --- a/api-ref/source/v2/samples/networks/network-create-response.json +++ b/api-ref/source/v2/samples/networks/network-create-response.json @@ -21,6 +21,7 @@ "tenant_id": "9bacb3c5d39d41a79512987f338cf177", "updated_at": "2016-03-08T20:19:41", "vlan_transparent": false, - "description": "" + "description": "", + "is_default": false } } diff --git a/api-ref/source/v2/samples/networks/network-multi-create-response.json b/api-ref/source/v2/samples/networks/network-multi-create-response.json index 1aff0ba43..d0927de54 100644 --- a/api-ref/source/v2/samples/networks/network-multi-create-response.json +++ b/api-ref/source/v2/samples/networks/network-multi-create-response.json @@ -25,6 +25,7 @@ ], "shared": false, "id": "4e8e5957-649f-477b-9e5b-f1f75b21c03c", - "description": "" + "description": "", + "is_default": false } } diff --git a/api-ref/source/v2/samples/networks/network-multi-show-response.json b/api-ref/source/v2/samples/networks/network-multi-show-response.json index 428677b99..c412fe3ed 100644 --- a/api-ref/source/v2/samples/networks/network-multi-show-response.json +++ b/api-ref/source/v2/samples/networks/network-multi-show-response.json @@ -35,6 +35,7 @@ "tenant_id": "4fd44f30292945e481c7b8a0c8908869", "updated_at": "2016-03-08T20:19:41", "vlan_transparent": false, - "description": "" + "description": "", + "is_default": false } } diff --git a/api-ref/source/v2/samples/networks/network-provider-create-response.json b/api-ref/source/v2/samples/networks/network-provider-create-response.json index 04d198167..a2d5486bc 100644 --- a/api-ref/source/v2/samples/networks/network-provider-create-response.json +++ b/api-ref/source/v2/samples/networks/network-provider-create-response.json @@ -18,6 +18,7 @@ "id": "4e8e5957-649f-477b-9e5b-f1f75b21c03c", "provider:segmentation_id": 2, "description": "", - "port_security_enabled": true + "port_security_enabled": true, + "is_default": false } } diff --git a/api-ref/source/v2/samples/networks/network-provider-show-response.json b/api-ref/source/v2/samples/networks/network-provider-show-response.json index 1462e0de8..308edd45f 100644 --- a/api-ref/source/v2/samples/networks/network-provider-show-response.json +++ b/api-ref/source/v2/samples/networks/network-provider-show-response.json @@ -26,6 +26,7 @@ "tenant_id": "4fd44f30292945e481c7b8a0c8908869", "updated_at": "2016-03-08T20:19:41", "vlan_transparent": false, - "description": "" + "description": "", + "is_default": true } } diff --git a/api-ref/source/v2/samples/networks/network-show-response.json b/api-ref/source/v2/samples/networks/network-show-response.json index 97f5a95a9..0c35d332a 100644 --- a/api-ref/source/v2/samples/networks/network-show-response.json +++ b/api-ref/source/v2/samples/networks/network-show-response.json @@ -23,6 +23,7 @@ "tenant_id": "4fd44f30292945e481c7b8a0c8908869", "updated_at": "2016-03-08T20:19:41", "vlan_transparent": false, - "description": "" + "description": "", + "is_default": true } } diff --git a/api-ref/source/v2/samples/networks/network-update-response.json b/api-ref/source/v2/samples/networks/network-update-response.json index 42ac15373..69b70f527 100644 --- a/api-ref/source/v2/samples/networks/network-update-response.json +++ b/api-ref/source/v2/samples/networks/network-update-response.json @@ -23,6 +23,7 @@ "tenant_id": "4fd44f30292945e481c7b8a0c8908869", "updated_at": "2016-03-08T20:19:41", "vlan_transparent": false, - "description": "" + "description": "", + "is_default": false } } diff --git a/api-ref/source/v2/samples/networks/networks-bulk-create-response.json b/api-ref/source/v2/samples/networks/networks-bulk-create-response.json index e7e2d6c54..bed8ee6d9 100644 --- a/api-ref/source/v2/samples/networks/networks-bulk-create-response.json +++ b/api-ref/source/v2/samples/networks/networks-bulk-create-response.json @@ -22,7 +22,8 @@ "updated_at": "2016-03-08T20:19:41", "vlan_transparent": false, "description": "", - "port_security_enabled": true + "port_security_enabled": true, + "is_default": false }, { "admin_state_up": true, @@ -46,7 +47,8 @@ "updated_at": "2016-03-08T20:19:41", "vlan_transparent": false, "description": "", - "port_security_enabled": true + "port_security_enabled": true, + "is_default": false } ] } diff --git a/api-ref/source/v2/samples/networks/networks-list-response.json b/api-ref/source/v2/samples/networks/networks-list-response.json index 5fa459c32..de675d792 100644 --- a/api-ref/source/v2/samples/networks/networks-list-response.json +++ b/api-ref/source/v2/samples/networks/networks-list-response.json @@ -24,7 +24,8 @@ "tenant_id": "4fd44f30292945e481c7b8a0c8908869", "updated_at": "2016-03-08T20:19:41", "vlan_transparent": true, - "description": "" + "description": "", + "is_default": false }, { "admin_state_up": true, @@ -49,7 +50,8 @@ "tenant_id": "26a7980765d0414dbc1fc1f88cdb7e6e", "updated_at": "2016-03-08T20:19:41", "vlan_transparent": false, - "description": "" + "description": "", + "is_default": false } ] } diff --git a/api-ref/source/v2/samples/networks/networks-provider-list-response.json b/api-ref/source/v2/samples/networks/networks-provider-list-response.json index 8138fbdce..e4c75a413 100644 --- a/api-ref/source/v2/samples/networks/networks-provider-list-response.json +++ b/api-ref/source/v2/samples/networks/networks-provider-list-response.json @@ -26,7 +26,8 @@ "tenant_id": "4fd44f30292945e481c7b8a0c8908869", "updated_at": "2016-03-08T20:19:41", "vlan_transparent": true, - "description": "" + "description": "", + "is_default": false }, { "admin_state_up": true, @@ -66,7 +67,8 @@ "tenant_id": "26a7980765d0414dbc1fc1f88cdb7e6e", "updated_at": "2016-03-08T20:19:41", "vlan_transparent": false, - "description": "" + "description": "", + "is_default": false } ] }