diff options
| author |   niamhcore <niamh.core@est.tech> | 2021-10-11 16:38:53 +0100 |
|---|---|---|
| committer | niamhcore <niamh.core@est.tech> | 2021-10-11 16:38:53 +0100 |
| commit | c1904c1ee3f1a61564e154dd81c144a23a1af66c (patch) | |
| tree | 22a6c8a9480adc368229220d6def1679e9f761be /docs/api/swagger | |
| parent | 1ab1a5450452352ff00bee718054f10adfc5bea0 (diff) | |
Update open api information
Issue-ID: CPS-626
Signed-off-by: niamhcore <niamh.core@est.tech>
Change-Id: I7e8171e215fe55b68580f7f7a8143edc32c62ac9
Diffstat (limited to 'docs/api/swagger')
| -rw-r--r-- | docs/api/swagger/ncmp/openapi-inventory.yaml | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml new file mode 100644 index 0000000000..627816bf8f --- /dev/null +++ b/docs/api/swagger/ncmp/openapi-inventory.yaml @@ -0,0 +1,88 @@ +openapi: 3.0.1 +info: + title: NCMP Inventory API + description: NCMP Inventory API + version: "1.0" +servers: +- url: /ncmpInventory +paths: + /v1/ch: + post: + tags: + - 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestDmiPluginRegistration' + required: true + responses: + "201": + description: Created + content: {} + "400": + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + "401": + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + "403": + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' +components: + schemas: + RestDmiPluginRegistration: + type: object + properties: + dmiPlugin: + type: string + example: onap-dmi-plugin + createdCmHandles: + type: array + items: + $ref: '#/components/schemas/RestCmHandle' + updatedCmHandles: + type: array + items: + $ref: '#/components/schemas/RestCmHandle' + removedCmHandles: + type: array + items: + type: string + RestCmHandle: + required: + - cmHandle + type: object + properties: + cmHandle: + type: string + example: cmHandle123 + cmHandleProperties: + $ref: '#/components/schemas/RestCmHandleAdditionalProperties' + RestCmHandleAdditionalProperties: + type: object + additionalProperties: + type: string + example: system-001 + ErrorMessage: + title: Error + type: object + properties: + status: + type: string + message: + type: string + details: + type: string |