Documenting Router service type ID
Closes-Bug: #1733390 Change-Id: I83a0525d73858178d600f3844cc6780d4d5ca738 Signed-off-by: Michal Kelner Mishali <mkelnermishal@vmware.com>
This commit is contained in:
parent
ec9e38de5a
commit
4cdf339a0b
|
@ -4183,6 +4183,18 @@ router-routes-request:
|
||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: array
|
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:
|
router-status:
|
||||||
description: |
|
description: |
|
||||||
The router status.
|
The router status.
|
||||||
|
|
|
@ -31,6 +31,14 @@ and ``availability_zone_hints`` attributes to ``routers``, allowing scheduling
|
||||||
based on availability zones and hints.
|
based on availability zones and hints.
|
||||||
This extension requires ``router`` and ``availability_zone`` extensions.
|
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
|
List routers
|
||||||
============
|
============
|
||||||
|
|
||||||
|
@ -95,6 +103,7 @@ Response Parameters
|
||||||
- ha: router-ha
|
- ha: router-ha
|
||||||
- availability_zone_hints: router-availability_zone_hints
|
- availability_zone_hints: router-availability_zone_hints
|
||||||
- availability_zones: router-availability_zones
|
- availability_zones: router-availability_zones
|
||||||
|
- service_type_id: router-service_type_id
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
@ -141,6 +150,7 @@ Request
|
||||||
- distributed: router-distributed-request
|
- distributed: router-distributed-request
|
||||||
- ha: router-ha-request
|
- ha: router-ha-request
|
||||||
- availability_zone_hints: router-availability_zone_hints-request
|
- availability_zone_hints: router-availability_zone_hints-request
|
||||||
|
- service_type_id: router-service_type_id-request
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
@ -173,6 +183,7 @@ Response Parameters
|
||||||
- ha: router-ha
|
- ha: router-ha
|
||||||
- availability_zone_hints: router-availability_zone_hints
|
- availability_zone_hints: router-availability_zone_hints
|
||||||
- availability_zones: router-availability_zones
|
- availability_zones: router-availability_zones
|
||||||
|
- service_type_id: router-service_type_id
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
@ -230,6 +241,7 @@ Response Parameters
|
||||||
- ha: router-ha
|
- ha: router-ha
|
||||||
- availability_zone_hints: router-availability_zone_hints
|
- availability_zone_hints: router-availability_zone_hints
|
||||||
- availability_zones: router-availability_zones
|
- availability_zones: router-availability_zones
|
||||||
|
- service_type_id: router-service_type_id
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
@ -299,6 +311,7 @@ Response Parameters
|
||||||
- ha: router-ha
|
- ha: router-ha
|
||||||
- availability_zone_hints: router-availability_zone_hints
|
- availability_zone_hints: router-availability_zone_hints
|
||||||
- availability_zones: router-availability_zones
|
- availability_zones: router-availability_zones
|
||||||
|
- service_type_id: router-service_type_id
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
|
@ -24,6 +24,7 @@
|
||||||
"revision_number": 1,
|
"revision_number": 1,
|
||||||
"status": "ACTIVE",
|
"status": "ACTIVE",
|
||||||
"project_id": "0bd18306d801447bb457a46252d82d13",
|
"project_id": "0bd18306d801447bb457a46252d82d13",
|
||||||
"tenant_id": "0bd18306d801447bb457a46252d82d13"
|
"tenant_id": "0bd18306d801447bb457a46252d82d13",
|
||||||
|
"service_type_id": null
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -33,6 +33,7 @@
|
||||||
],
|
],
|
||||||
"status": "ACTIVE",
|
"status": "ACTIVE",
|
||||||
"project_id": "0bd18306d801447bb457a46252d82d13",
|
"project_id": "0bd18306d801447bb457a46252d82d13",
|
||||||
"tenant_id": "0bd18306d801447bb457a46252d82d13"
|
"tenant_id": "0bd18306d801447bb457a46252d82d13",
|
||||||
|
"service_type_id": null
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -29,6 +29,7 @@
|
||||||
],
|
],
|
||||||
"status": "ACTIVE",
|
"status": "ACTIVE",
|
||||||
"project_id": "0bd18306d801447bb457a46252d82d13",
|
"project_id": "0bd18306d801447bb457a46252d82d13",
|
||||||
"tenant_id": "0bd18306d801447bb457a46252d82d13"
|
"tenant_id": "0bd18306d801447bb457a46252d82d13",
|
||||||
|
"service_type_id": null
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -34,7 +34,8 @@
|
||||||
],
|
],
|
||||||
"status": "ACTIVE",
|
"status": "ACTIVE",
|
||||||
"project_id": "0bd18306d801447bb457a46252d82d13",
|
"project_id": "0bd18306d801447bb457a46252d82d13",
|
||||||
"tenant_id": "0bd18306d801447bb457a46252d82d13"
|
"tenant_id": "0bd18306d801447bb457a46252d82d13",
|
||||||
|
"service_type_id": null
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"admin_state_up": true,
|
"admin_state_up": true,
|
||||||
|
@ -65,7 +66,8 @@
|
||||||
"routes": [],
|
"routes": [],
|
||||||
"status": "ACTIVE",
|
"status": "ACTIVE",
|
||||||
"project_id": "0bd18306d801447bb457a46252d82d13",
|
"project_id": "0bd18306d801447bb457a46252d82d13",
|
||||||
"tenant_id": "0bd18306d801447bb457a46252d82d13"
|
"tenant_id": "0bd18306d801447bb457a46252d82d13",
|
||||||
|
"service_type_id": null
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue