diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml index 70448f7cb..997fcf465 100644 --- a/api-ref/source/v2/parameters.yaml +++ b/api-ref/source/v2/parameters.yaml @@ -4183,6 +4183,18 @@ router-routes-request: in: body required: false type: array +router-service_type_id: + description: | + The ID of the service type associated with the router. + in: body + required: true + type: string +router-service_type_id-request: + description: | + The ID of the service type associated with the router. + in: body + required: false + type: string router-status: description: | The router status. diff --git a/api-ref/source/v2/routers.inc b/api-ref/source/v2/routers.inc index fa47f988d..4f6077d3a 100644 --- a/api-ref/source/v2/routers.inc +++ b/api-ref/source/v2/routers.inc @@ -31,6 +31,14 @@ and ``availability_zone_hints`` attributes to ``routers``, allowing scheduling based on availability zones and hints. This extension requires ``router`` and ``availability_zone`` extensions. +Router service type extension (``router-service-type``) +======================================================= + +The ``router-service-type`` extension enables associating a service type with a +router by introducing the ``service_type_id`` parameter that can be +used to associate the router with an existing ``service-provider``, +see `Service providers`_. + List routers ============ @@ -95,6 +103,7 @@ Response Parameters - ha: router-ha - availability_zone_hints: router-availability_zone_hints - availability_zones: router-availability_zones + - service_type_id: router-service_type_id Response Example ---------------- @@ -141,6 +150,7 @@ Request - distributed: router-distributed-request - ha: router-ha-request - availability_zone_hints: router-availability_zone_hints-request + - service_type_id: router-service_type_id-request Request Example --------------- @@ -173,6 +183,7 @@ Response Parameters - ha: router-ha - availability_zone_hints: router-availability_zone_hints - availability_zones: router-availability_zones + - service_type_id: router-service_type_id Response Example ---------------- @@ -230,6 +241,7 @@ Response Parameters - ha: router-ha - availability_zone_hints: router-availability_zone_hints - availability_zones: router-availability_zones + - service_type_id: router-service_type_id Response Example ---------------- @@ -299,6 +311,7 @@ Response Parameters - ha: router-ha - availability_zone_hints: router-availability_zone_hints - availability_zones: router-availability_zones + - service_type_id: router-service_type_id Response Example ---------------- diff --git a/api-ref/source/v2/samples/routers/router-create-response.json b/api-ref/source/v2/samples/routers/router-create-response.json index 18ae8041c..2d4179244 100644 --- a/api-ref/source/v2/samples/routers/router-create-response.json +++ b/api-ref/source/v2/samples/routers/router-create-response.json @@ -24,6 +24,7 @@ "revision_number": 1, "status": "ACTIVE", "project_id": "0bd18306d801447bb457a46252d82d13", - "tenant_id": "0bd18306d801447bb457a46252d82d13" + "tenant_id": "0bd18306d801447bb457a46252d82d13", + "service_type_id": null } } diff --git a/api-ref/source/v2/samples/routers/router-show-response.json b/api-ref/source/v2/samples/routers/router-show-response.json index e4519ee14..20b88f23f 100644 --- a/api-ref/source/v2/samples/routers/router-show-response.json +++ b/api-ref/source/v2/samples/routers/router-show-response.json @@ -33,6 +33,7 @@ ], "status": "ACTIVE", "project_id": "0bd18306d801447bb457a46252d82d13", - "tenant_id": "0bd18306d801447bb457a46252d82d13" + "tenant_id": "0bd18306d801447bb457a46252d82d13", + "service_type_id": null } } diff --git a/api-ref/source/v2/samples/routers/router-update-response.json b/api-ref/source/v2/samples/routers/router-update-response.json index 972ed2337..6e806f3b8 100644 --- a/api-ref/source/v2/samples/routers/router-update-response.json +++ b/api-ref/source/v2/samples/routers/router-update-response.json @@ -29,6 +29,7 @@ ], "status": "ACTIVE", "project_id": "0bd18306d801447bb457a46252d82d13", - "tenant_id": "0bd18306d801447bb457a46252d82d13" + "tenant_id": "0bd18306d801447bb457a46252d82d13", + "service_type_id": null } } diff --git a/api-ref/source/v2/samples/routers/routers-list-response.json b/api-ref/source/v2/samples/routers/routers-list-response.json index 7e50eac9b..f16cf6190 100644 --- a/api-ref/source/v2/samples/routers/routers-list-response.json +++ b/api-ref/source/v2/samples/routers/routers-list-response.json @@ -34,7 +34,8 @@ ], "status": "ACTIVE", "project_id": "0bd18306d801447bb457a46252d82d13", - "tenant_id": "0bd18306d801447bb457a46252d82d13" + "tenant_id": "0bd18306d801447bb457a46252d82d13", + "service_type_id": null }, { "admin_state_up": true, @@ -65,7 +66,8 @@ "routes": [], "status": "ACTIVE", "project_id": "0bd18306d801447bb457a46252d82d13", - "tenant_id": "0bd18306d801447bb457a46252d82d13" + "tenant_id": "0bd18306d801447bb457a46252d82d13", + "service_type_id": null } ] }