diff options
| author |   Arpit Singh <as00745003@techmahindra.com> | 2024-08-09 12:23:49 +0530 |
|---|---|---|
| committer | Arpit Singh <as00745003@techmahindra.com> | 2024-10-09 09:28:30 +0530 |
| commit | 07acbb4ddd713f74406b156cbcac2507f96f3b08 (patch) | |
| tree | 8f4122b9c3ecb994b9bb203cdd8b3fd1ad191f64 /cps-rest/docs | |
| parent | e2517a8b993ed884edb251b91ce600d0a1a9fefe (diff) | |
Implementation of Data validation feature in Create a Node API
Added support to validate JSON/XML data without the need of persisting
it in the databse.
- added "dryRunInQuery" flag as a new query parameter
- added new method as part of CpsDataService layer to perform data
validation
- added new method in yang parser "validateData" to validate
data without persisting it
Issue-ID: CPS-2361
Change-Id: I43dd33cc6120576d0fac606d5c4b0168d107311d
Signed-off-by: Arpit Singh <as00745003@techmahindra.com>
Diffstat (limited to 'cps-rest/docs')
| -rw-r--r-- | cps-rest/docs/openapi/components.yml | 9 | ||||
| -rw-r--r-- | cps-rest/docs/openapi/cpsData.yml | 1 |
2 files changed, 10 insertions, 0 deletions
diff --git a/cps-rest/docs/openapi/components.yml b/cps-rest/docs/openapi/components.yml index 25ef6a452a..40f0e170ff 100644 --- a/cps-rest/docs/openapi/components.yml +++ b/cps-rest/docs/openapi/components.yml @@ -320,6 +320,15 @@ components: schema: type: integer example: 10 + dryRunInQuery: + name: dry-run + in: query + description: Boolean flag to validate data, without persisting it. Default value is set to false. + required: false + schema: + type: boolean + default: false + example: false responses: NotFound: diff --git a/cps-rest/docs/openapi/cpsData.yml b/cps-rest/docs/openapi/cpsData.yml index 4418a3b9b7..daf59bbfbf 100644 --- a/cps-rest/docs/openapi/cpsData.yml +++ b/cps-rest/docs/openapi/cpsData.yml @@ -102,6 +102,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: |