From 738eac1ba66acc767a2c13ff6d256061faabcc05 Mon Sep 17 00:00:00 2001 From: Ruby Loo Date: Tue, 19 Sep 2017 17:19:49 -0400 Subject: [PATCH] api-ref portgroup_id should be portgroup_ident 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 --- api-ref/source/baremetal-api-v1-portgroups.inc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/api-ref/source/baremetal-api-v1-portgroups.inc b/api-ref/source/baremetal-api-v1-portgroups.inc index 338c903e5e..d1a3d22337 100644 --- a/api-ref/source/baremetal-api-v1-portgroups.inc +++ b/api-ref/source/baremetal-api-v1-portgroups.inc @@ -166,7 +166,7 @@ Response Show Portgroup Details ====================== -.. rest_method:: GET /v1/portgroups/{portgroup_id} +.. rest_method:: GET /v1/portgroups/{portgroup_ident} Show details for the given Portgroup. @@ -179,7 +179,7 @@ Request .. rest_parameters:: parameters.yaml - - portgroup_id: portgroup_ident + - portgroup_ident: portgroup_ident - fields: fields Response @@ -210,7 +210,7 @@ Response Update a Portgroup ================== -.. rest_method:: PATCH /v1/portgroups/{portgroup_id} +.. rest_method:: PATCH /v1/portgroups/{portgroup_ident} 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 - - portgroup_id: portgroup_ident + - portgroup_ident: portgroup_ident **Example Portgroup update request:** @@ -261,7 +261,7 @@ Response Delete Portgroup ================ -.. rest_method:: DELETE /v1/portgroups/{portgroup_id} +.. rest_method:: DELETE /v1/portgroups/{portgroup_ident} Delete a Portgroup. @@ -274,4 +274,4 @@ Request .. rest_parameters:: parameters.yaml - - portgroup_id: portgroup_ident + - portgroup_ident: portgroup_ident