diff options
Diffstat (limited to 'cps-ncmp-rest/docs')
| -rw-r--r-- | cps-ncmp-rest/docs/openapi/components.yaml | 9 | ||||
| -rwxr-xr-x | cps-ncmp-rest/docs/openapi/ncmp-inventory.yml | 25 | ||||
| -rwxr-xr-x | cps-ncmp-rest/docs/openapi/openapi-inventory.yml | 4 |
3 files changed, 37 insertions, 1 deletions
diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml index c1e05876ca..427f083698 100644 --- a/cps-ncmp-rest/docs/openapi/components.yaml +++ b/cps-ncmp-rest/docs/openapi/components.yaml @@ -168,7 +168,6 @@ components: } } - CmHandleQueryParameters: type: object title: Cm Handle query parameters for executing cm handle search @@ -462,6 +461,14 @@ components: schema: type: string default: / + dmiPluginIdentifierInQuery: + name: dmi-plugin-identifier + in: query + description: dmi-plugin-identifier + required: true + schema: + type: string + example: my-dmi-plugin resourceIdentifierInQuery: name: resourceIdentifier in: query diff --git a/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml b/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml index 0a408c2413..0c3dffd217 100755 --- a/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml +++ b/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml @@ -97,3 +97,28 @@ updateDmiRegistration: "errorText": "cm-handle has an invalid character(s) in id" } ] + +getAllCmHandleIdsForRegisteredDmi: + get: + description: Get all cm handle IDs for a registered DMI plugin + tags: + - network-cm-proxy-inventory + summary: Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin) + operationId: getAllCmHandleIdsForRegisteredDmi + parameters: + - $ref: 'components.yaml#/components/parameters/dmiPluginIdentifierInQuery' + responses: + 200: + description: OK + content: + application/json: + schema: + type: array + items: + type: string + 401: + $ref: 'components.yaml#/components/responses/Unauthorized' + 403: + $ref: 'components.yaml#/components/responses/Forbidden' + 500: + $ref: 'components.yaml#/components/responses/InternalServerError'
\ No newline at end of file diff --git a/cps-ncmp-rest/docs/openapi/openapi-inventory.yml b/cps-ncmp-rest/docs/openapi/openapi-inventory.yml index ee09d050f3..08270bc680 100755 --- a/cps-ncmp-rest/docs/openapi/openapi-inventory.yml +++ b/cps-ncmp-rest/docs/openapi/openapi-inventory.yml @@ -1,5 +1,6 @@ # ============LICENSE_START======================================================= # Copyright (C) 2021 Bell Canada +# Modifications Copyright (C) 2022 Nordix Foundation # ================================================================================ # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -26,3 +27,6 @@ servers: paths: /v1/ch: $ref: 'ncmp-inventory.yml#/updateDmiRegistration' + + /v1/ch/cmHandles: + $ref: 'ncmp-inventory.yml#/getAllCmHandleIdsForRegisteredDmi'
\ No newline at end of file |