summaryrefslogtreecommitdiffstats
path: root/cps-ncmp-rest/docs
diff options
context:
space:
mode:
authorlukegleeson <luke.gleeson@est.tech>2022-05-06 12:02:42 +0100
committerlukegleeson <luke.gleeson@est.tech>2022-05-20 14:43:05 +0100
commitbed18fd895d1ac240c7fdb361cb0ed994d392ecf (patch)
tree1ef6bf26c2dd4e295c99fe7060e8930c3bca74bf /cps-ncmp-rest/docs
parent806d31aed57c798cba0ecc33d92e5b43fa1d957b (diff)
Get cm-handle public properties endpoint
Added RestOuputCmHandlePublicProperties OpenApi Object Added Get cm-handle public properties endpoint Added rest and service layer functionality for endpoint with tests Fixed Copyright Checker violations Issue-ID: CPS-1018 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: Ifc13cde350a49f6ba705a09e31853dc9c73be168
Diffstat (limited to 'cps-ncmp-rest/docs')
-rw-r--r--cps-ncmp-rest/docs/openapi/components.yaml6
-rwxr-xr-xcps-ncmp-rest/docs/openapi/ncmp.yml21
-rwxr-xr-xcps-ncmp-rest/docs/openapi/openapi.yml3
3 files changed, 30 insertions, 0 deletions
diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
index 7ed2efe52a..32d25e3951 100644
--- a/cps-ncmp-rest/docs/openapi/components.yaml
+++ b/cps-ncmp-rest/docs/openapi/components.yaml
@@ -217,6 +217,12 @@ components:
type: string
example: Book Type
+ RestOutputCmHandlePublicProperties:
+ type: object
+ properties:
+ publicCmHandleProperties:
+ $ref: '#/components/schemas/CmHandlePublicProperties'
+
examples:
dataSampleRequest:
summary: Sample request
diff --git a/cps-ncmp-rest/docs/openapi/ncmp.yml b/cps-ncmp-rest/docs/openapi/ncmp.yml
index 05e4b84853..318e6e66d9 100755
--- a/cps-ncmp-rest/docs/openapi/ncmp.yml
+++ b/cps-ncmp-rest/docs/openapi/ncmp.yml
@@ -296,6 +296,27 @@ retrieveCmHandleDetailsById:
500:
$ref: 'components.yaml#/components/responses/InternalServerError'
+getCmHandlePropertiesById:
+ get:
+ description: Get CM handle properties by cm handle id
+ tags:
+ - network-cm-proxy
+ summary: Get CM handle properties
+ operationId: getCmHandlePublicPropertiesByCmHandleId
+ parameters:
+ - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: 'components.yaml#/components/schemas/RestOutputCmHandlePublicProperties'
+ 404:
+ $ref: 'components.yaml#/components/responses/NotFound'
+ 500:
+ $ref: 'components.yaml#/components/responses/InternalServerError'
+
queryCmHandles:
post:
description: Execute cm handle query search
diff --git a/cps-ncmp-rest/docs/openapi/openapi.yml b/cps-ncmp-rest/docs/openapi/openapi.yml
index 935b657e1f..b4082918f6 100755
--- a/cps-ncmp-rest/docs/openapi/openapi.yml
+++ b/cps-ncmp-rest/docs/openapi/openapi.yml
@@ -41,5 +41,8 @@ paths:
/v1/ch/{cm-handle}:
$ref: 'ncmp.yml#/retrieveCmHandleDetailsById'
+ /v1/ch/{cm-handle}/properties:
+ $ref: 'ncmp.yml#/getCmHandlePropertiesById'
+
/v1/data/ch/searches:
$ref: 'ncmp.yml#/queryCmHandles'