aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api/swagger/ncmp/openapi-inventory.yaml
diff options
context:
space:
mode:
authorsourabh_sourabh <sourabh.sourabh@est.tech>2025-01-07 13:51:20 +0000
committersourabh_sourabh <sourabh.sourabh@est.tech>2025-01-10 14:05:03 +0000
commitcdd893e5e9061deee89064fce3003ae8dbc8435a (patch)
treed4f6803fa80f26d8d74fd62f72219159b54222fc /docs/api/swagger/ncmp/openapi-inventory.yaml
parent84dcd25fd45dae23b756355aad7bd528bd5b05fe (diff)
Realistic Examples: NCMP Open API and Doc
- Updated resourceIdentifier query parameter to align with GNBDUFunctionConfig structure. - Introduced hierarchical notation (parent=..., child=...) for precise resource identification. - Added examples for querying all GNBDUFunctions, specific gNB IDs, and sub-resources like RIM-RS reporting configurations. Issue-ID: CPS-2483 Change-Id: I215944a45c754e43f61948464c5c8793c22e41c8 Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech>
Diffstat (limited to 'docs/api/swagger/ncmp/openapi-inventory.yaml')
-rw-r--r--docs/api/swagger/ncmp/openapi-inventory.yaml12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
index 0b9f5b9414..d565f9c558 100644
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -248,7 +248,7 @@ components:
example:
updatedCmHandles:
- cmHandle: my-cm-handle
- alternateId: my-alternate-id
+ alternateId: "Subnetwork=Europe,ManagedElement=X123"
dataProducerIdentifier: my-data-producer-identifier
publicCmHandleProperties:
key: my-property
@@ -257,7 +257,7 @@ components:
moduleSetTag: my-module-set-tag
trustLevel: COMPLETE
- cmHandle: my-cm-handle
- alternateId: my-alternate-id
+ alternateId: "Subnetwork=Europe,ManagedElement=X123"
dataProducerIdentifier: my-data-producer-identifier
publicCmHandleProperties:
key: my-property
@@ -267,7 +267,7 @@ components:
trustLevel: COMPLETE
createdCmHandles:
- cmHandle: my-cm-handle
- alternateId: my-alternate-id
+ alternateId: "Subnetwork=Europe,ManagedElement=X123"
dataProducerIdentifier: my-data-producer-identifier
publicCmHandleProperties:
key: my-property
@@ -276,7 +276,7 @@ components:
moduleSetTag: my-module-set-tag
trustLevel: COMPLETE
- cmHandle: my-cm-handle
- alternateId: my-alternate-id
+ alternateId: "Subnetwork=Europe,ManagedElement=X123"
dataProducerIdentifier: my-data-producer-identifier
publicCmHandleProperties:
key: my-property
@@ -332,7 +332,7 @@ components:
RestInputCmHandle:
example:
cmHandle: my-cm-handle
- alternateId: my-alternate-id
+ alternateId: "Subnetwork=Europe,ManagedElement=X123"
dataProducerIdentifier: my-data-producer-identifier
publicCmHandleProperties:
key: my-property
@@ -364,7 +364,7 @@ components:
example: COMPLETE
type: string
alternateId:
- example: my-alternate-id
+ example: "Subnetwork=Europe,ManagedElement=X123"
type: string
dataProducerIdentifier:
example: my-data-producer-identifier