summaryrefslogtreecommitdiffstats
path: root/dmi-service/openapi
diff options
context:
space:
mode:
authorseanbeirne <sean.beirne@est.tech>2024-11-27 12:31:42 +0000
committerseanbeirne <sean.beirne@est.tech>2024-11-29 11:24:16 +0000
commitcd485287b10cdd407ec9f6cba6abb29ff3a95bfc (patch)
treefd97cab772d4c47ff7287681d9d660a968d2120f /dmi-service/openapi
parentdec2437d17ccd86dd5233ff27fdc6c1deeb90a5a (diff)
Update openapi to reflect alternate id functionality
Issue-ID: CPS-2275 Change-Id: I833eb3389c2d8aa0eb02dffdd9302751edbebf58 Signed-off-by: seanbeirne <sean.beirne@est.tech>
Diffstat (limited to 'dmi-service/openapi')
-rw-r--r--dmi-service/openapi/components.yml4
-rw-r--r--dmi-service/openapi/openapi.yml4
2 files changed, 4 insertions, 4 deletions
diff --git a/dmi-service/openapi/components.yml b/dmi-service/openapi/components.yml
index 4a6d1729..6f11c399 100644
--- a/dmi-service/openapi/components.yml
+++ b/dmi-service/openapi/components.yml
@@ -244,7 +244,7 @@ components:
cmHandleInPath:
name: cmHandle
in: path
- description: The identifier for a network function, network element, subnetwork, or any other cm object by managed Network CM Proxy
+ description: The CM handle or alternate identifier for a network function, network element, subnetwork, or any other CM object managed by Network CM Proxy
required: true
schema:
type: string
@@ -303,7 +303,7 @@ components:
requiredRequestIdParamInQuery:
name: requestId
in: query
- description: request Id generated by NCMP and sent as an acknowledgement for the client request the same including here.
+ description: request ID generated by NCMP and is sent here and sent as an acknowledgement for the client request.
required: true
schema:
type: string
diff --git a/dmi-service/openapi/openapi.yml b/dmi-service/openapi/openapi.yml
index 6dbc19f3..f61d3014 100644
--- a/dmi-service/openapi/openapi.yml
+++ b/dmi-service/openapi/openapi.yml
@@ -154,8 +154,8 @@ paths:
post:
tags:
- dmi-plugin
- summary: Execute a data operation for group of cm handle ids.
- description: Execute a data operation for group of cm handle ids by supplied operation details
+ summary: Execute a data operation for group of CM handle references.
+ description: Execute a data operation for group of CM handle (IDs or alternate IDs) by supplied operation details
operationId: getResourceDataForCmHandleDataOperation
parameters:
- $ref: 'components.yml#/components/parameters/requiredTopicParamInQuery'