summaryrefslogtreecommitdiffstats
path: root/docs/api/swagger/ncmp
diff options
context:
space:
mode:
authordanielhanrahan <daniel.hanrahan@est.tech>2023-12-20 13:31:07 +0000
committerdanielhanrahan <daniel.hanrahan@est.tech>2023-12-20 13:38:00 +0000
commit3e14d392a02aa6d7253418702c1dc2f713251af3 (patch)
treea8e82d313b3a5e732e6abab22dece89d72a399bc /docs/api/swagger/ncmp
parent60bbcb97b3e1dd3679a3f8f5e58e931cfd71a107 (diff)
Release notes and OpenAPI docs updated for 3.4.1
- Update release notes - Update OpenAPI docs - Made RST files not executable Issue-ID: CPS-2017 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: I85bd7cb68d960c9522b80048007cfe913cd49ed4
Diffstat (limited to 'docs/api/swagger/ncmp')
-rw-r--r--docs/api/swagger/ncmp/openapi-inventory.yaml9
-rw-r--r--docs/api/swagger/ncmp/openapi.yaml9
2 files changed, 18 insertions, 0 deletions
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
index 9f64f58cb7..53f51f3f8b 100644
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -261,6 +261,7 @@ components:
example:
updatedCmHandles:
- cmHandle: my-cm-handle
+ alternateId: my-alternate-id
publicCmHandleProperties:
key: my-property
cmHandleProperties:
@@ -268,6 +269,7 @@ components:
moduleSetTag: my-module-set-tag
trustLevel: COMPLETE
- cmHandle: my-cm-handle
+ alternateId: my-alternate-id
publicCmHandleProperties:
key: my-property
cmHandleProperties:
@@ -276,6 +278,7 @@ components:
trustLevel: COMPLETE
createdCmHandles:
- cmHandle: my-cm-handle
+ alternateId: my-alternate-id
publicCmHandleProperties:
key: my-property
cmHandleProperties:
@@ -283,6 +286,7 @@ components:
moduleSetTag: my-module-set-tag
trustLevel: COMPLETE
- cmHandle: my-cm-handle
+ alternateId: my-alternate-id
publicCmHandleProperties:
key: my-property
cmHandleProperties:
@@ -337,6 +341,7 @@ components:
RestInputCmHandle:
example:
cmHandle: my-cm-handle
+ alternateId: my-alternate-id
publicCmHandleProperties:
key: my-property
cmHandleProperties:
@@ -366,6 +371,9 @@ components:
- NONE
example: COMPLETE
type: string
+ alternateId:
+ example: my-alternate-id
+ type: string
required:
- cmHandle
type: object
@@ -391,6 +399,7 @@ components:
type: string
type: array
moduleSetTag:
+ default: ""
example: my-module-set-tag
type: string
required:
diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml
index 810210f584..8098faefcc 100644
--- a/docs/api/swagger/ncmp/openapi.yaml
+++ b/docs/api/swagger/ncmp/openapi.yaml
@@ -1974,6 +1974,7 @@ components:
reason: LOCKED_MISBEHAVING
details: locked due to failure in module sync
lastUpdateTime: 2022-12-31T20:30:40.000+0000
+ trustLevel: COMPLETE
properties:
cmHandle:
example: my-cm-handle1
@@ -1987,6 +1988,10 @@ components:
type: array
state:
$ref: '#/components/schemas/CmHandleCompositeState'
+ trustLevel:
+ description: Current trust level of the relevant CM handle ID.
+ example: COMPLETE
+ type: string
title: CM handle Details
type: object
CmHandlePublicProperties:
@@ -2064,6 +2069,10 @@ components:
example: 2022-12-31T20:30:40.000+0000
type: string
type: object
+ CmHandleTrustLevel:
+ description: Current trust level of the relevant CM handle ID.
+ example: COMPLETE
+ type: string
RestOutputCmHandlePublicProperties:
example:
publicCmHandleProperties: