Files
neutron-lib/api-ref/source/v2/trunk-details.inc
Brian Haley c28b3ab8fe Fix incorrect links for the filtering spec
The spec networking_general_api_information.html was moved
to api-ref in [0] but some of the links pointing to it
were not updated. This change makes all the refs consistent
and adds links where missing.

Also moved sync/async and bulk create sections lower to
group all the filtering, pagination and sorting sections
together since they are inter-related.

[0] https://review.opendev.org/c/openstack/neutron-lib/+/362877

Change-Id: I895cc9aaee2546b95e93150c134f350a50346447
2024-04-04 19:00:17 -04:00

46 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.
.. include:: filtering-show.inc
Normal response codes: 200
Request
-------
.. rest_parameters:: parameters.yaml
- port_id: port_id-path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- trunk_details: trunk_details
Response Example
----------------
.. literalinclude:: ../v2/samples/trunks/trunk-details-show-response.json
:language: javascript