aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api/swagger/ncmp/openapi-inventory.yaml
diff options
context:
space:
mode:
authorbmiklos <miklos.baranyak@est.tech>2022-09-07 16:11:57 +0200
committerbmiklos <miklos.baranyak@est.tech>2022-09-07 17:40:23 +0200
commit96d54ef097e3d7ccbc89b615bf3c042ec0141e97 (patch)
treeb98e326dd0fdeb77b7f95ba6b3eabf712f7849e5 /docs/api/swagger/ncmp/openapi-inventory.yaml
parent440dc8aab179f6c8451683f53b019ccd8bd60bdf (diff)
Update doc and release notes after endpoint merge
- Update generated swagger files according to changes - Add release notes for the parent ticket Issue-ID: CPS-1001 Issue-ID: CPS-1256 Change-Id: I09aaec26971ae89f4588bfc80d2b80cc4778dfc8 Signed-off-by: bmiklos <miklos.baranyak@est.tech>
Diffstat (limited to 'docs/api/swagger/ncmp/openapi-inventory.yaml')
-rw-r--r--docs/api/swagger/ncmp/openapi-inventory.yaml82
1 files changed, 41 insertions, 41 deletions
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
index f203eac7b..2d34f0a61 100644
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -4,12 +4,12 @@ info:
description: NCMP Inventory API
version: "1.0"
servers:
- - url: /ncmpInventory
+- url: /ncmpInventory
paths:
/v1/ch:
post:
tags:
- - network-cm-proxy-inventory
+ - network-cm-proxy-inventory
summary: DMI notifies NCMP of new CM Handles
description: "Register a DMI Plugin with any new, updated or removed CM Handles."
operationId: updateDmiPluginRegistration
@@ -63,51 +63,51 @@ paths:
$ref: '#/components/schemas/DmiPluginRegistrationErrorResponse'
example:
failedCreatedCmHandles:
- - cmHandle: my-cm-handle-01
- errorCode: "00"
- errorText: Unknown error. <error-details>
- - cmHandle: my-cm-handle-02
- errorCode: "01"
- errorText: cm-handle already exists
- - cmHandle: my-cm-handle-03
- errorCode: "03"
- errorText: cm-handle has an invalid character(s) in id
+ - cmHandle: my-cm-handle-01
+ errorCode: "00"
+ errorText: Unknown error. <error-details>
+ - cmHandle: my-cm-handle-02
+ errorCode: "01"
+ errorText: cm-handle already exists
+ - cmHandle: my-cm-handle-03
+ errorCode: "03"
+ errorText: cm-handle has an invalid character(s) in id
failedUpdatedCmHandles:
- - cmHandle: my-cm-handle-01
- errorCode: "00"
- errorText: Unknown error. <error-details>
- - cmHandle: my-cm-handle-02
- errorCode: "02"
- errorText: cm-handle does not exist
- - cmHandle: my-cm-handle-03
- errorCode: "03"
- errorText: cm-handle has an invalid character(s) in id
+ - cmHandle: my-cm-handle-01
+ errorCode: "00"
+ errorText: Unknown error. <error-details>
+ - cmHandle: my-cm-handle-02
+ errorCode: "02"
+ errorText: cm-handle does not exist
+ - cmHandle: my-cm-handle-03
+ errorCode: "03"
+ errorText: cm-handle has an invalid character(s) in id
failedRemovedCmHandles:
- - cmHandle: my-cm-handle-01
- errorCode: "00"
- errorText: Unknown error. <error-details>
- - cmHandle: my-cm-handle-02
- errorCode: "02"
- errorText: cm-handle does not exists
- - cmHandle: my-cm-handle-03
- errorCode: "03"
- errorText: cm-handle has an invalid character(s) in id
+ - cmHandle: my-cm-handle-01
+ errorCode: "00"
+ errorText: Unknown error. <error-details>
+ - cmHandle: my-cm-handle-02
+ errorCode: "02"
+ errorText: cm-handle does not exists
+ - cmHandle: my-cm-handle-03
+ errorCode: "03"
+ errorText: cm-handle has an invalid character(s) in id
/v1/ch/cmHandles:
get:
tags:
- - network-cm-proxy-inventory
+ - network-cm-proxy-inventory
summary: "Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI\
\ data plugin, DMI model plugin)"
description: Get all cm handle IDs for a registered DMI plugin
operationId: getAllCmHandleIdsForRegisteredDmi
parameters:
- - name: dmi-plugin-identifier
- in: query
- description: dmi-plugin-identifier
- required: true
- schema:
- type: string
- example: my-dmi-plugin
+ - name: dmi-plugin-identifier
+ in: query
+ description: dmi-plugin-identifier
+ required: true
+ schema:
+ type: string
+ example: my-dmi-plugin
responses:
"200":
description: OK
@@ -175,14 +175,14 @@ components:
removedCmHandles:
type: array
example:
- - my-cm-handle1
- - my-cm-handle2
- - my-cm-handle3
+ - my-cm-handle1
+ - my-cm-handle2
+ - my-cm-handle3
items:
type: string
RestInputCmHandle:
required:
- - cmHandle
+ - cmHandle
type: object
properties:
cmHandle: