diff options
| author |   DylanB95EST <dylan.byrne@est.tech> | 2021-12-14 16:34:38 +0000 |
|---|---|---|
| committer | DylanB95EST <dylan.byrne@est.tech> | 2022-01-28 14:32:11 +0000 |
| commit | 63132cec2c18363a8224646039cc23b6144d8e6c (patch) | |
| tree | 0821e401a14655ecba60d213f5dbacac12e8f0b4 /docs | |
| parent | a5ce86d02493f141848f9d609c65883d2198894a (diff) | |
Support 'public' Cm Handle Properties
Add support for new Public Additional Properties list to Register CM Handles API
Issue-ID: CPS-677
Change-Id: I6efc88734da2416f72f71a403622e519398b502d
Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/swagger/ncmp/openapi-inventory.yaml | 37 |
1 files changed, 29 insertions, 8 deletions
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml index c4b6f4b73..67eae41c4 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 @@ -29,18 +29,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 400 BAD_REQUEST + message: Bad request error message + details: Bad request error details "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized error message + details: Unauthorized error details "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 403 + message: Forbidden error message + details: Forbidden error details components: schemas: RestDmiPluginRegistration: @@ -48,7 +60,13 @@ components: properties: dmiPlugin: type: string - example: onap-dmi-plugin + example: my-dmi-plugin + dmiDataPlugin: + type: string + example: my-dmi-data-plugin + dmiModelPlugin: + type: string + example: my-dmi-model-plugin createdCmHandles: type: array items: @@ -61,21 +79,24 @@ components: type: array items: type: string + example: "[\"my-cm-handle1\",\"my-cm-handle2\",\"my-cm-handle3\"]" RestCmHandle: required: - - cmHandle + - cmHandle type: object properties: cmHandle: type: string - example: cmHandle123 + example: my-cm-handle cmHandleProperties: - $ref: '#/components/schemas/RestCmHandleAdditionalProperties' - RestCmHandleAdditionalProperties: + $ref: '#/components/schemas/RestCmHandleProperties' + publicCmHandleProperties: + $ref: '#/components/schemas/RestCmHandleProperties' + RestCmHandleProperties: type: object additionalProperties: type: string - example: system-001 + example: my-property ErrorMessage: title: Error type: object |