aboutsummaryrefslogtreecommitdiffstats
path: root/cps-ncmp-rest/docs
diff options
context:
space:
mode:
authorseanbeirne <sean.beirne@est.tech>2024-10-21 16:18:27 +0100
committerseanbeirne <sean.beirne@est.tech>2024-11-05 13:44:45 +0000
commita1a71f782f2db1b50a41f095d49c981f5095b4fb (patch)
treef915a69c83d74ce7ecf2f0735cff5951a4f4368c /cps-ncmp-rest/docs
parentc475188530572efedbcb606239da0cdcee48c05b (diff)
Support Alternate-Id for CPS-E05 data batch interface
Issue-ID: CPS-2274 Change-Id: I75163bc7943fca5cbbe8c24601a2dfc184a9e6cc Signed-off-by: seanbeirne <sean.beirne@est.tech>
Diffstat (limited to 'cps-ncmp-rest/docs')
-rw-r--r--cps-ncmp-rest/docs/openapi/components.yaml4
-rwxr-xr-xcps-ncmp-rest/docs/openapi/ncmp.yml2
2 files changed, 3 insertions, 3 deletions
diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
index 99072c43e5..a8da6937a3 100644
--- a/cps-ncmp-rest/docs/openapi/components.yaml
+++ b/cps-ncmp-rest/docs/openapi/components.yaml
@@ -366,7 +366,7 @@ components:
type: array
items:
type: string
- description: targeted cm handles, maximum of 50 supported. If this limit is exceeded the request wil be refused.
+ description: targeted cm handle references, maximum of 200 supported. If this limit is exceeded the request wil be refused.
example: [ "da310eecdb8d44c2acc0ddaae01174b1","c748c58f8e0b438f9fd1f28370b17d47" ]
examples:
@@ -516,7 +516,7 @@ components:
outputAlternateIdOptionInQuery:
name: outputAlternateId
in: query
- 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 references for a given query
required: false
schema:
type: boolean
diff --git a/cps-ncmp-rest/docs/openapi/ncmp.yml b/cps-ncmp-rest/docs/openapi/ncmp.yml
index a3ddc3fb3b..4624bc1060 100755
--- a/cps-ncmp-rest/docs/openapi/ncmp.yml
+++ b/cps-ncmp-rest/docs/openapi/ncmp.yml
@@ -193,7 +193,7 @@ dataOperationForCmHandle:
post:
tags:
- network-cm-proxy
- summary: Execute a data operation for group of cm handle ids
+ summary: Execute a data operation for group of cm handle references
description: This request will be handled asynchronously using messaging to the supplied topic. The rest response will be an acknowledge with a requestId to identify the relevant messages. A maximum of 200 cm handles per operation is supported.
operationId: executeDataOperationForCmHandles
parameters: