Support alternate Id interface for ncmp inventory /ch/cmhandles endpoint

Issue-ID: CPS-2481
Change-Id: I8a200495be1afb9a4f256127f886bed78c77f653
Signed-off-by: seanbeirne <sean.beirne@est.tech>

2 files changed, 21 insertions, 13 deletions

diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
index c72f47a428..d358719a4b 100644
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -86,8 +86,8 @@ paths:
       - network-cm-proxy-inventory
   /v1/ch/cmHandles:
     get:
-      description: Get all cm handle IDs for a registered DMI plugin
-      operationId: getAllCmHandleIdsForRegisteredDmi
+      description: Get all cm handle references for a registered DMI plugin
+      operationId: getAllCmHandleReferencesForRegisteredDmi
       parameters:
       - description: dmi-plugin-identifier
         in: query
@@ -96,6 +96,14 @@ paths:
         schema:
           example: my-dmi-plugin
           type: string
+      - description: Boolean parameter to determine if returned value(s) will be cm
+          handle Ids or alternate Ids for a given query
+        in: query
+        name: outputAlternateId
+        required: false
+        schema:
+          default: false
+          type: boolean
       responses:
         "200":
           content:
@@ -125,19 +133,19 @@ paths:
               schema:
                 $ref: '#/components/schemas/ErrorMessage'
           description: Internal Server Error
-      summary: "Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI\
-        \ data plugin, DMI model plugin)"
+      summary: "Get all cm handle references for a registered DMI plugin (DMI plugin,\
+        \ DMI data plugin, DMI model plugin)"
       tags:
       - network-cm-proxy-inventory
   /v1/ch/searches:
     post:
-      description: "Query and get CMHandle references for additional properties, public\
-        \ properties and registered DMI plugin (DMI plugin, DMI data plugin, DMI model\
-        \ plugin)."
+      description: "Query and get cm handle references for additional properties,\
+        \ public properties and registered DMI plugin (DMI plugin, DMI data plugin,\
+        \ DMI model plugin)."
       operationId: searchCmHandleIds
       parameters:
       - description: Boolean parameter to determine if returned value(s) will be cm
-          handle references for a given query
+          handle Ids or alternate Ids for a given query
         in: query
         name: outputAlternateId
         required: false
@@ -193,8 +201,8 @@ components:
         example: my-dmi-plugin
         type: string
     outputAlternateIdOptionInQuery:
-      description: Boolean parameter to determine if returned value(s) will be cmHandle
-        Ids or Alternate Ids for a given query
+      description: Boolean parameter to determine if returned value(s) will be cm
+        handle Ids or alternate Ids for a given query
       in: query
       name: outputAlternateId
       required: false
diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml
index 024aed681c..aa84e432e9 100644
--- a/docs/api/swagger/ncmp/openapi.yaml
+++ b/docs/api/swagger/ncmp/openapi.yaml
@@ -1142,7 +1142,7 @@ paths:
       operationId: searchCmHandleIds
       parameters:
       - description: Boolean parameter to determine if returned value(s) will be cm
-          handle references for a given query
+          handle Ids or alternate Ids for a given query
         in: query
         name: outputAlternateId
         required: false
@@ -1619,7 +1619,7 @@ components:
         type: string
     outputAlternateIdOptionInQuery:
       description: Boolean parameter to determine if returned value(s) will be cm
-        handle references for a given query
+        handle Ids or alternate Ids for a given query
       in: query
       name: outputAlternateId
       required: false
@@ -1790,7 +1790,7 @@ components:
         targetIds:
           items:
             description: "targeted cm handle references, maximum of 200 supported.\
-              \ If this limit is exceeded the request wil be refused."
+              \ If this limit is exceeded the request will be refused."
             example: "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
               ]"
             type: string