233d7d5727
We currently support /[nodes, ports, portgroups, chassis]/detail as an API endpoint for getting a detailed list of each object. This does not fit the RESTful and resourceful API design principles of <resource type>/<resource id> and makes it hard to consume the API from frameworks that expect that structure. We can't remove the old endpoint, so that is safeguarded by the restricted node names list. This patch adds a ?detail=[True, False] query string to the list API endpoints to allow those consuming the API to use the expected URL form. Change-Id: I694919b4a4eaa3419318bbee1cde79de15e19afa Story: #1662921 Task: #10176
12 lines
367 B
YAML
12 lines
367 B
YAML
---
|
|
features:
|
|
- |
|
|
Add ``?detail=`` boolean query to the API list endpoints to provide a more
|
|
RESTful alternative to the existing ``/nodes/detail`` and similar endpoints. The
|
|
default is False. Now these API requests are possible:
|
|
|
|
* ``/nodes?detail=True``
|
|
* ``/ports?detail=True``
|
|
* ``/chassis?detail=True``
|
|
* ``/portgroups?detail=True``
|