aboutsummaryrefslogtreecommitdiffstats
path: root/cps-ncmp-rest/docs/openapi/components.yaml
diff options
context:
space:
mode:
authorlukegleeson <luke.gleeson@est.tech>2022-10-20 10:14:00 +0100
committerlukegleeson <luke.gleeson@est.tech>2022-11-15 17:18:39 +0000
commit20e7a733d8a3657fd9932eaf8144f47777965533 (patch)
tree0776eaf8cb4de6689bdeae4ea7a1f688b29d56c8 /cps-ncmp-rest/docs/openapi/components.yaml
parentb99f0f00cb964af7b88a85c09bbb11f6c0b1f04d (diff)
Query data NCMP-Operational with CPSpath
New GET Endpoint: /v1/ch/{cm-handle}/data/ds/{ncmp-datastore-name}/query?cps-path={CPSPath} Implemented error for {ncmp-datastore-name} other than operational - (Toine) Refactored and renamed (abstract) handler for better re-use Mainly by introducing a separate handler for OperationalQuery Reviewers Toine, Sourabh, Priyank Issue-ID: CPS-1002 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: Iaca018869d95d4ce800072431baa190050a6dad0
Diffstat (limited to 'cps-ncmp-rest/docs/openapi/components.yaml')
-rw-r--r--cps-ncmp-rest/docs/openapi/components.yaml9
1 files changed, 7 insertions, 2 deletions
diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
index 7ca09ceed..b4b8c8467 100644
--- a/cps-ncmp-rest/docs/openapi/components.yaml
+++ b/cps-ncmp-rest/docs/openapi/components.yaml
@@ -456,11 +456,16 @@ components:
cpsPathInQuery:
name: cps-path
in: query
- description: cps-path
+ description: For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html
required: false
schema:
type: string
default: /
+ examples:
+ container cps path:
+ value: //bookstore
+ list attributes cps path:
+ value: //categories[@code=1]
dmiPluginIdentifierInQuery:
name: dmi-plugin-identifier
in: query
@@ -527,7 +532,7 @@ components:
default: application/json
example: application/yang-data+json
datastoreName:
- name: ncmp-datastore-name
+ name: datastore-name
in: path
description: The type of the requested data
required: true