aboutsummaryrefslogtreecommitdiffstats
path: root/cps-ncmp-rest/docs
diff options
context:
space:
mode:
authorleventecsanyi <levente.csanyi@est.tech>2022-10-26 10:44:08 +0200
committerleventecsanyi <levente.csanyi@est.tech>2022-12-01 21:32:44 +0100
commit37d72855721caa646144ad323fe51ae78af15507 (patch)
tree0d4494c83572f779aded34a7de3b03774c19873c /cps-ncmp-rest/docs
parent94d77dd3430bf504b1fe1209760cfeedb47752a7 (diff)
Filter on private properties of CM Handles
- Moved cm handle query validation to cps-ncmp-service (where it belongs!) - Added new enum type for private/public field types - Created new methods for private and public queries - Added new REST endpoint - Created service methods for filtering on different types of properties - Refactored getPublicPropertyPairs and queryCmHandleAnyProperties - Added unit test for the controller layer - Fixed refactoring suggestions - Imporved code coverage with unit tests - Refactoring - Added new functionality to NcmpRestInputMapper - Updated version number to 3.2.1-SNAPSHOT and updated release-notes.rst Issue-ID: CPS-1236 Change-Id: I0ddf6866473f7c3c6b8507d222d441bf97ca6bdc Signed-off-by: leventecsanyi <levente.csanyi@est.tech>
Diffstat (limited to 'cps-ncmp-rest/docs')
-rwxr-xr-xcps-ncmp-rest/docs/openapi/ncmp-inventory.yml29
-rwxr-xr-xcps-ncmp-rest/docs/openapi/openapi-inventory.yml4
2 files changed, 33 insertions, 0 deletions
diff --git a/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml b/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml
index 0c3dffd217..16083bdf39 100755
--- a/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml
+++ b/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml
@@ -121,4 +121,33 @@ getAllCmHandleIdsForRegisteredDmi:
403:
$ref: 'components.yaml#/components/responses/Forbidden'
500:
+ $ref: 'components.yaml#/components/responses/InternalServerError'
+
+searchCmHandleIds:
+ post:
+ description: Query and get CMHandleIds for additional properties, public properties and registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin).
+ tags:
+ - network-cm-proxy-inventory
+ summary: Query for CM Handle IDs
+ operationId: searchCmHandleIds
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
+ 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 8f8dfe2924..bd83dbf256 100755
--- a/cps-ncmp-rest/docs/openapi/openapi-inventory.yml
+++ b/cps-ncmp-rest/docs/openapi/openapi-inventory.yml
@@ -35,5 +35,9 @@ paths:
/v1/ch/cmHandles:
$ref: 'ncmp-inventory.yml#/getAllCmHandleIdsForRegisteredDmi'
+
+ /v1/ch/searches:
+ $ref: 'ncmp-inventory.yml#/searchCmHandleIds'
+
security:
- basicAuth: [] \ No newline at end of file