summaryrefslogtreecommitdiffstats
path: root/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml
diff options
context:
space:
mode:
authoremaclee <lee.anjella.macabuhay@est.tech>2022-08-19 09:26:39 +0100
committerLee Anjella Macabuhay <lee.anjella.macabuhay@est.tech>2022-09-01 09:37:42 +0000
commitd340047f82a8301453fc3872e474090366b68472 (patch)
treedda61a5c559dceb2aa7d26beb7ed292d23b77175 /cps-ncmp-rest/docs/openapi/ncmp-inventory.yml
parentc1915b5af27e4ee3ff89fd881e753e029a0bf5da (diff)
Get all cm handles by DMI plugin Identifier
- api added to get cm handles by dmi plugin identifier - response object refactored from RestOutputCmHandle to collection of Strings (cm handle ids) - added public and private methods in CmHandleQueries to get cm handle ID by dmi plugin - added unit tests including test to show that there are no duplicates on response Issue-ID: CPS-1136 Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech> Change-Id: Ia3bdc16172a90ad3a3f9ae11cddcad1352188726
Diffstat (limited to 'cps-ncmp-rest/docs/openapi/ncmp-inventory.yml')
-rwxr-xr-xcps-ncmp-rest/docs/openapi/ncmp-inventory.yml25
1 files changed, 25 insertions, 0 deletions
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