diff options
| author |   Rudrangi Anupriya <ra00745022@techmahindra.com> | 2024-12-02 15:37:07 +0530 |
|---|---|---|
| committer | Rudrangi Anupriya <ra00745022@techmahindra.com> | 2024-12-12 07:18:23 +0000 |
| commit | 7bc7ca3004adc6a7c1bbcee62e32e1906f2976d1 (patch) | |
| tree | 6621a8adc49182c5d04738104df201e85dd1d8f4 /docs/api/swagger | |
| parent | 29061930922eeb686da7f91ec7852b7ee875c739 (diff) | |
Implementation of Data validation feature in CPS APIs
Added support to validate JSON/XML data without the need of persisting
it in the database.
- added "dryRunInQuery" flag as a new query parameter in update/Replace/Add APIs
- added new method as part of CpsDataService layer to perform data
validation
Issue-ID: CPS-2516
Change-Id: I87bb33dd6021567d0fac606d5c4b0168d107311c
Signed-off-by: Rudrangi Anupriya <ra00745022@techmahindra.com>
Diffstat (limited to 'docs/api/swagger')
| -rw-r--r-- | docs/api/swagger/cps/openapi.yaml | 56 |
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: |