aboutsummaryrefslogtreecommitdiffstats
path: root/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 /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 'docs')
-rw-r--r--docs/api/swagger/ncmp/openapi-inventory.yaml4
-rw-r--r--docs/api/swagger/ncmp/openapi.yaml14
2 files changed, 9 insertions, 9 deletions
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
index 8552ad53e3..c72f47a428 100644
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -136,8 +136,8 @@ paths:
\ plugin)."
operationId: searchCmHandleIds
parameters:
- - 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
in: query
name: outputAlternateId
required: false
diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml
index aa732c8566..024aed681c 100644
--- a/docs/api/swagger/ncmp/openapi.yaml
+++ b/docs/api/swagger/ncmp/openapi.yaml
@@ -698,7 +698,7 @@ paths:
schema:
$ref: '#/components/schemas/DmiErrorMessage'
description: Bad Gateway
- summary: Execute a data operation for group of cm handle ids
+ summary: Execute a data operation for group of cm handle references
tags:
- network-cm-proxy
/v1/ch/{cm-handle}/data/ds/{datastore-name}/query:
@@ -1141,8 +1141,8 @@ paths:
this query.
operationId: searchCmHandleIds
parameters:
- - 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
in: query
name: outputAlternateId
required: false
@@ -1618,8 +1618,8 @@ components:
example: 2024-01-22
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 references for a given query
in: query
name: outputAlternateId
required: false
@@ -1789,8 +1789,8 @@ components:
type: string
targetIds:
items:
- 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\"\
]"
type: string