summaryrefslogtreecommitdiffstats
path: root/docs/api/swagger
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api/swagger')
-rw-r--r--docs/api/swagger/cps/openapi.yaml129
-rw-r--r--docs/api/swagger/ncmp/openapi-inventory.yaml9
-rw-r--r--docs/api/swagger/ncmp/openapi.yaml9
3 files changed, 147 insertions, 0 deletions
diff --git a/docs/api/swagger/cps/openapi.yaml b/docs/api/swagger/cps/openapi.yaml
index 30ca1fdc35..bade85ef1a 100644
--- a/docs/api/swagger/cps/openapi.yaml
+++ b/docs/api/swagger/cps/openapi.yaml
@@ -2136,6 +2136,109 @@ paths:
summary: Replace list content
tags:
- cps-data
+ /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/delta:
+ get:
+ description: Get delta between two anchors within a given dataspace
+ operationId: getDeltaByDataspaceAndAnchors
+ 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: target-anchor-name
+ in: query
+ name: target-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:
+ application/json:
+ examples:
+ dataSample:
+ $ref: '#/components/examples/deltaReportSample'
+ value: null
+ schema:
+ type: object
+ description: OK
+ "400":
+ content:
+ application/json:
+ example:
+ status: 400
+ message: Bad Request
+ details: The provided request is not valid
+ schema:
+ $ref: '#/components/schemas/ErrorMessage'
+ description: Bad Request
+ "401":
+ content:
+ application/json:
+ example:
+ status: 401
+ message: Unauthorized request
+ details: This request is unauthorized
+ schema:
+ $ref: '#/components/schemas/ErrorMessage'
+ description: Unauthorized
+ "403":
+ content:
+ application/json:
+ example:
+ status: 403
+ message: Request Forbidden
+ details: This request is forbidden
+ schema:
+ $ref: '#/components/schemas/ErrorMessage'
+ description: Forbidden
+ "500":
+ content:
+ application/json:
+ example:
+ status: 500
+ message: Internal Server Error
+ details: Internal Server Error occurred
+ schema:
+ $ref: '#/components/schemas/ErrorMessage'
+ description: Internal Server Error
+ summary: Get delta between anchors in the same dataspace
+ tags:
+ - cps-data
+ x-codegen-request-body-name: xpath
/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
get:
deprecated: true
@@ -2448,6 +2551,24 @@ components:
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>
+ deltaReportSample:
+ value:
+ - action: ADD
+ xpath: "/bookstore/categories/[@code=3]"
+ target-data:
+ code: "3,"
+ name: kidz
+ - action: REMOVE
+ xpath: "/bookstore/categories/[@code=1]"
+ source-data:
+ code: "1,"
+ name: Fiction
+ - action: UPDATE
+ xpath: "/bookstore/categories/[@code=2]"
+ source-data:
+ name: Funny
+ target-data:
+ name: Comic
dataSampleAcrossAnchors:
value:
- anchorName: bookstore1
@@ -2588,6 +2709,14 @@ components:
required: true
schema:
type: string
+ targetAnchorNameInQuery:
+ description: target-anchor-name
+ in: query
+ name: target-anchor-name
+ required: true
+ schema:
+ example: my-anchor
+ type: string
cpsPathInQuery:
description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
examples:
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
index 9f64f58cb7..53f51f3f8b 100644
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -261,6 +261,7 @@ components:
example:
updatedCmHandles:
- cmHandle: my-cm-handle
+ alternateId: my-alternate-id
publicCmHandleProperties:
key: my-property
cmHandleProperties:
@@ -268,6 +269,7 @@ components:
moduleSetTag: my-module-set-tag
trustLevel: COMPLETE
- cmHandle: my-cm-handle
+ alternateId: my-alternate-id
publicCmHandleProperties:
key: my-property
cmHandleProperties:
@@ -276,6 +278,7 @@ components:
trustLevel: COMPLETE
createdCmHandles:
- cmHandle: my-cm-handle
+ alternateId: my-alternate-id
publicCmHandleProperties:
key: my-property
cmHandleProperties:
@@ -283,6 +286,7 @@ components:
moduleSetTag: my-module-set-tag
trustLevel: COMPLETE
- cmHandle: my-cm-handle
+ alternateId: my-alternate-id
publicCmHandleProperties:
key: my-property
cmHandleProperties:
@@ -337,6 +341,7 @@ components:
RestInputCmHandle:
example:
cmHandle: my-cm-handle
+ alternateId: my-alternate-id
publicCmHandleProperties:
key: my-property
cmHandleProperties:
@@ -366,6 +371,9 @@ components:
- NONE
example: COMPLETE
type: string
+ alternateId:
+ example: my-alternate-id
+ type: string
required:
- cmHandle
type: object
@@ -391,6 +399,7 @@ components:
type: string
type: array
moduleSetTag:
+ default: ""
example: my-module-set-tag
type: string
required:
diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml
index 810210f584..8098faefcc 100644
--- a/docs/api/swagger/ncmp/openapi.yaml
+++ b/docs/api/swagger/ncmp/openapi.yaml
@@ -1974,6 +1974,7 @@ components:
reason: LOCKED_MISBEHAVING
details: locked due to failure in module sync
lastUpdateTime: 2022-12-31T20:30:40.000+0000
+ trustLevel: COMPLETE
properties:
cmHandle:
example: my-cm-handle1
@@ -1987,6 +1988,10 @@ components:
type: array
state:
$ref: '#/components/schemas/CmHandleCompositeState'
+ trustLevel:
+ description: Current trust level of the relevant CM handle ID.
+ example: COMPLETE
+ type: string
title: CM handle Details
type: object
CmHandlePublicProperties:
@@ -2064,6 +2069,10 @@ components:
example: 2022-12-31T20:30:40.000+0000
type: string
type: object
+ CmHandleTrustLevel:
+ description: Current trust level of the relevant CM handle ID.
+ example: COMPLETE
+ type: string
RestOutputCmHandlePublicProperties:
example:
publicCmHandleProperties: