summaryrefslogtreecommitdiffstats
path: root/docs/api
diff options
context:
space:
mode:
authorJvD_Ericsson <jeff.van.dam@est.tech>2024-02-26 13:45:47 +0000
committerJeff van Dam <jeff.van.dam@est.tech>2024-03-13 16:45:31 +0000
commite14fe9ab679998f40d7c46ff58702e5aa0545b07 (patch)
treec9d6a0eee498baa4fa72d50d67b9ddb556d8b2aa /docs/api
parenta927b20ce1a6d5792ed41e0a98eb475606e8f35a (diff)
Modify the get cmHandle api to return dataProducerIdentifier, moduleSetTag, and alternateId (CPS-1964 2)
Issue-ID: CPS-2113 Signed-off-by: JvD_Ericsson <jeff.van.dam@est.tech> Change-Id: I672e5c8408e77a5fa15d6fc2f41438aca705484c
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/swagger/ncmp/openapi-inventory.yaml8
-rw-r--r--docs/api/swagger/ncmp/openapi.yaml12
2 files changed, 20 insertions, 0 deletions
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
index ff9f4ba683..8a6c13ebec 100644
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -222,6 +222,7 @@ components:
updatedCmHandles:
- cmHandle: my-cm-handle
alternateId: my-alternate-id
+ dataProducerIdentifier: my-data-producer-identifier
publicCmHandleProperties:
key: my-property
cmHandleProperties:
@@ -230,6 +231,7 @@ components:
trustLevel: COMPLETE
- cmHandle: my-cm-handle
alternateId: my-alternate-id
+ dataProducerIdentifier: my-data-producer-identifier
publicCmHandleProperties:
key: my-property
cmHandleProperties:
@@ -239,6 +241,7 @@ components:
createdCmHandles:
- cmHandle: my-cm-handle
alternateId: my-alternate-id
+ dataProducerIdentifier: my-data-producer-identifier
publicCmHandleProperties:
key: my-property
cmHandleProperties:
@@ -247,6 +250,7 @@ components:
trustLevel: COMPLETE
- cmHandle: my-cm-handle
alternateId: my-alternate-id
+ dataProducerIdentifier: my-data-producer-identifier
publicCmHandleProperties:
key: my-property
cmHandleProperties:
@@ -302,6 +306,7 @@ components:
example:
cmHandle: my-cm-handle
alternateId: my-alternate-id
+ dataProducerIdentifier: my-data-producer-identifier
publicCmHandleProperties:
key: my-property
cmHandleProperties:
@@ -334,6 +339,9 @@ components:
alternateId:
example: my-alternate-id
type: string
+ dataProducerIdentifier:
+ example: my-data-producer-identifier
+ type: string
required:
- cmHandle
type: object
diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml
index 9203b6d4ca..da0b0b3f99 100644
--- a/docs/api/swagger/ncmp/openapi.yaml
+++ b/docs/api/swagger/ncmp/openapi.yaml
@@ -1871,6 +1871,8 @@ components:
RestOutputCmHandle:
example:
cmHandle: my-cm-handle1
+ alternateId: my-alternate-id
+ dataProducerIdentifier: my-data-producer-identifier
publicCmHandleProperties:
- key: Book Type
- key: Book Type
@@ -1889,6 +1891,7 @@ components:
details: locked due to failure in module sync
lastUpdateTime: 2022-12-31T20:30:40.000+0000
trustLevel: COMPLETE
+ moduleSetTag: my-module-set-tag
properties:
cmHandle:
example: my-cm-handle1
@@ -1906,6 +1909,15 @@ components:
description: Current trust level of the relevant CM handle ID.
example: COMPLETE
type: string
+ moduleSetTag:
+ example: my-module-set-tag
+ type: string
+ alternateId:
+ example: my-alternate-id
+ type: string
+ dataProducerIdentifier:
+ example: my-data-producer-identifier
+ type: string
title: CM handle Details
type: object
CmHandlePublicProperties: