summaryrefslogtreecommitdiffstats
path: root/cps-rest/docs
diff options
context:
space:
mode:
Diffstat (limited to 'cps-rest/docs')
-rw-r--r--cps-rest/docs/api/swagger/components.yaml16
-rw-r--r--cps-rest/docs/api/swagger/cpsData.yml6
2 files changed, 20 insertions, 2 deletions
diff --git a/cps-rest/docs/api/swagger/components.yaml b/cps-rest/docs/api/swagger/components.yaml
index 3b36b8b2fe..bc7aa57e7a 100644
--- a/cps-rest/docs/api/swagger/components.yaml
+++ b/cps-rest/docs/api/swagger/components.yaml
@@ -62,6 +62,22 @@ components:
required: true
schema:
type: string
+ xpathInQuery:
+ name: cps-path
+ in: query
+ description: cps-path
+ required: false
+ schema:
+ type: string
+ default: /
+ includeDescendantsOptionInQuery:
+ name: include-descendants
+ in: query
+ description: include-descendants
+ required: false
+ schema:
+ type: boolean
+ default: false
responses:
NotFound:
diff --git a/cps-rest/docs/api/swagger/cpsData.yml b/cps-rest/docs/api/swagger/cpsData.yml
index dcdb99adcb..97bf21a3e8 100644
--- a/cps-rest/docs/api/swagger/cpsData.yml
+++ b/cps-rest/docs/api/swagger/cpsData.yml
@@ -2,11 +2,13 @@ nodesByDataspaceAndAnchor:
get:
tags:
- cps-data
- summary: Get a node given an anchor for the given dataspace - DRAFT
+ summary: Get a node given an anchor for the given dataspace
operationId: getNodeByDataspaceAndAnchor
parameters:
- $ref: 'components.yaml#/components/parameters/dataspaceNameInPath'
- $ref: 'components.yaml#/components/parameters/anchorNameInPath'
+ - $ref: 'components.yaml#/components/parameters/xpathInQuery'
+ - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
responses:
200:
$ref: 'components.yaml#/components/responses/Ok'
@@ -49,7 +51,7 @@ nodesByDataspace:
tags:
- cps-data
summary: Get all nodes for a given dataspace using an xpath or schema node identifier - DRAFT
- operationId: getNode
+ operationId: getNodeByDataspace
parameters:
- $ref: 'components.yaml#/components/parameters/dataspaceNameInPath'
responses: