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 /cps-rest/docs | |
| 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 'cps-rest/docs')
| -rw-r--r-- | cps-rest/docs/openapi/components.yml | 2 | ||||
| -rw-r--r-- | cps-rest/docs/openapi/cpsData.yml | 4 |
2 files changed, 5 insertions, 1 deletions
diff --git a/cps-rest/docs/openapi/components.yml b/cps-rest/docs/openapi/components.yml index 1db4185330..1a7e4308d9 100644 --- a/cps-rest/docs/openapi/components.yml +++ b/cps-rest/docs/openapi/components.yml @@ -326,7 +326,7 @@ components: dryRunInQuery: name: dry-run in: query - description: Boolean flag to validate data, without persisting it. Default value is set to false. + description: Boolean flag to validate data, without persisting it. Default value is false. required: false schema: type: boolean diff --git a/cps-rest/docs/openapi/cpsData.yml b/cps-rest/docs/openapi/cpsData.yml index 36000fd7d8..178a68fb77 100644 --- a/cps-rest/docs/openapi/cpsData.yml +++ b/cps-rest/docs/openapi/cpsData.yml @@ -31,6 +31,7 @@ listElementByDataspaceAndAnchor: - $ref: 'components.yml#/components/parameters/dataspaceNameInPath' - $ref: 'components.yml#/components/parameters/anchorNameInPath' - $ref: 'components.yml#/components/parameters/requiredXpathInQuery' + - $ref: 'components.yml#/components/parameters/dryRunInQuery' - $ref: 'components.yml#/components/parameters/observedTimestampInQuery' - $ref: 'components.yml#/components/parameters/contentTypeInHeader' requestBody: @@ -70,6 +71,7 @@ listElementByDataspaceAndAnchor: - $ref: 'components.yml#/components/parameters/dataspaceNameInPath' - $ref: 'components.yml#/components/parameters/anchorNameInPath' - $ref: 'components.yml#/components/parameters/requiredXpathInQuery' + - $ref: 'components.yml#/components/parameters/dryRunInQuery' - $ref: 'components.yml#/components/parameters/observedTimestampInQuery' - $ref: 'components.yml#/components/parameters/contentTypeInHeader' requestBody: @@ -154,6 +156,7 @@ nodesByDataspaceAndAnchor: - $ref: 'components.yml#/components/parameters/dataspaceNameInPath' - $ref: 'components.yml#/components/parameters/anchorNameInPath' - $ref: 'components.yml#/components/parameters/xpathInQuery' + - $ref: 'components.yml#/components/parameters/dryRunInQuery' - $ref: 'components.yml#/components/parameters/observedTimestampInQuery' - $ref: 'components.yml#/components/parameters/contentTypeInHeader' requestBody: @@ -214,6 +217,7 @@ nodesByDataspaceAndAnchor: - $ref: 'components.yml#/components/parameters/dataspaceNameInPath' - $ref: 'components.yml#/components/parameters/anchorNameInPath' - $ref: 'components.yml#/components/parameters/xpathInQuery' + - $ref: 'components.yml#/components/parameters/dryRunInQuery' - $ref: 'components.yml#/components/parameters/observedTimestampInQuery' - $ref: 'components.yml#/components/parameters/contentTypeInHeader' requestBody: |