summaryrefslogtreecommitdiffstats
path: root/docs/api
diff options
context:
space:
mode:
authordanielhanrahan <daniel.hanrahan@est.tech>2024-02-07 14:21:58 +0000
committerdanielhanrahan <daniel.hanrahan@est.tech>2024-02-07 14:27:33 +0000
commit7ce495b1e5871d42392b0b45fd3babd9fd5bd634 (patch)
tree542fe1870e17f41aa5138785d543d16d6162ffec /docs/api
parent50a9e57cd4793a541ff8d2ec97a4fb7a7d62b934 (diff)
Update release notes for CPS 3.4.3
- updated release notes for 3.4.3 - updated openapi files Issue-ID: CPS-2077 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: I2ded94a243dbe93885525d73f90dde3dbbb79696
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/swagger/ncmp/openapi.yaml41
1 files changed, 36 insertions, 5 deletions
diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml
index 8098faefcc..a1cc5d9ba7 100644
--- a/docs/api/swagger/ncmp/openapi.yaml
+++ b/docs/api/swagger/ncmp/openapi.yaml
@@ -918,9 +918,9 @@ paths:
- network-cm-proxy
/v1/ch/{cm-handle}/modules/definitions:
get:
- description: "Fetch all module definitions (name, revision, yang resource) for\
- \ a given cm handle"
- operationId: getModuleDefinitionsByCmHandleId
+ description: "Get module definitions (module name, revision, yang resource)\
+ \ with options to filter on module name and revision"
+ operationId: getModuleDefinitions
parameters:
- description: "The identifier for a network function, network element, subnetwork\
\ or any other cm object by managed Network CM Proxy"
@@ -930,6 +930,21 @@ paths:
schema:
example: my-cm-handle
type: string
+ - description: Filter for a module name.This is an optional parameter
+ in: query
+ name: module-name
+ required: false
+ schema:
+ example: my-module
+ type: string
+ - description: Filter for a module revision.This is an optional parameter and
+ ignored when no module name is supplied
+ in: query
+ name: revision
+ required: false
+ schema:
+ example: 2024-01-22
+ type: string
responses:
"200":
content:
@@ -969,8 +984,7 @@ paths:
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Internal Server Error
- summary: "Fetch all module definitions (name, revision, yang resource) for a\
- \ given cm handle"
+ summary: Get module definitions
tags:
- network-cm-proxy
/v1/ch/searches:
@@ -1666,6 +1680,23 @@ components:
schema:
default: /
type: string
+ moduleNameInQuery:
+ description: Filter for a module name.This is an optional parameter
+ in: query
+ name: module-name
+ required: false
+ schema:
+ example: my-module
+ type: string
+ revisionInQuery:
+ description: Filter for a module revision.This is an optional parameter and
+ ignored when no module name is supplied
+ in: query
+ name: revision
+ required: false
+ schema:
+ example: 2024-01-22
+ type: string
dataSyncEnabled:
description: Is used to enable or disable the data synchronization flag
in: query