4da199808f
This patch serves as a trail blazer for Neutron API consolidation. It introduces the following: * It provides the API definitions to be used by a Neutron Stadium project. * It introduces some testing scaffolding to validate the correctness of an API definition and coverage for the extension. * It provides the API reference documentation for the extension. More patches will follow up to consolidate the rest of the Neutron APIs and will use this as an example/template on how to approach the consolidation effort. Change-Id: Ie620a6fc21916ab34a19632c7fb9456b2c7c43b1
44 lines
1.1 KiB
ReStructuredText
44 lines
1.1 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=========================================
|
|
Trunk details extended attributes (ports)
|
|
=========================================
|
|
|
|
The trunk_details extension attribute is available when showing a
|
|
port resource that participates in a trunk as parent. The extension
|
|
is useful for REST clients that may want to access trunk details
|
|
when getting the parent port, and it allows them to avoid extra
|
|
lookups.
|
|
|
|
Show trunk details
|
|
==================
|
|
|
|
.. rest_method:: GET /v2.0/ports/{port_id}
|
|
|
|
Shows details for a port. The details available in the `trunk_details`
|
|
attribute contain the trunk ID and the array showing information
|
|
about the subports that belong to the trunk: the port UUID, the
|
|
segmentation type, the segmentation ID, and the MAC address.
|
|
|
|
Normal response codes: 200
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- port_id: port_id
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- trunk_details: trunk_details
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../v2/samples/trunks/trunk-details-show-response.json
|
|
:language: javascript
|