summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormpriyank <priyank.maheshwari@est.tech>2023-08-22 13:17:46 +0100
committerSourabh Sourabh <sourabh.sourabh@est.tech>2023-08-22 14:48:31 +0000
commit41c7d00a68c0dd6a0fc49f6b22cc5a19753edea9 (patch)
tree72336df14b2bc03aeb8f033bb35b7be370cba384
parent7a9770088999e03f743fbea9c945e8c08a3f47b6 (diff)
Release notes and openapi yml update
- add to rst file and update the rest api changes Issue-ID: CPS-1846 Change-Id: I242fc98c025ffe0bf654640ad16dfef2bb0fcbaf Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
-rw-r--r--docs/api/swagger/cps/openapi.yaml1632
-rw-r--r--docs/api/swagger/ncmp/openapi-inventory.yaml172
-rw-r--r--docs/api/swagger/ncmp/openapi.yaml1004
-rwxr-xr-xdocs/release-notes.rst1
4 files changed, 1414 insertions, 1395 deletions
diff --git a/docs/api/swagger/cps/openapi.yaml b/docs/api/swagger/cps/openapi.yaml
index 0e2191b675..453494ec49 100644
--- a/docs/api/swagger/cps/openapi.yaml
+++ b/docs/api/swagger/cps/openapi.yaml
@@ -15,14 +15,14 @@ info:
x-logo:
url: cps_logo.png
servers:
- - url: /cps/api
+- url: /cps/api
security:
- - basicAuth: []
+- basicAuth: []
tags:
- - description: cps Admin
- name: cps-admin
- - description: cps Data
- name: cps-data
+- description: cps Admin
+ name: cps-admin
+- description: cps Data
+ name: cps-data
paths:
/v1/dataspaces:
post:
@@ -30,13 +30,13 @@ paths:
description: Create a new dataspace
operationId: createDataspace
parameters:
- - description: dataspace-name
- in: query
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
+ - description: dataspace-name
+ in: query
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
responses:
"201":
content:
@@ -97,29 +97,29 @@ paths:
description: Internal Server Error
summary: Create a dataspace
tags:
- - cps-admin
+ - cps-admin
/{apiVersion}/dataspaces:
delete:
description: Delete a dataspace
operationId: deleteDataspace
parameters:
- - description: apiVersion
- in: path
- name: apiVersion
- required: true
- schema:
- default: v2
- enum:
- - v1
- - v2
- type: string
- - description: dataspace-name
- in: query
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
+ - description: apiVersion
+ in: path
+ name: apiVersion
+ required: true
+ schema:
+ default: v2
+ enum:
+ - v1
+ - v2
+ type: string
+ - description: dataspace-name
+ in: query
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
responses:
"204":
content: {}
@@ -176,19 +176,19 @@ paths:
description: Internal Server Error
summary: Delete a dataspace
tags:
- - cps-admin
+ - cps-admin
/v2/dataspaces:
post:
description: Create a new dataspace
operationId: createDataspaceV2
parameters:
- - description: dataspace-name
- in: query
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
+ - description: dataspace-name
+ in: query
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
responses:
"201":
description: Created without response body
@@ -244,22 +244,22 @@ paths:
description: Internal Server Error
summary: Create a dataspace
tags:
- - cps-admin
+ - cps-admin
/{apiVersion}/admin/dataspaces:
get:
description: Read all dataspaces
operationId: getAllDataspaces
parameters:
- - description: apiVersion
- in: path
- name: apiVersion
- required: true
- schema:
- default: v2
- enum:
- - v1
- - v2
- type: string
+ - description: apiVersion
+ in: path
+ name: apiVersion
+ required: true
+ schema:
+ default: v2
+ enum:
+ - v1
+ - v2
+ type: string
responses:
"200":
content:
@@ -311,29 +311,29 @@ paths:
description: Internal Server Error
summary: Get all dataspaces
tags:
- - cps-admin
+ - cps-admin
/{apiVersion}/admin/dataspaces/{dataspace-name}:
get:
description: Read a dataspace given a dataspace name
operationId: getDataspace
parameters:
- - description: apiVersion
- in: path
- name: apiVersion
- required: true
- schema:
- default: v2
- enum:
- - v1
- - v2
- type: string
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
+ - description: apiVersion
+ in: path
+ name: apiVersion
+ required: true
+ schema:
+ default: v2
+ enum:
+ - v1
+ - v2
+ type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
responses:
"200":
content:
@@ -383,34 +383,34 @@ paths:
description: Internal Server Error
summary: Get a dataspace
tags:
- - cps-admin
+ - cps-admin
/v1/dataspaces/{dataspace-name}/anchors:
post:
deprecated: true
description: Create a new anchor in the given dataspace
operationId: createAnchor
parameters:
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: schema-set-name
- in: query
- name: schema-set-name
- required: true
- schema:
- example: my-schema-set
- type: string
- - description: anchor-name
- in: query
- name: anchor-name
- required: true
- schema:
- example: my-anchor
- type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: schema-set-name
+ in: query
+ name: schema-set-name
+ required: true
+ schema:
+ example: my-schema-set
+ type: string
+ - description: anchor-name
+ in: query
+ name: anchor-name
+ required: true
+ schema:
+ example: my-anchor
+ type: string
responses:
"201":
content:
@@ -471,33 +471,33 @@ paths:
description: Internal Server Error
summary: Create an anchor
tags:
- - cps-admin
+ - cps-admin
/v2/dataspaces/{dataspace-name}/anchors:
post:
description: Create a new anchor in the given dataspace
operationId: createAnchorV2
parameters:
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: schema-set-name
- in: query
- name: schema-set-name
- required: true
- schema:
- example: my-schema-set
- type: string
- - description: anchor-name
- in: query
- name: anchor-name
- required: true
- schema:
- example: my-anchor
- type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: schema-set-name
+ in: query
+ name: schema-set-name
+ required: true
+ schema:
+ example: my-schema-set
+ type: string
+ - description: anchor-name
+ in: query
+ name: anchor-name
+ required: true
+ schema:
+ example: my-anchor
+ type: string
responses:
"201":
description: Created without response body
@@ -553,29 +553,29 @@ paths:
description: Internal Server Error
summary: Create an anchor
tags:
- - cps-admin
+ - cps-admin
/{apiVersion}/dataspaces/{dataspace-name}/anchors:
get:
description: "Read all anchors, given a dataspace"
operationId: getAnchors
parameters:
- - description: apiVersion
- in: path
- name: apiVersion
- required: true
- schema:
- default: v2
- enum:
- - v1
- - v2
- type: string
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
+ - description: apiVersion
+ in: path
+ name: apiVersion
+ required: true
+ schema:
+ default: v2
+ enum:
+ - v1
+ - v2
+ type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
responses:
"200":
content:
@@ -627,36 +627,36 @@ paths:
description: Internal Server Error
summary: Get anchors
tags:
- - cps-admin
+ - cps-admin
/{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}:
delete:
description: Delete an anchor given an anchor name and a dataspace
operationId: deleteAnchor
parameters:
- - description: apiVersion
- in: path
- name: apiVersion
- required: true
- schema:
- default: v2
- enum:
- - v1
- - v2
- type: string
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: anchor-name
- in: path
- name: anchor-name
- required: true
- schema:
- example: my-anchor
- type: string
+ - description: apiVersion
+ in: path
+ name: apiVersion
+ required: true
+ schema:
+ default: v2
+ enum:
+ - v1
+ - v2
+ type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: anchor-name
+ in: path
+ name: anchor-name
+ required: true
+ schema:
+ example: my-anchor
+ type: string
responses:
"204":
content: {}
@@ -703,35 +703,35 @@ paths:
description: Internal Server Error
summary: Delete an anchor
tags:
- - cps-admin
+ - cps-admin
get:
description: Read an anchor given an anchor name and a dataspace
operationId: getAnchor
parameters:
- - description: apiVersion
- in: path
- name: apiVersion
- required: true
- schema:
- default: v2
- enum:
- - v1
- - v2
- type: string
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: anchor-name
- in: path
- name: anchor-name
- required: true
- schema:
- example: my-anchor
- type: string
+ - description: apiVersion
+ in: path
+ name: apiVersion
+ required: true
+ schema:
+ default: v2
+ enum:
+ - v1
+ - v2
+ type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: anchor-name
+ in: path
+ name: anchor-name
+ required: true
+ schema:
+ example: my-anchor
+ type: string
responses:
"200":
content:
@@ -781,27 +781,27 @@ paths:
description: Internal Server Error
summary: Get an anchor
tags:
- - cps-admin
+ - cps-admin
/v1/dataspaces/{dataspace-name}/schema-sets:
post:
deprecated: true
description: Create a new schema set in the given dataspace
operationId: createSchemaSet
parameters:
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: schema-set-name
- in: query
- name: schema-set-name
- required: true
- schema:
- example: my-schema-set
- type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: schema-set-name
+ in: query
+ name: schema-set-name
+ required: true
+ schema:
+ example: my-schema-set
+ type: string
requestBody:
content:
multipart/form-data:
@@ -868,26 +868,26 @@ paths:
description: Internal Server Error
summary: Create a schema set
tags:
- - cps-admin
+ - cps-admin
/v2/dataspaces/{dataspace-name}/schema-sets:
post:
description: Create a new schema set in the given dataspace
operationId: createSchemaSetV2
parameters:
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: schema-set-name
- in: query
- name: schema-set-name
- required: true
- schema:
- example: my-schema-set
- type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: schema-set-name
+ in: query
+ name: schema-set-name
+ required: true
+ schema:
+ example: my-schema-set
+ type: string
requestBody:
content:
multipart/form-data:
@@ -949,29 +949,29 @@ paths:
description: Internal Server Error
summary: Create a schema set
tags:
- - cps-admin
+ - cps-admin
/{apiVersion}/dataspaces/{dataspace-name}/schema-sets:
get:
description: "Read all schema sets, given a dataspace"
operationId: getSchemaSets
parameters:
- - description: apiVersion
- in: path
- name: apiVersion
- required: true
- schema:
- default: v2
- enum:
- - v1
- - v2
- type: string
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
+ - description: apiVersion
+ in: path
+ name: apiVersion
+ required: true
+ schema:
+ default: v2
+ enum:
+ - v1
+ - v2
+ type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
responses:
"200":
content:
@@ -1023,36 +1023,36 @@ paths:
description: Internal Server Error
summary: Get schema sets
tags:
- - cps-admin
+ - cps-admin
/{apiVersion}/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}:
delete:
description: Delete a schema set given a schema set name and a dataspace
operationId: deleteSchemaSet
parameters:
- - description: apiVersion
- in: path
- name: apiVersion
- required: true
- schema:
- default: v2
- enum:
- - v1
- - v2
- type: string
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: schema-set-name
- in: path
- name: schema-set-name
- required: true
- schema:
- example: my-schema-set
- type: string
+ - description: apiVersion
+ in: path
+ name: apiVersion
+ required: true
+ schema:
+ default: v2
+ enum:
+ - v1
+ - v2
+ type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: schema-set-name
+ in: path
+ name: schema-set-name
+ required: true
+ schema:
+ example: my-schema-set
+ type: string
responses:
"204":
content: {}
@@ -1109,35 +1109,35 @@ paths:
description: Internal Server Error
summary: Delete a schema set
tags:
- - cps-admin
+ - cps-admin
get:
description: Read a schema set given a schema set name and a dataspace
operationId: getSchemaSet
parameters:
- - description: apiVersion
- in: path
- name: apiVersion
- required: true
- schema:
- default: v2
- enum:
- - v1
- - v2
- type: string
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: schema-set-name
- in: path
- name: schema-set-name
- required: true
- schema:
- example: my-schema-set
- type: string
+ - description: apiVersion
+ in: path
+ name: apiVersion
+ required: true
+ schema:
+ default: v2
+ enum:
+ - v1
+ - v2
+ type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: schema-set-name
+ in: path
+ name: schema-set-name
+ required: true
+ schema:
+ example: my-schema-set
+ type: string
responses:
"200":
content:
@@ -1187,7 +1187,7 @@ paths:
description: Internal Server Error
summary: Get a schema set
tags:
- - cps-admin
+ - cps-admin
/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
get:
deprecated: true
@@ -1195,40 +1195,40 @@ paths:
anchor and dataspace
operationId: getNodeByDataspaceAndAnchor
parameters:
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: anchor-name
- in: path
- name: anchor-name
- required: true
- schema:
- example: my-anchor
- type: string
- - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
- examples:
- container xpath:
- value: /shops/bookstore
- list attributes xpath:
- value: "/shops/bookstore/categories[@code=1]"
- in: query
- name: xpath
- required: false
- schema:
- default: /
- type: string
- - description: include-descendants
- in: query
- name: include-descendants
- required: false
- schema:
- default: false
- example: false
- type: boolean
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: anchor-name
+ in: path
+ name: anchor-name
+ required: true
+ schema:
+ example: my-anchor
+ type: string
+ - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
+ examples:
+ container xpath:
+ value: /shops/bookstore
+ list attributes xpath:
+ value: "/shops/bookstore/categories[@code=1]"
+ in: query
+ name: xpath
+ required: false
+ schema:
+ default: /
+ type: string
+ - description: include-descendants
+ in: query
+ name: include-descendants
+ required: false
+ schema:
+ default: false
+ example: false
+ type: boolean
responses:
"200":
content:
@@ -1282,7 +1282,7 @@ paths:
description: Internal Server Error
summary: Get a node
tags:
- - cps-data
+ - cps-data
x-codegen-request-body-name: xpath
/v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
get:
@@ -1290,41 +1290,42 @@ paths:
anchor and dataspace
operationId: getNodeByDataspaceAndAnchorV2
parameters:
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: anchor-name
- in: path
- name: anchor-name
- required: true
- schema:
- example: my-anchor
- type: string
- - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
- examples:
- container xpath:
- value: /shops/bookstore
- list attributes xpath:
- value: "/shops/bookstore/categories[@code=1]"
- in: query
- name: xpath
- required: false
- schema:
- default: /
- type: string
- - description: "Number of descendants to query. Allowed values are 'none', 'all', 'direct',\
- \ 1 (for direct), -1 (for all), 0 (for none) and any positive number."
- in: query
- name: descendants
- required: false
- schema:
- default: none
- example: "3"
- type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: anchor-name
+ in: path
+ name: anchor-name
+ required: true
+ schema:
+ example: my-anchor
+ type: string
+ - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
+ examples:
+ container xpath:
+ value: /shops/bookstore
+ list attributes xpath:
+ value: "/shops/bookstore/categories[@code=1]"
+ in: query
+ name: xpath
+ required: false
+ schema:
+ default: /
+ type: string
+ - description: "Number of descendants to query. Allowed values are 'none', 'all',\
+ \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive\
+ \ number."
+ in: query
+ name: descendants
+ required: false
+ schema:
+ default: none
+ example: "3"
+ type: string
responses:
"200":
content:
@@ -1378,7 +1379,7 @@ paths:
description: Internal Server Error
summary: Get a node
tags:
- - cps-data
+ - cps-data
x-codegen-request-body-name: xpath
/{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
delete:
@@ -1386,49 +1387,49 @@ paths:
xpath.
operationId: deleteDataNode
parameters:
- - description: apiVersion
- in: path
- name: apiVersion
- required: true
- schema:
- default: v2
- enum:
- - v1
- - v2
- type: string
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: anchor-name
- in: path
- name: anchor-name
- required: true
- schema:
- example: my-anchor
- type: string
- - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
- examples:
- container xpath:
- value: /shops/bookstore
- list attributes xpath:
- value: "/shops/bookstore/categories[@code=1]"
- in: query
- name: xpath
- required: false
- schema:
- default: /
- type: string
- - description: observed-timestamp
- in: query
- name: observed-timestamp
- required: false
- schema:
- example: 2021-03-21T00:10:34.030-0100
- type: string
+ - description: apiVersion
+ in: path
+ name: apiVersion
+ required: true
+ schema:
+ default: v2
+ enum:
+ - v1
+ - v2
+ type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: anchor-name
+ in: path
+ name: anchor-name
+ required: true
+ schema:
+ example: my-anchor
+ type: string
+ - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
+ examples:
+ container xpath:
+ value: /shops/bookstore
+ list attributes xpath:
+ value: "/shops/bookstore/categories[@code=1]"
+ in: query
+ name: xpath
+ required: false
+ schema:
+ default: /
+ type: string
+ - description: observed-timestamp
+ in: query
+ name: observed-timestamp
+ required: false
+ schema:
+ example: 2021-03-21T00:10:34.030-0100
+ type: string
responses:
"204":
content: {}
@@ -1475,56 +1476,56 @@ paths:
description: Internal Server Error
summary: Delete a data node
tags:
- - cps-data
+ - cps-data
patch:
description: Update a data node leaves for a given dataspace and anchor and
a parent node xpath. This operation is currently supported for one top level
data node only.
operationId: updateNodeLeaves
parameters:
- - description: apiVersion
- in: path
- name: apiVersion
- required: true
- schema:
- default: v2
- enum:
- - v1
- - v2
- type: string
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: anchor-name
- in: path
- name: anchor-name
- required: true
- schema:
- example: my-anchor
- type: string
- - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
- examples:
- container xpath:
- value: /shops/bookstore
- list attributes xpath:
- value: "/shops/bookstore/categories[@code=1]"
- in: query
- name: xpath
- required: false
- schema:
- default: /
- type: string
- - description: observed-timestamp
- in: query
- name: observed-timestamp
- required: false
- schema:
- example: 2021-03-21T00:10:34.030-0100
- type: string
+ - description: apiVersion
+ in: path
+ name: apiVersion
+ required: true
+ schema:
+ default: v2
+ enum:
+ - v1
+ - v2
+ type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: anchor-name
+ in: path
+ name: anchor-name
+ required: true
+ schema:
+ example: my-anchor
+ type: string
+ - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
+ examples:
+ container xpath:
+ value: /shops/bookstore
+ list attributes xpath:
+ value: "/shops/bookstore/categories[@code=1]"
+ in: query
+ name: xpath
+ required: false
+ schema:
+ default: /
+ type: string
+ - description: observed-timestamp
+ in: query
+ name: observed-timestamp
+ required: false
+ schema:
+ example: 2021-03-21T00:10:34.030-0100
+ type: string
requestBody:
content:
application/json:
@@ -1587,61 +1588,61 @@ paths:
description: Internal Server Error
summary: Update node leaves
tags:
- - cps-data
+ - cps-data
post:
description: Create a node for a given anchor and dataspace
operationId: createNode
parameters:
- - description: apiVersion
- in: path
- name: apiVersion
- required: true
- schema:
- default: v2
- enum:
- - v1
- - v2
- type: string
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: anchor-name
- in: path
- name: anchor-name
- required: true
- schema:
- example: my-anchor
- type: string
- - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
- examples:
- container xpath:
- value: /shops/bookstore
- list attributes xpath:
- value: "/shops/bookstore/categories[@code=1]"
- in: query
- name: xpath
- required: false
- schema:
- default: /
- type: string
- - description: observed-timestamp
- in: query
- name: observed-timestamp
- required: false
- schema:
- example: 2021-03-21T00:10:34.030-0100
- type: string
- - description: Content type header
- in: header
- name: Content-Type
- required: true
- schema:
- example: application/json
- type: string
+ - description: apiVersion
+ in: path
+ name: apiVersion
+ required: true
+ schema:
+ default: v2
+ enum:
+ - v1
+ - v2
+ type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: anchor-name
+ in: path
+ name: anchor-name
+ required: true
+ schema:
+ example: my-anchor
+ type: string
+ - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
+ examples:
+ container xpath:
+ value: /shops/bookstore
+ list attributes xpath:
+ value: "/shops/bookstore/categories[@code=1]"
+ in: query
+ name: xpath
+ required: false
+ schema:
+ default: /
+ type: string
+ - description: observed-timestamp
+ in: query
+ name: observed-timestamp
+ required: false
+ schema:
+ example: 2021-03-21T00:10:34.030-0100
+ type: string
+ - description: Content type header
+ in: header
+ name: Content-Type
+ required: true
+ schema:
+ example: application/json
+ type: string
requestBody:
content:
application/json:
@@ -1721,55 +1722,55 @@ paths:
description: Internal Server Error
summary: Create a node
tags:
- - cps-data
+ - cps-data
put:
description: "Replace a node with descendants for a given dataspace, anchor\
\ and a parent node xpath"
operationId: replaceNode
parameters:
- - description: apiVersion
- in: path
- name: apiVersion
- required: true
- schema:
- default: v2
- enum:
- - v1
- - v2
- type: string
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: anchor-name
- in: path
- name: anchor-name
- required: true
- schema:
- example: my-anchor
- type: string
- - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
- examples:
- container xpath:
- value: /shops/bookstore
- list attributes xpath:
- value: "/shops/bookstore/categories[@code=1]"
- in: query
- name: xpath
- required: false
- schema:
- default: /
- type: string
- - description: observed-timestamp
- in: query
- name: observed-timestamp
- required: false
- schema:
- example: 2021-03-21T00:10:34.030-0100
- type: string
+ - description: apiVersion
+ in: path
+ name: apiVersion
+ required: true
+ schema:
+ default: v2
+ enum:
+ - v1
+ - v2
+ type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: anchor-name
+ in: path
+ name: anchor-name
+ required: true
+ schema:
+ example: my-anchor
+ type: string
+ - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
+ examples:
+ container xpath:
+ value: /shops/bookstore
+ list attributes xpath:
+ value: "/shops/bookstore/categories[@code=1]"
+ in: query
+ name: xpath
+ required: false
+ schema:
+ default: /
+ type: string
+ - description: observed-timestamp
+ in: query
+ name: observed-timestamp
+ required: false
+ schema:
+ example: 2021-03-21T00:10:34.030-0100
+ type: string
requestBody:
content:
application/json:
@@ -1832,45 +1833,45 @@ paths:
description: Internal Server Error
summary: Replace a node with descendants
tags:
- - cps-data
+ - cps-data
/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
delete:
deprecated: true
description: Delete one or all list element(s) for a given anchor and dataspace
operationId: deleteListOrListElement
parameters:
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: anchor-name
- in: path
- name: anchor-name
- required: true
- schema:
- example: my-anchor
- type: string
- - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
- examples:
- container xpath:
- value: /shops/bookstore
- list attributes xpath:
- value: "/shops/bookstore/categories[@code=1]"
- in: query
- name: xpath
- required: true
- schema:
- type: string
- - description: observed-timestamp
- in: query
- name: observed-timestamp
- required: false
- schema:
- example: 2021-03-21T00:10:34.030-0100
- type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: anchor-name
+ in: path
+ name: anchor-name
+ required: true
+ schema:
+ example: my-anchor
+ type: string
+ - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
+ examples:
+ container xpath:
+ value: /shops/bookstore
+ list attributes xpath:
+ value: "/shops/bookstore/categories[@code=1]"
+ in: query
+ name: xpath
+ required: true
+ schema:
+ type: string
+ - description: observed-timestamp
+ in: query
+ name: observed-timestamp
+ required: false
+ schema:
+ example: 2021-03-21T00:10:34.030-0100
+ type: string
responses:
"204":
content: {}
@@ -1917,54 +1918,54 @@ paths:
description: Internal Server Error
summary: Delete one or all list element(s)
tags:
- - cps-data
+ - cps-data
/{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
post:
description: Add list element(s) to a list for a given anchor and dataspace
operationId: addListElements
parameters:
- - description: apiVersion
- in: path
- name: apiVersion
- required: true
- schema:
- default: v2
- enum:
- - v1
- - v2
- type: string
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: anchor-name
- in: path
- name: anchor-name
- required: true
- schema:
- example: my-anchor
- type: string
- - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
- examples:
- container xpath:
- value: /shops/bookstore
- list attributes xpath:
- value: "/shops/bookstore/categories[@code=1]"
- in: query
- name: xpath
- required: true
- schema:
- type: string
- - description: observed-timestamp
- in: query
- name: observed-timestamp
- required: false
- schema:
- example: 2021-03-21T00:10:34.030-0100
- type: string
+ - description: apiVersion
+ in: path
+ name: apiVersion
+ required: true
+ schema:
+ default: v2
+ enum:
+ - v1
+ - v2
+ type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: anchor-name
+ in: path
+ name: anchor-name
+ required: true
+ schema:
+ example: my-anchor
+ type: string
+ - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
+ examples:
+ container xpath:
+ value: /shops/bookstore
+ list attributes xpath:
+ value: "/shops/bookstore/categories[@code=1]"
+ in: query
+ name: xpath
+ required: true
+ schema:
+ type: string
+ - description: observed-timestamp
+ in: query
+ name: observed-timestamp
+ required: false
+ schema:
+ example: 2021-03-21T00:10:34.030-0100
+ type: string
requestBody:
content:
application/json:
@@ -2025,53 +2026,53 @@ paths:
description: Internal Server Error
summary: Add list element(s)
tags:
- - cps-data
+ - cps-data
put:
description: "Replace list content under a given parent, anchor and dataspace"
operationId: replaceListContent
parameters:
- - description: apiVersion
- in: path
- name: apiVersion
- required: true
- schema:
- default: v2
- enum:
- - v1
- - v2
- type: string
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: anchor-name
- in: path
- name: anchor-name
- required: true
- schema:
- example: my-anchor
- type: string
- - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
- examples:
- container xpath:
- value: /shops/bookstore
- list attributes xpath:
- value: "/shops/bookstore/categories[@code=1]"
- in: query
- name: xpath
- required: true
- schema:
- type: string
- - description: observed-timestamp
- in: query
- name: observed-timestamp
- required: false
- schema:
- example: 2021-03-21T00:10:34.030-0100
- type: string
+ - description: apiVersion
+ in: path
+ name: apiVersion
+ required: true
+ schema:
+ default: v2
+ enum:
+ - v1
+ - v2
+ type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: anchor-name
+ in: path
+ name: anchor-name
+ required: true
+ schema:
+ example: my-anchor
+ type: string
+ - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
+ examples:
+ container xpath:
+ value: /shops/bookstore
+ list attributes xpath:
+ value: "/shops/bookstore/categories[@code=1]"
+ in: query
+ name: xpath
+ required: true
+ schema:
+ type: string
+ - description: observed-timestamp
+ in: query
+ name: observed-timestamp
+ required: false
+ schema:
+ example: 2021-03-21T00:10:34.030-0100
+ type: string
requestBody:
content:
application/json:
@@ -2134,47 +2135,47 @@ paths:
description: Internal Server Error
summary: Replace list content
tags:
- - cps-data
+ - cps-data
/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
get:
deprecated: true
description: Query data nodes for the given dataspace and anchor using CPS path
operationId: getNodesByDataspaceAndAnchorAndCpsPath
parameters:
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: anchor-name
- in: path
- name: anchor-name
- required: true
- schema:
- example: my-anchor
- type: string
- - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
- examples:
- container cps path:
- value: //bookstore
- list attributes cps path:
- value: "//categories[@code=1]"
- in: query
- name: cps-path
- required: false
- schema:
- default: /
- type: string
- - description: include-descendants
- in: query
- name: include-descendants
- required: false
- schema:
- default: false
- example: false
- type: boolean
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: anchor-name
+ in: path
+ name: anchor-name
+ required: true
+ schema:
+ example: my-anchor
+ type: string
+ - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
+ examples:
+ container cps path:
+ value: //bookstore
+ list attributes cps path:
+ value: "//categories[@code=1]"
+ in: query
+ name: cps-path
+ required: false
+ schema:
+ default: /
+ type: string
+ - description: include-descendants
+ in: query
+ name: include-descendants
+ required: false
+ schema:
+ default: false
+ example: false
+ type: boolean
responses:
"200":
content:
@@ -2228,48 +2229,49 @@ paths:
description: Internal Server Error
summary: Query data nodes
tags:
- - cps-query
+ - cps-query
x-codegen-request-body-name: xpath
/v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
get:
description: Query data nodes for the given dataspace and anchor using CPS path
operationId: getNodesByDataspaceAndAnchorAndCpsPathV2
parameters:
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: anchor-name
- in: path
- name: anchor-name
- required: true
- schema:
- example: my-anchor
- type: string
- - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
- examples:
- container cps path:
- value: //bookstore
- list attributes cps path:
- value: "//categories[@code=1]"
- in: query
- name: cps-path
- required: false
- schema:
- default: /
- type: string
- - description: "Number of descendants to query. Allowed values are 'none', 'all', 'direct',\
- \ 1 (for direct), -1 (for all), 0 (for none) and any positive number."
- in: query
- name: descendants
- required: false
- schema:
- default: none
- example: "3"
- type: string
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: anchor-name
+ in: path
+ name: anchor-name
+ required: true
+ schema:
+ example: my-anchor
+ type: string
+ - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
+ examples:
+ container cps path:
+ value: //bookstore
+ list attributes cps path:
+ value: "//categories[@code=1]"
+ in: query
+ name: cps-path
+ required: false
+ schema:
+ default: /
+ type: string
+ - description: "Number of descendants to query. Allowed values are 'none', 'all',\
+ \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive\
+ \ number."
+ in: query
+ name: descendants
+ required: false
+ schema:
+ default: none
+ example: "3"
+ type: string
responses:
"200":
content:
@@ -2323,7 +2325,7 @@ paths:
description: Internal Server Error
summary: Query data nodes
tags:
- - cps-query
+ - cps-query
x-codegen-request-body-name: xpath
/v2/dataspaces/{dataspace-name}/nodes/query:
get:
@@ -2331,48 +2333,51 @@ paths:
path
operationId: getNodesByDataspaceAndCpsPath
parameters:
- - description: dataspace-name
- in: path
- name: dataspace-name
- required: true
- schema:
- example: my-dataspace
- type: string
- - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
- examples:
- container cps path:
- value: //bookstore
- list attributes cps path:
- value: "//categories[@code=1]"
- in: query
- name: cps-path
- required: false
- schema:
- default: /
- type: string
- - description: "Number of descendants to query. Allowed values are 'none', 'all', 'direct',\
- \ 1 (for direct), -1 (for all), 0 (for none) and any positive number."
- in: query
- name: descendants
- required: false
- schema:
- default: none
- example: "3"
- type: string
- - description: "page index for pagination over anchors"
- name: pageIndex
- in: query
- required: false
- schema:
- type: integer
- minimum: 1
- - description: "number of records (anchors) to query per page"
- name: pageSize
- in: query
- required: false
- schema:
- type: integer
- minimum: 1
+ - description: dataspace-name
+ in: path
+ name: dataspace-name
+ required: true
+ schema:
+ example: my-dataspace
+ type: string
+ - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
+ examples:
+ container cps path:
+ value: //bookstore
+ list attributes cps path:
+ value: "//categories[@code=1]"
+ in: query
+ name: cps-path
+ required: false
+ schema:
+ default: /
+ type: string
+ - description: "Number of descendants to query. Allowed values are 'none', 'all',\
+ \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive\
+ \ number."
+ in: query
+ name: descendants
+ required: false
+ schema:
+ default: none
+ example: "3"
+ type: string
+ - description: page index for pagination over anchors. It must be greater then
+ zero if provided.
+ in: query
+ name: pageIndex
+ required: false
+ schema:
+ example: 1
+ type: integer
+ - description: number of records (anchors) per page. It must be greater then
+ zero if provided.
+ in: query
+ name: pageSize
+ required: false
+ schema:
+ example: 10
+ type: integer
responses:
"200":
content:
@@ -2384,11 +2389,6 @@ paths:
schema:
type: object
description: OK
- headers:
- total-pages:
- schema:
- type: integer
- description: Total number of pages for given page size
"400":
content:
application/json:
@@ -2429,9 +2429,9 @@ paths:
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Internal Server Error
- summary: Query data nodes
+ summary: Query data nodes across anchors
tags:
- - cps-query
+ - cps-query
x-codegen-request-body-name: xpath
components:
examples:
@@ -2440,34 +2440,34 @@ components:
test:bookstore:
bookstore-name: Chapters
categories:
- - code: 1
- name: SciFi
- - code: 2
- name: kids
+ - code: 1
+ name: SciFi
+ - code: 2
+ name: kids
dataSampleXml:
value: <stores xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <bookstore xmlns="org:onap:ccsdk:sample">
<bookstore-name>Chapters</bookstore-name> <categories> <code>1</code> <name>SciFi</name>
</categories> </bookstore> </stores>
dataSampleAcrossAnchors:
value:
- - anchorName: bookstore1
- dataNode:
- test:bookstore:
- bookstore-name: Chapters
- categories:
- - code: 1
- name: SciFi
- - code: 2
- name: kids
- - anchorName: bookstore2
- dataNode:
- test:bookstore:
- bookstore-name: Chapters
- categories:
- - code: 1
- name: SciFi
- - code: 2
- name: kids
+ - anchorName: bookstore1
+ dataNode:
+ test:bookstore:
+ bookstore-name: Chapters
+ categories:
+ - code: 1
+ name: SciFi
+ - code: 2
+ name: kids
+ - anchorName: bookstore2
+ dataNode:
+ test:bookstore:
+ bookstore-name: Chapters
+ categories:
+ - code: 1
+ name: SciFi
+ - code: 2
+ name: kids
parameters:
dataspaceNameInQuery:
description: dataspace-name
@@ -2485,8 +2485,8 @@ components:
schema:
default: v2
enum:
- - v1
- - v2
+ - v1
+ - v2
type: string
dataspaceNameInPath:
description: dataspace-name
@@ -2551,8 +2551,8 @@ components:
example: false
type: boolean
descendantsInQuery:
- description: "Number of descendants to query. Allowed values are 'none', 'all', 'direct',\
- \ 1 (for direct), -1 (for all), 0 (for none) and any positive number."
+ description: "Number of descendants to query. Allowed values are 'none', 'all',\
+ \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive number."
in: query
name: descendants
required: false
@@ -2601,6 +2601,24 @@ components:
schema:
default: /
type: string
+ pageIndexInQuery:
+ description: page index for pagination over anchors. It must be greater then
+ zero if provided.
+ in: query
+ name: pageIndex
+ required: false
+ schema:
+ example: 1
+ type: integer
+ pageSizeInQuery:
+ description: number of records (anchors) per page. It must be greater then zero
+ if provided.
+ in: query
+ name: pageSize
+ required: false
+ schema:
+ example: 10
+ type: integer
responses:
Created:
content:
@@ -2720,19 +2738,19 @@ components:
format: binary
type: string
required:
- - file
+ - file
type: object
SchemaSetDetails:
example:
dataspaceName: my-dataspace
name: my-schema-set
moduleReferences:
- - name: my-module-reference-name
- namespace: my-module-reference-namespace
- revision: my-module-reference-revision
- - name: my-module-reference-name
- namespace: my-module-reference-namespace
- revision: my-module-reference-revision
+ - name: my-module-reference-name
+ namespace: my-module-reference-namespace
+ revision: my-module-reference-revision
+ - name: my-module-reference-name
+ namespace: my-module-reference-namespace
+ revision: my-module-reference-revision
properties:
dataspaceName:
example: my-dataspace
@@ -2745,7 +2763,7 @@ components:
example: my-schema-set
type: string
required:
- - moduleReferences
+ - moduleReferences
title: Schema set details by dataspace and schemasetName
type: object
ModuleReferences:
@@ -2768,4 +2786,4 @@ components:
securitySchemes:
basicAuth:
scheme: basic
- type: http \ No newline at end of file
+ type: http
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
index bb4cca0cb7..6203c857a5 100644
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -4,9 +4,9 @@ info:
title: NCMP Inventory API
version: "1.0"
servers:
- - url: /ncmpInventory
+- url: /ncmpInventory
security:
- - basicAuth: []
+- basicAuth: []
paths:
/v1/ch:
post:
@@ -57,35 +57,35 @@ paths:
application/json:
example:
failedCreatedCmHandles:
- - cmHandle: my-cm-handle-01
- errorCode: "00"
- errorText: Unknown error. <error-details>
- - cmHandle: my-cm-handle-02
- errorCode: "01"
- errorText: cm-handle already exists
- - cmHandle: my-cm-handle-03
- errorCode: "03"
- errorText: cm-handle has an invalid character(s) in id
+ - cmHandle: my-cm-handle-01
+ errorCode: "00"
+ errorText: Unknown error. <error-details>
+ - cmHandle: my-cm-handle-02
+ errorCode: "01"
+ errorText: cm-handle already exists
+ - cmHandle: my-cm-handle-03
+ errorCode: "03"
+ errorText: cm-handle has an invalid character(s) in id
failedUpdatedCmHandles:
- - cmHandle: my-cm-handle-01
- errorCode: "00"
- errorText: Unknown error. <error-details>
- - cmHandle: my-cm-handle-02
- errorCode: "02"
- errorText: cm-handle does not exist
- - cmHandle: my-cm-handle-03
- errorCode: "03"
- errorText: cm-handle has an invalid character(s) in id
+ - cmHandle: my-cm-handle-01
+ errorCode: "00"
+ errorText: Unknown error. <error-details>
+ - cmHandle: my-cm-handle-02
+ errorCode: "02"
+ errorText: cm-handle does not exist
+ - cmHandle: my-cm-handle-03
+ errorCode: "03"
+ errorText: cm-handle has an invalid character(s) in id
failedRemovedCmHandles:
- - cmHandle: my-cm-handle-01
- errorCode: "00"
- errorText: Unknown error. <error-details>
- - cmHandle: my-cm-handle-02
- errorCode: "02"
- errorText: cm-handle does not exists
- - cmHandle: my-cm-handle-03
- errorCode: "03"
- errorText: cm-handle has an invalid character(s) in id
+ - cmHandle: my-cm-handle-01
+ errorCode: "00"
+ errorText: Unknown error. <error-details>
+ - cmHandle: my-cm-handle-02
+ errorCode: "02"
+ errorText: cm-handle does not exists
+ - cmHandle: my-cm-handle-03
+ errorCode: "03"
+ errorText: cm-handle has an invalid character(s) in id
schema:
$ref: '#/components/schemas/DmiPluginRegistrationErrorResponse'
description: Partial or Complete failure. The error details are provided
@@ -93,19 +93,19 @@ paths:
example.
summary: DMI notifies NCMP of new CM Handles
tags:
- - network-cm-proxy-inventory
+ - network-cm-proxy-inventory
/v1/ch/cmHandles:
get:
description: Get all cm handle IDs for a registered DMI plugin
operationId: getAllCmHandleIdsForRegisteredDmi
parameters:
- - description: dmi-plugin-identifier
- in: query
- name: dmi-plugin-identifier
- required: true
- schema:
- example: my-dmi-plugin
- type: string
+ - description: dmi-plugin-identifier
+ in: query
+ name: dmi-plugin-identifier
+ required: true
+ schema:
+ example: my-dmi-plugin
+ type: string
responses:
"200":
content:
@@ -148,7 +148,7 @@ paths:
summary: "Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI\
\ data plugin, DMI model plugin)"
tags:
- - network-cm-proxy-inventory
+ - network-cm-proxy-inventory
/v1/ch/searches:
post:
description: "Query and get CMHandleIds for additional properties, public properties\
@@ -201,7 +201,7 @@ paths:
description: Internal Server Error
summary: Query for CM Handle IDs
tags:
- - network-cm-proxy-inventory
+ - network-cm-proxy-inventory
components:
parameters:
dmiPluginIdentifierInQuery:
@@ -260,34 +260,34 @@ components:
RestDmiPluginRegistration:
example:
updatedCmHandles:
- - cmHandle: my-cm-handle
- publicCmHandleProperties:
- key: my-property
- cmHandleProperties:
- key: my-property
- - cmHandle: my-cm-handle
- publicCmHandleProperties:
- key: my-property
- cmHandleProperties:
- key: my-property
+ - cmHandle: my-cm-handle
+ publicCmHandleProperties:
+ key: my-property
+ cmHandleProperties:
+ key: my-property
+ - cmHandle: my-cm-handle
+ publicCmHandleProperties:
+ key: my-property
+ cmHandleProperties:
+ key: my-property
createdCmHandles:
- - cmHandle: my-cm-handle
- publicCmHandleProperties:
- key: my-property
- cmHandleProperties:
- key: my-property
- - cmHandle: my-cm-handle
- publicCmHandleProperties:
- key: my-property
- cmHandleProperties:
- key: my-property
+ - cmHandle: my-cm-handle
+ publicCmHandleProperties:
+ key: my-property
+ cmHandleProperties:
+ key: my-property
+ - cmHandle: my-cm-handle
+ publicCmHandleProperties:
+ key: my-property
+ cmHandleProperties:
+ key: my-property
dmiPlugin: my-dmi-plugin
dmiModelPlugin: my-dmi-model-plugin
dmiDataPlugin: my-dmi-data-plugin
removedCmHandles:
- - my-cm-handle1
- - my-cm-handle2
- - my-cm-handle3
+ - my-cm-handle1
+ - my-cm-handle2
+ - my-cm-handle3
properties:
dmiPlugin:
default: ""
@@ -311,9 +311,9 @@ components:
type: array
removedCmHandles:
example:
- - my-cm-handle1
- - my-cm-handle2
- - my-cm-handle3
+ - my-cm-handle1
+ - my-cm-handle2
+ - my-cm-handle3
items:
type: string
type: array
@@ -340,7 +340,7 @@ components:
type: string
type: object
required:
- - cmHandle
+ - cmHandle
type: object
RestCmHandleProperties:
additionalProperties:
@@ -387,23 +387,23 @@ components:
CmHandleQueryParameters:
example:
cmHandleQueryParameters:
- - conditionParameters:
- - key: conditionParameters
- - key: conditionParameters
- conditionName: conditionName
- - conditionParameters:
- - key: conditionParameters
- - key: conditionParameters
- conditionName: conditionName
+ - conditionParameters:
+ - key: conditionParameters
+ - key: conditionParameters
+ conditionName: conditionName
+ - conditionParameters:
+ - key: conditionParameters
+ - key: conditionParameters
+ conditionName: conditionName
conditions:
- - name: name
- conditionParameters:
- - moduleName: my-module
- - moduleName: my-module
- - name: name
- conditionParameters:
- - moduleName: my-module
- - moduleName: my-module
+ - name: name
+ conditionParameters:
+ - moduleName: my-module
+ - moduleName: my-module
+ - name: name
+ conditionParameters:
+ - moduleName: my-module
+ - moduleName: my-module
properties:
cmHandleQueryParameters:
items:
@@ -420,8 +420,8 @@ components:
ConditionProperties:
example:
conditionParameters:
- - key: conditionParameters
- - key: conditionParameters
+ - key: conditionParameters
+ - key: conditionParameters
conditionName: conditionName
properties:
conditionName:
@@ -437,8 +437,8 @@ components:
example:
name: name
conditionParameters:
- - moduleName: my-module
- - moduleName: my-module
+ - moduleName: my-module
+ - moduleName: my-module
properties:
name:
type: string
diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml
index a0c5b1710e..810210f584 100644
--- a/docs/api/swagger/ncmp/openapi.yaml
+++ b/docs/api/swagger/ncmp/openapi.yaml
@@ -4,58 +4,58 @@ info:
title: NCMP to CPS Proxy API
version: "1.0"
servers:
- - url: /ncmp
+- url: /ncmp
security:
- - basicAuth: []
+- basicAuth: []
paths:
/v1/ch/{cm-handle}/data/ds/{datastore-name}:
delete:
description: Delete resource data from pass-through running for a given cm handle
operationId: deleteResourceDataRunningForCmHandle
parameters:
- - description: The type of the requested data
- in: path
- name: datastore-name
- required: true
- schema:
- example: ncmp-datastore:running
- type: string
- - description: "The identifier for a network function, network element, subnetwork\
+ - description: The type of the requested data
+ in: path
+ name: datastore-name
+ required: true
+ schema:
+ example: ncmp-datastore:running
+ type: string
+ - description: "The identifier for a network function, network element, subnetwork\
\ or any other cm object by managed Network CM Proxy"
- in: path
- name: cm-handle
- required: true
- schema:
- example: my-cm-handle
- type: string
- - allowReserved: true
- description: The format of resource identifier depend on the associated DMI
- Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
- it can really be anything.
- examples:
- sample 1:
- value:
- resourceIdentifier: \shops\bookstore
- sample 2:
- value:
- resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
- sample 3:
- value:
- resourceIdentifier: "parent=shops,child=bookstore"
- in: query
- name: resourceIdentifier
- required: true
- schema:
- type: string
- - description: "Content parameter for request, if content parameter is null,\
+ in: path
+ name: cm-handle
+ required: true
+ schema:
+ example: my-cm-handle
+ type: string
+ - allowReserved: true
+ description: The format of resource identifier depend on the associated DMI
+ Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
+ it can really be anything.
+ examples:
+ sample 1:
+ value:
+ resourceIdentifier: \shops\bookstore
+ sample 2:
+ value:
+ resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
+ sample 3:
+ value:
+ resourceIdentifier: "parent=shops,child=bookstore"
+ in: query
+ name: resourceIdentifier
+ required: true
+ schema:
+ type: string
+ - description: "Content parameter for request, if content parameter is null,\
\ default value is application/json."
- in: header
- name: Content-Type
- required: false
- schema:
- default: application/json
- example: application/yang-data+json
- type: string
+ in: header
+ name: Content-Type
+ required: false
+ schema:
+ default: application/json
+ example: application/yang-data+json
+ type: string
responses:
"204":
content: {}
@@ -123,82 +123,82 @@ paths:
description: Bad Gateway
summary: Delete resource data
tags:
- - network-cm-proxy
+ - network-cm-proxy
get:
description: Get resource data for given cm handle
operationId: getResourceDataForCmHandle
parameters:
- - description: The type of the requested data
- in: path
- name: datastore-name
- required: true
- schema:
- example: ncmp-datastore:running
- type: string
- - description: "The identifier for a network function, network element, subnetwork\
+ - description: The type of the requested data
+ in: path
+ name: datastore-name
+ required: true
+ schema:
+ example: ncmp-datastore:running
+ type: string
+ - description: "The identifier for a network function, network element, subnetwork\
\ or any other cm object by managed Network CM Proxy"
- in: path
- name: cm-handle
- required: true
- schema:
- example: my-cm-handle
- type: string
- - allowReserved: true
- description: The format of resource identifier depend on the associated DMI
- Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
- it can really be anything.
- examples:
- sample 1:
- value:
- resourceIdentifier: \shops\bookstore
- sample 2:
- value:
- resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
- sample 3:
- value:
- resourceIdentifier: "parent=shops,child=bookstore"
- in: query
- name: resourceIdentifier
- required: true
- schema:
- type: string
- - allowReserved: true
- description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
+ in: path
+ name: cm-handle
+ required: true
+ schema:
+ example: my-cm-handle
+ type: string
+ - allowReserved: true
+ description: The format of resource identifier depend on the associated DMI
+ Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
+ it can really be anything.
+ examples:
+ sample 1:
+ value:
+ resourceIdentifier: \shops\bookstore
+ sample 2:
+ value:
+ resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
+ sample 3:
+ value:
+ resourceIdentifier: "parent=shops,child=bookstore"
+ in: query
+ name: resourceIdentifier
+ required: true
+ schema:
+ type: string
+ - allowReserved: true
+ description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
\ in parenthesis'()'. The format of options parameter depend on the associated\
\ DMI Plugin implementation."
- examples:
- sample 1:
- value:
- options: (depth=3)
- sample 2:
- value:
- options: (fields=book)
- sample 3:
- value:
- options: "(depth=2,fields=book/authors)"
- in: query
- name: options
- required: false
- schema:
- type: string
- - allowReserved: true
- description: topic parameter in query.
- examples:
- sample 1:
- value:
- topic: my-topic-name
- in: query
- name: topic
- required: false
- schema:
- type: string
- - description: Determines if descendants are included in response
- in: query
- name: include-descendants
- required: false
- schema:
- default: false
- type: boolean
+ examples:
+ sample 1:
+ value:
+ options: (depth=3)
+ sample 2:
+ value:
+ options: (fields=book)
+ sample 3:
+ value:
+ options: "(depth=2,fields=book/authors)"
+ in: query
+ name: options
+ required: false
+ schema:
+ type: string
+ - allowReserved: true
+ description: topic parameter in query.
+ examples:
+ sample 1:
+ value:
+ topic: my-topic-name
+ in: query
+ name: topic
+ required: false
+ schema:
+ type: string
+ - description: Determines if descendants are included in response
+ in: query
+ name: include-descendants
+ required: false
+ schema:
+ default: false
+ type: boolean
responses:
"200":
content:
@@ -263,55 +263,55 @@ paths:
description: Bad Gateway
summary: Get resource data for cm handle
tags:
- - network-cm-proxy
+ - network-cm-proxy
patch:
description: Patch resource data from pass-through running for the given cm
handle
operationId: patchResourceDataRunningForCmHandle
parameters:
- - description: The type of the requested data
- in: path
- name: datastore-name
- required: true
- schema:
- example: ncmp-datastore:running
- type: string
- - description: "The identifier for a network function, network element, subnetwork\
+ - description: The type of the requested data
+ in: path
+ name: datastore-name
+ required: true
+ schema:
+ example: ncmp-datastore:running
+ type: string
+ - description: "The identifier for a network function, network element, subnetwork\
\ or any other cm object by managed Network CM Proxy"
- in: path
- name: cm-handle
- required: true
- schema:
- example: my-cm-handle
- type: string
- - allowReserved: true
- description: The format of resource identifier depend on the associated DMI
- Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
- it can really be anything.
- examples:
- sample 1:
- value:
- resourceIdentifier: \shops\bookstore
- sample 2:
- value:
- resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
- sample 3:
- value:
- resourceIdentifier: "parent=shops,child=bookstore"
- in: query
- name: resourceIdentifier
- required: true
- schema:
- type: string
- - description: "Content parameter for request, if content parameter is null,\
+ in: path
+ name: cm-handle
+ required: true
+ schema:
+ example: my-cm-handle
+ type: string
+ - allowReserved: true
+ description: The format of resource identifier depend on the associated DMI
+ Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
+ it can really be anything.
+ examples:
+ sample 1:
+ value:
+ resourceIdentifier: \shops\bookstore
+ sample 2:
+ value:
+ resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
+ sample 3:
+ value:
+ resourceIdentifier: "parent=shops,child=bookstore"
+ in: query
+ name: resourceIdentifier
+ required: true
+ schema:
+ type: string
+ - description: "Content parameter for request, if content parameter is null,\
\ default value is application/json."
- in: header
- name: Content-Type
- required: false
- schema:
- default: application/json
- example: application/yang-data+json
- type: string
+ in: header
+ name: Content-Type
+ required: false
+ schema:
+ default: application/json
+ example: application/yang-data+json
+ type: string
requestBody:
content:
'*/*':
@@ -382,54 +382,54 @@ paths:
description: Bad Gateway
summary: Patch resource data from pass-through running
tags:
- - network-cm-proxy
+ - network-cm-proxy
post:
description: create resource data from pass-through running for given cm handle
operationId: createResourceDataRunningForCmHandle
parameters:
- - description: The type of the requested data
- in: path
- name: datastore-name
- required: true
- schema:
- example: ncmp-datastore:running
- type: string
- - description: "The identifier for a network function, network element, subnetwork\
+ - description: The type of the requested data
+ in: path
+ name: datastore-name
+ required: true
+ schema:
+ example: ncmp-datastore:running
+ type: string
+ - description: "The identifier for a network function, network element, subnetwork\
\ or any other cm object by managed Network CM Proxy"
- in: path
- name: cm-handle
- required: true
- schema:
- example: my-cm-handle
- type: string
- - allowReserved: true
- description: The format of resource identifier depend on the associated DMI
- Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
- it can really be anything.
- examples:
- sample 1:
- value:
- resourceIdentifier: \shops\bookstore
- sample 2:
- value:
- resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
- sample 3:
- value:
- resourceIdentifier: "parent=shops,child=bookstore"
- in: query
- name: resourceIdentifier
- required: true
- schema:
- type: string
- - description: "Content parameter for request, if content parameter is null,\
+ in: path
+ name: cm-handle
+ required: true
+ schema:
+ example: my-cm-handle
+ type: string
+ - allowReserved: true
+ description: The format of resource identifier depend on the associated DMI
+ Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
+ it can really be anything.
+ examples:
+ sample 1:
+ value:
+ resourceIdentifier: \shops\bookstore
+ sample 2:
+ value:
+ resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
+ sample 3:
+ value:
+ resourceIdentifier: "parent=shops,child=bookstore"
+ in: query
+ name: resourceIdentifier
+ required: true
+ schema:
+ type: string
+ - description: "Content parameter for request, if content parameter is null,\
\ default value is application/json."
- in: header
- name: Content-Type
- required: false
- schema:
- default: application/json
- example: application/yang-data+json
- type: string
+ in: header
+ name: Content-Type
+ required: false
+ schema:
+ default: application/json
+ example: application/yang-data+json
+ type: string
requestBody:
content:
application/json:
@@ -504,55 +504,55 @@ paths:
description: Bad Gateway
summary: create resource data from pass-through running for cm handle
tags:
- - network-cm-proxy
+ - network-cm-proxy
put:
description: Update resource data from pass-through running for the given cm
handle
operationId: updateResourceDataRunningForCmHandle
parameters:
- - description: The type of the requested data
- in: path
- name: datastore-name
- required: true
- schema:
- example: ncmp-datastore:running
- type: string
- - description: "The identifier for a network function, network element, subnetwork\
+ - description: The type of the requested data
+ in: path
+ name: datastore-name
+ required: true
+ schema:
+ example: ncmp-datastore:running
+ type: string
+ - description: "The identifier for a network function, network element, subnetwork\
\ or any other cm object by managed Network CM Proxy"
- in: path
- name: cm-handle
- required: true
- schema:
- example: my-cm-handle
- type: string
- - allowReserved: true
- description: The format of resource identifier depend on the associated DMI
- Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
- it can really be anything.
- examples:
- sample 1:
- value:
- resourceIdentifier: \shops\bookstore
- sample 2:
- value:
- resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
- sample 3:
- value:
- resourceIdentifier: "parent=shops,child=bookstore"
- in: query
- name: resourceIdentifier
- required: true
- schema:
- type: string
- - description: "Content parameter for request, if content parameter is null,\
+ in: path
+ name: cm-handle
+ required: true
+ schema:
+ example: my-cm-handle
+ type: string
+ - allowReserved: true
+ description: The format of resource identifier depend on the associated DMI
+ Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
+ it can really be anything.
+ examples:
+ sample 1:
+ value:
+ resourceIdentifier: \shops\bookstore
+ sample 2:
+ value:
+ resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
+ sample 3:
+ value:
+ resourceIdentifier: "parent=shops,child=bookstore"
+ in: query
+ name: resourceIdentifier
+ required: true
+ schema:
+ type: string
+ - description: "Content parameter for request, if content parameter is null,\
\ default value is application/json."
- in: header
- name: Content-Type
- required: false
- schema:
- default: application/json
- example: application/yang-data+json
- type: string
+ in: header
+ name: Content-Type
+ required: false
+ schema:
+ default: application/json
+ example: application/yang-data+json
+ type: string
requestBody:
content:
application/json:
@@ -630,7 +630,7 @@ paths:
description: Bad Gateway
summary: Update resource data from pass-through running for a cm handle
tags:
- - network-cm-proxy
+ - network-cm-proxy
/v1/data:
post:
description: This request will be handled asynchronously using messaging to
@@ -638,17 +638,17 @@ paths:
to identify the relevant messages.
operationId: executeDataOperationForCmHandles
parameters:
- - allowReserved: true
- description: mandatory topic parameter in query.
- examples:
- sample 1:
- value:
- topic: my-topic-name
- in: query
- name: topic
- required: true
- schema:
- type: string
+ - allowReserved: true
+ description: mandatory topic parameter in query.
+ examples:
+ sample 1:
+ value:
+ topic: my-topic-name
+ in: query
+ name: topic
+ required: true
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -715,76 +715,76 @@ paths:
description: Bad Gateway
summary: Execute a data operation for group of cm handle ids
tags:
- - network-cm-proxy
+ - network-cm-proxy
/v1/ch/{cm-handle}/data/ds/{datastore-name}/query:
get:
description: Query resource data for a given cm handle
operationId: queryResourceDataForCmHandle
parameters:
- - description: The type of the requested data
- in: path
- name: datastore-name
- required: true
- schema:
- example: ncmp-datastore:running
- type: string
- - description: "The identifier for a network function, network element, subnetwork\
+ - description: The type of the requested data
+ in: path
+ name: datastore-name
+ required: true
+ schema:
+ example: ncmp-datastore:running
+ type: string
+ - description: "The identifier for a network function, network element, subnetwork\
\ or any other cm object by managed Network CM Proxy"
- in: path
- name: cm-handle
- required: true
- schema:
- example: my-cm-handle
- type: string
- - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
- examples:
- container cps path:
- value: //bookstore
- list attributes cps path:
- value: "//categories[@code=1]"
- in: query
- name: cps-path
- required: false
- schema:
- default: /
- type: string
- - allowReserved: true
- description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
+ in: path
+ name: cm-handle
+ required: true
+ schema:
+ example: my-cm-handle
+ type: string
+ - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
+ examples:
+ container cps path:
+ value: //bookstore
+ list attributes cps path:
+ value: "//categories[@code=1]"
+ in: query
+ name: cps-path
+ required: false
+ schema:
+ default: /
+ type: string
+ - allowReserved: true
+ description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
\ in parenthesis'()'. The format of options parameter depend on the associated\
\ DMI Plugin implementation."
- examples:
- sample 1:
- value:
- options: (depth=3)
- sample 2:
- value:
- options: (fields=book)
- sample 3:
- value:
- options: "(depth=2,fields=book/authors)"
- in: query
- name: options
- required: false
- schema:
- type: string
- - allowReserved: true
- description: topic parameter in query.
- examples:
- sample 1:
- value:
- topic: my-topic-name
- in: query
- name: topic
- required: false
- schema:
- type: string
- - description: Determines if descendants are included in response
- in: query
- name: include-descendants
- required: false
- schema:
- default: false
- type: boolean
+ examples:
+ sample 1:
+ value:
+ options: (depth=3)
+ sample 2:
+ value:
+ options: (fields=book)
+ sample 3:
+ value:
+ options: "(depth=2,fields=book/authors)"
+ in: query
+ name: options
+ required: false
+ schema:
+ type: string
+ - allowReserved: true
+ description: topic parameter in query.
+ examples:
+ sample 1:
+ value:
+ topic: my-topic-name
+ in: query
+ name: topic
+ required: false
+ schema:
+ type: string
+ - description: Determines if descendants are included in response
+ in: query
+ name: include-descendants
+ required: false
+ schema:
+ default: false
+ type: boolean
responses:
"200":
content:
@@ -849,21 +849,21 @@ paths:
description: Bad Gateway
summary: Query resource data for a given cm handle
tags:
- - network-cm-proxy
+ - network-cm-proxy
/v1/ch/{cm-handle}/modules:
get:
description: fetch all module references (name and revision) for a given cm
handle
operationId: getModuleReferencesByCmHandle
parameters:
- - description: "The identifier for a network function, network element, subnetwork\
+ - description: "The identifier for a network function, network element, subnetwork\
\ or any other cm object by managed Network CM Proxy"
- in: path
- name: cm-handle
- required: true
- schema:
- example: my-cm-handle
- type: string
+ in: path
+ name: cm-handle
+ required: true
+ schema:
+ example: my-cm-handle
+ type: string
responses:
"200":
content:
@@ -915,21 +915,21 @@ paths:
description: Internal Server Error
summary: Fetch all module references (name and revision) for a given cm handle
tags:
- - network-cm-proxy
+ - 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
parameters:
- - description: "The identifier for a network function, network element, subnetwork\
+ - description: "The identifier for a network function, network element, subnetwork\
\ or any other cm object by managed Network CM Proxy"
- in: path
- name: cm-handle
- required: true
- schema:
- example: my-cm-handle
- type: string
+ in: path
+ name: cm-handle
+ required: true
+ schema:
+ example: my-cm-handle
+ type: string
responses:
"200":
content:
@@ -972,7 +972,7 @@ paths:
summary: "Fetch all module definitions (name, revision, yang resource) for a\
\ given cm handle"
tags:
- - network-cm-proxy
+ - network-cm-proxy
/v1/ch/searches:
post:
description: Execute cm handle query search and return a list of cm handle details.
@@ -1059,20 +1059,20 @@ paths:
description: Internal Server Error
summary: Execute cm handle search using the available conditions
tags:
- - network-cm-proxy
+ - network-cm-proxy
/v1/ch/{cm-handle}:
get:
description: Retrieve CM handle details and properties by cm handle id
operationId: retrieveCmHandleDetailsById
parameters:
- - description: "The identifier for a network function, network element, subnetwork\
+ - description: "The identifier for a network function, network element, subnetwork\
\ or any other cm object by managed Network CM Proxy"
- in: path
- name: cm-handle
- required: true
- schema:
- example: my-cm-handle
- type: string
+ in: path
+ name: cm-handle
+ required: true
+ schema:
+ example: my-cm-handle
+ type: string
responses:
"200":
content:
@@ -1122,20 +1122,20 @@ paths:
description: Internal Server Error
summary: Retrieve CM handle details
tags:
- - network-cm-proxy
+ - network-cm-proxy
/v1/ch/{cm-handle}/properties:
get:
description: Get CM handle properties by cm handle id
operationId: getCmHandlePublicPropertiesByCmHandleId
parameters:
- - description: "The identifier for a network function, network element, subnetwork\
+ - description: "The identifier for a network function, network element, subnetwork\
\ or any other cm object by managed Network CM Proxy"
- in: path
- name: cm-handle
- required: true
- schema:
- example: my-cm-handle
- type: string
+ in: path
+ name: cm-handle
+ required: true
+ schema:
+ example: my-cm-handle
+ type: string
responses:
"200":
content:
@@ -1185,7 +1185,7 @@ paths:
description: Internal Server Error
summary: Get CM handle properties
tags:
- - network-cm-proxy
+ - network-cm-proxy
/v1/ch/id-searches:
post:
description: Execute cm handle query search and return a list of cm handle ids.
@@ -1282,20 +1282,20 @@ paths:
description: Internal Server Error
summary: Execute cm handle query upon a given set of query parameters
tags:
- - network-cm-proxy
+ - network-cm-proxy
/v1/ch/{cm-handle}/state:
get:
description: Get CM handle state by cm handle id
operationId: getCmHandleStateByCmHandleId
parameters:
- - description: "The identifier for a network function, network element, subnetwork\
+ - description: "The identifier for a network function, network element, subnetwork\
\ or any other cm object by managed Network CM Proxy"
- in: path
- name: cm-handle
- required: true
- schema:
- example: my-cm-handle
- type: string
+ in: path
+ name: cm-handle
+ required: true
+ schema:
+ example: my-cm-handle
+ type: string
responses:
"200":
content:
@@ -1345,7 +1345,7 @@ paths:
description: Internal Server Error
summary: Get CM handle state
tags:
- - network-cm-proxy
+ - network-cm-proxy
/v1/ch/{cm-handle}/data-sync:
put:
description: Set the data sync enabled flag to true or false for a specified
@@ -1353,21 +1353,21 @@ paths:
NONE_REQUESTED respectfully.
operationId: setDataSyncEnabledFlagForCmHandle
parameters:
- - description: "The identifier for a network function, network element, subnetwork\
+ - description: "The identifier for a network function, network element, subnetwork\
\ or any other cm object by managed Network CM Proxy"
- in: path
- name: cm-handle
- required: true
- schema:
- example: my-cm-handle
- type: string
- - description: Is used to enable or disable the data synchronization flag
- in: query
- name: dataSyncEnabled
- required: true
- schema:
- example: true
- type: boolean
+ in: path
+ name: cm-handle
+ required: true
+ schema:
+ example: my-cm-handle
+ type: string
+ - description: Is used to enable or disable the data synchronization flag
+ in: query
+ name: dataSyncEnabled
+ required: true
+ schema:
+ example: true
+ type: boolean
responses:
"200":
content:
@@ -1428,7 +1428,7 @@ paths:
description: Bad Gateway
summary: Set the Data Sync Enabled Flag
tags:
- - network-cm-proxy
+ - network-cm-proxy
components:
examples:
dataSampleResponse:
@@ -1437,17 +1437,17 @@ components:
value:
bookstore:
categories:
- - code: "01"
- books:
- - authors:
- - Iain M. Banks
- - Ursula K. Le Guin
- name: SciFi
- - code: "02"
- books:
- - authors:
- - Philip Pullman
- name: kids
+ - code: "01"
+ books:
+ - authors:
+ - Iain M. Banks
+ - Ursula K. Le Guin
+ name: SciFi
+ - code: "02"
+ books:
+ - authors:
+ - Philip Pullman
+ name: kids
dataSampleRequest:
description: Sample request body
summary: Sample request
@@ -1455,17 +1455,17 @@ components:
test:bookstore:
bookstore-name: Chapters
categories:
- - code: "01"
- name: SciFi
- books:
- - authors:
- - Iain M. Banks
- - Ursula K. Le Guin
- - code: "02"
- name: kids
- books:
- - authors:
- - Philip Pullman
+ - code: "01"
+ name: SciFi
+ books:
+ - authors:
+ - Iain M. Banks
+ - Ursula K. Le Guin
+ - code: "02"
+ name: kids
+ books:
+ - authors:
+ - Philip Pullman
dataSamplePatchRequest:
description: Sample patch request body
summary: Sample patch request
@@ -1473,86 +1473,86 @@ components:
ietf-restconf:yang-patch:
patch-id: patch-1
edit:
- - edit-id: edit1
- operation: merge
- target: /
- value:
- test:bookstore:
- bookstore-name: Chapters
- categories:
- - code: "01"
- name: Science
- books:
- - authors:
- - Author1
- - Author2
- - code: "02"
- name: Arts
- books:
- - authors:
- - Author3
- - edit-id: edit2
- operation: merge
- target: /
- value:
- test:bookstore:
- bookstore-name: Novels
- categories:
- - code: "03"
- name: History
- books:
- - authors:
- - Iain M. Banks
- - Ursula K. Le Guin
- - code: "04"
- name: Fiction
- books:
- - authors:
- - Philip Pullman
+ - edit-id: edit1
+ operation: merge
+ target: /
+ value:
+ test:bookstore:
+ bookstore-name: Chapters
+ categories:
+ - code: "01"
+ name: Science
+ books:
+ - authors:
+ - Author1
+ - Author2
+ - code: "02"
+ name: Arts
+ books:
+ - authors:
+ - Author3
+ - edit-id: edit2
+ operation: merge
+ target: /
+ value:
+ test:bookstore:
+ bookstore-name: Novels
+ categories:
+ - code: "03"
+ name: History
+ books:
+ - authors:
+ - Iain M. Banks
+ - Ursula K. Le Guin
+ - code: "04"
+ name: Fiction
+ books:
+ - authors:
+ - Philip Pullman
pubPropCmHandleQueryParameters:
value:
cmHandleQueryParameters:
- - conditionName: hasAllProperties
- conditionParameters:
- - Color: yellow
- - Shape: circle
- - Size: small
+ - conditionName: hasAllProperties
+ conditionParameters:
+ - Color: yellow
+ - Shape: circle
+ - Size: small
modulesCmHandleQueryParameters:
value:
cmHandleQueryParameters:
- - conditionName: hasAllModules
- conditionParameters:
- - moduleName: my-module-1
- - moduleName: my-module-2
- - moduleName: my-module-3
+ - conditionName: hasAllModules
+ conditionParameters:
+ - moduleName: my-module-1
+ - moduleName: my-module-2
+ - moduleName: my-module-3
allCmHandleQueryParameters:
value:
cmHandleQueryParameters:
- - conditionName: hasAllModules
- conditionParameters:
- - moduleName: my-module-1
- - moduleName: my-module-2
- - moduleName: my-module-3
- - conditionName: hasAllProperties
- conditionParameters:
- - Color: yellow
- - Shape: circle
- - Size: small
- - conditionName: cmHandleWithCpsPath
- conditionParameters:
- - cpsPath: "//state[@cm-handle-state='ADVISED']"
+ - conditionName: hasAllModules
+ conditionParameters:
+ - moduleName: my-module-1
+ - moduleName: my-module-2
+ - moduleName: my-module-3
+ - conditionName: hasAllProperties
+ conditionParameters:
+ - Color: yellow
+ - Shape: circle
+ - Size: small
+ - conditionName: cmHandleWithCpsPath
+ conditionParameters:
+ - cpsPath: "//state[@cm-handle-state='ADVISED']"
cpsPathCmHandleStateQueryParameters:
value:
cmHandleQueryParameters:
- - conditionName: cmHandleWithCpsPath
- conditionParameters:
- - cpsPath: "//state[@cm-handle-state='LOCKED']"
+ - conditionName: cmHandleWithCpsPath
+ conditionParameters:
+ - cpsPath: "//state[@cm-handle-state='LOCKED']"
cpsPathCmHandleDataSyncQueryParameters:
value:
cmHandleQueryParameters:
- - conditionName: cmHandleWithCpsPath
- conditionParameters:
- - cpsPath: "//state[@data-sync-enabled='true']"
+ - conditionName: cmHandleWithCpsPath
+ conditionParameters:
+ - cpsPath: "//state[@data-sync-enabled='true']"
parameters:
datastoreName:
description: The type of the requested data
@@ -1771,26 +1771,26 @@ components:
DataOperationRequest:
example:
operations:
- - resourceIdentifier: parent/child
- targetIds:
- - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
+ - resourceIdentifier: parent/child
+ targetIds:
+ - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
]"
- - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
+ - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
]"
- datastore: ncmp-datastore:passthrough-operational
- options: (fields=schemas/schema)
- operationId: "12"
- operation: read
- - resourceIdentifier: parent/child
- targetIds:
- - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
+ datastore: ncmp-datastore:passthrough-operational
+ options: (fields=schemas/schema)
+ operationId: "12"
+ operation: read
+ - resourceIdentifier: parent/child
+ targetIds:
+ - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
]"
- - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
+ - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
]"
- datastore: ncmp-datastore:passthrough-operational
- options: (fields=schemas/schema)
- operationId: "12"
- operation: read
+ datastore: ncmp-datastore:passthrough-operational
+ options: (fields=schemas/schema)
+ operationId: "12"
+ operation: read
properties:
operations:
description: contains group of data operation requests
@@ -1803,9 +1803,9 @@ components:
example:
resourceIdentifier: parent/child
targetIds:
- - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
+ - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
]"
- - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
+ - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
]"
datastore: ncmp-datastore:passthrough-operational
options: (fields=schemas/schema)
@@ -1834,9 +1834,9 @@ components:
type: string
type: array
required:
- - datastore
- - operation
- - operationId
+ - datastore
+ - operation
+ - operationId
RestModuleReference:
example:
moduleName: my-module-name
@@ -1888,23 +1888,23 @@ components:
CmHandleQueryParameters:
example:
cmHandleQueryParameters:
- - conditionParameters:
- - key: conditionParameters
- - key: conditionParameters
- conditionName: conditionName
- - conditionParameters:
- - key: conditionParameters
- - key: conditionParameters
- conditionName: conditionName
+ - conditionParameters:
+ - key: conditionParameters
+ - key: conditionParameters
+ conditionName: conditionName
+ - conditionParameters:
+ - key: conditionParameters
+ - key: conditionParameters
+ conditionName: conditionName
conditions:
- - name: name
- conditionParameters:
- - moduleName: my-module
- - moduleName: my-module
- - name: name
- conditionParameters:
- - moduleName: my-module
- - moduleName: my-module
+ - name: name
+ conditionParameters:
+ - moduleName: my-module
+ - moduleName: my-module
+ - name: name
+ conditionParameters:
+ - moduleName: my-module
+ - moduleName: my-module
properties:
cmHandleQueryParameters:
items:
@@ -1921,8 +1921,8 @@ components:
ConditionProperties:
example:
conditionParameters:
- - key: conditionParameters
- - key: conditionParameters
+ - key: conditionParameters
+ - key: conditionParameters
conditionName: conditionName
properties:
conditionName:
@@ -1938,8 +1938,8 @@ components:
example:
name: name
conditionParameters:
- - moduleName: my-module
- - moduleName: my-module
+ - moduleName: my-module
+ - moduleName: my-module
properties:
name:
type: string
@@ -1958,8 +1958,8 @@ components:
example:
cmHandle: my-cm-handle1
publicCmHandleProperties:
- - key: Book Type
- - key: Book Type
+ - key: Book Type
+ - key: Book Type
state:
dataSyncEnabled: false
dataSyncState:
@@ -2067,8 +2067,8 @@ components:
RestOutputCmHandlePublicProperties:
example:
publicCmHandleProperties:
- - key: Book Type
- - key: Book Type
+ - key: Book Type
+ - key: Book Type
properties:
publicCmHandleProperties:
items:
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 3f672ad626..157f62e08c 100755
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -40,6 +40,7 @@ Bug Fixes
---------
3.3.6
- `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
+ - `CPS-1842 <https://jira.onap.org/browse/CPS-1842>`_ Replace event-id with correlation-id for data read operation cloud event
Features
--------