diff options
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/swagger/ncmp/openapi-inventory.yaml | 88 | ||||
| -rw-r--r-- | docs/api/yang/dmiYangResource.yang | 46 |
2 files changed, 134 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 diff --git a/docs/api/yang/dmiYangResource.yang b/docs/api/yang/dmiYangResource.yang new file mode 100644 index 0000000000..8e06a26948 --- /dev/null +++ b/docs/api/yang/dmiYangResource.yang @@ -0,0 +1,46 @@ +module dmi-registry { + + yang-version 1.1; + + namespace \"org:onap:cps:ncmp\"; + + prefix dmi-reg; + + organization \"Nordix Foundation\"; + + contact \"rahul.tyagi@est.tech\"; + + revision \"2021-05-20\" { + description + \"Initial Version\"; + } + + container dmi-registry { + + list cm-handles { + + key \"id\"; + + leaf id { + type string; + } + + leaf dmi-service-name { + type string; + } + + list additional-properties { + + key \"name\"; + + leaf name { + type string; + } + + leaf value { + type string; + } + } + } + } +}
\ No newline at end of file |