aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorLee Anjella Macabuhay <lee.anjella.macabuhay@est.tech>2024-12-13 09:32:29 +0000
committerGerrit Code Review <gerrit@onap.org>2024-12-13 09:32:29 +0000
commit764c8e07c355ed976724b347eeb2487a70815592 (patch)
tree9f0d38e7762a63cacf1d3dd4a3b6d9483428ca5b /docs
parent28e30ebcb58d46cc37eb8f8f3d279b08a9600200 (diff)
parent7bc7ca3004adc6a7c1bbcee62e32e1906f2976d1 (diff)
Merge "Implementation of Data validation feature in CPS APIs"
Diffstat (limited to 'docs')
-rw-r--r--docs/api/swagger/cps/openapi.yaml56
1 files changed, 46 insertions, 10 deletions
diff --git a/docs/api/swagger/cps/openapi.yaml b/docs/api/swagger/cps/openapi.yaml
index 7a300207cf..c84609b638 100644
--- a/docs/api/swagger/cps/openapi.yaml
+++ b/docs/api/swagger/cps/openapi.yaml
@@ -1354,6 +1354,15 @@ paths:
schema:
default: /
type: string
+ - description: "Boolean flag to validate data, without persisting it. Default\
+ \ value is false."
+ in: query
+ name: dry-run
+ required: false
+ schema:
+ default: false
+ example: false
+ type: boolean
- description: observed-timestamp
in: query
name: observed-timestamp
@@ -1474,7 +1483,7 @@ paths:
default: /
type: string
- description: "Boolean flag to validate data, without persisting it. Default\
- \ value is set to false."
+ \ value is false."
in: query
name: dry-run
required: false
@@ -1610,6 +1619,15 @@ paths:
schema:
default: /
type: string
+ - description: "Boolean flag to validate data, without persisting it. Default\
+ \ value is false."
+ in: query
+ name: dry-run
+ required: false
+ schema:
+ default: false
+ example: false
+ type: boolean
- description: observed-timestamp
in: query
name: observed-timestamp
@@ -1804,6 +1822,15 @@ paths:
required: true
schema:
type: string
+ - description: "Boolean flag to validate data, without persisting it. Default\
+ \ value is false."
+ in: query
+ name: dry-run
+ required: false
+ schema:
+ default: false
+ example: false
+ type: boolean
- description: observed-timestamp
in: query
name: observed-timestamp
@@ -1920,6 +1947,15 @@ paths:
required: true
schema:
type: string
+ - description: "Boolean flag to validate data, without persisting it. Default\
+ \ value is false."
+ in: query
+ name: dry-run
+ required: false
+ schema:
+ default: false
+ example: false
+ type: boolean
- description: observed-timestamp
in: query
name: observed-timestamp
@@ -2623,17 +2659,9 @@ components:
- application/json
- application/xml
type: string
- observedTimestampInQuery:
- description: observed-timestamp
- in: query
- name: observed-timestamp
- required: false
- schema:
- example: 2021-03-21T00:10:34.030-0100
- type: string
dryRunInQuery:
description: "Boolean flag to validate data, without persisting it. Default\
- \ value is set to false."
+ \ value is false."
in: query
name: dry-run
required: false
@@ -2641,6 +2669,14 @@ components:
default: false
example: false
type: boolean
+ observedTimestampInQuery:
+ description: observed-timestamp
+ in: query
+ name: observed-timestamp
+ required: false
+ schema:
+ example: 2021-03-21T00:10:34.030-0100
+ type: string
requiredXpathInQuery:
description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
examples: