openstack/ironic
Code Issues Proposed changes

api-ref portgroup_id should be portgroup_ident

Browse Source 
A portgroup can be identified by a UUID or a name, so we
should be consistent and use 'portgroup_ident' instead of
'portgroup_id' in the API ref. (Similar to how we use
'node_ident'.)

Change-Id: I5b2ddd7e47e02281d62ae90f0e7f4a32af802982
This commit is contained in:
Ruby Loo 2017-09-19 17:19:49 -04:00
parent 76ba2523c5
commit 738eac1ba6
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
api-ref/source/baremetal-api-v1-portgroups.inc
View File

@ -166,7 +166,7 @@ Response
Show Portgroup Details Show Portgroup Details
====================== ======================
.. rest_method:: GET /v1/portgroups/{portgroup_id} .. rest_method:: GET /v1/portgroups/{portgroup_ident}
Show details for the given Portgroup. Show details for the given Portgroup.
@ -179,7 +179,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- portgroup_id: portgroup_ident - portgroup_ident: portgroup_ident
- fields: fields - fields: fields
Response Response
@ -210,7 +210,7 @@ Response
Update a Portgroup Update a Portgroup
================== ==================
.. rest_method:: PATCH /v1/portgroups/{portgroup_id} .. rest_method:: PATCH /v1/portgroups/{portgroup_ident}
Update a Portgroup. Update a Portgroup.
@ -226,7 +226,7 @@ The BODY of the PATCH request must be a JSON PATCH document, adhering to
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- portgroup_id: portgroup_ident - portgroup_ident: portgroup_ident
**Example Portgroup update request:** **Example Portgroup update request:**
@ -261,7 +261,7 @@ Response
Delete Portgroup Delete Portgroup
================ ================
.. rest_method:: DELETE /v1/portgroups/{portgroup_id} .. rest_method:: DELETE /v1/portgroups/{portgroup_ident}
Delete a Portgroup. Delete a Portgroup.
@ -274,4 +274,4 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- portgroup_id: portgroup_ident - portgroup_ident: portgroup_ident