summaryrefslogtreecommitdiffstats
path: root/cps-rest/docs
diff options
context:
space:
mode:
authorniamhcore <niamh.core@est.tech>2021-01-28 16:11:52 +0000
committerniamhcore <niamh.core@est.tech>2021-02-01 14:18:35 +0000
commit74753d923b77d87b17e8221ecc86a084446648b7 (patch)
tree19d933504e9a9040da75d478b2298b8413283c42 /cps-rest/docs
parent3cf66a1b795042ade82a8c9cb2b4df978bc6485d (diff)
Attach a (JSON) data instance for a container with children to a given Anchor
Issue-ID: CPS-26 Signed-off-by: niamhcore <niamh.core@est.tech> Change-Id: I38fc1b1a6ccf84e64eff3218372b40c8fa2491ba
Diffstat (limited to 'cps-rest/docs')
-rw-r--r--cps-rest/docs/api/swagger/cpsData.yml43
1 files changed, 22 insertions, 21 deletions
diff --git a/cps-rest/docs/api/swagger/cpsData.yml b/cps-rest/docs/api/swagger/cpsData.yml
index c33cf168e2..dcdb99adcb 100644
--- a/cps-rest/docs/api/swagger/cpsData.yml
+++ b/cps-rest/docs/api/swagger/cpsData.yml
@@ -20,46 +20,47 @@ nodesByDataspaceAndAnchor:
$ref: 'components.yaml#/components/responses/NotFound'
x-codegen-request-body-name: xpath
-nodesByDataspace:
- get:
+ post:
tags:
- cps-data
- summary: Get all nodes for a given dataspace using an xpath or schema node identifier - DRAFT
- operationId: getNode
+ summary: Create a node for a given anchor for the given dataspace
+ operationId: createNode
parameters:
- $ref: 'components.yaml#/components/parameters/dataspaceNameInPath'
+ - $ref: 'components.yaml#/components/parameters/anchorNameInPath'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: string
responses:
- 200:
- $ref: 'components.yaml#/components/responses/Ok'
+ 201:
+ $ref: 'components.yaml#/components/responses/Created'
400:
$ref: 'components.yaml#/components/responses/BadRequest'
401:
$ref: 'components.yaml#/components/responses/Unauthorized'
403:
$ref: 'components.yaml#/components/responses/Forbidden'
- 404:
- $ref: 'components.yaml#/components/responses/NotFound'
- x-codegen-request-body-name: requestBody
- post:
+nodesByDataspace:
+ get:
tags:
- cps-data
- summary: Create a node for a given anchor for the given dataspace - DRAFT
- operationId: createNode
+ summary: Get all nodes for a given dataspace using an xpath or schema node identifier - DRAFT
+ operationId: getNode
parameters:
- $ref: 'components.yaml#/components/parameters/dataspaceNameInPath'
- requestBody:
- content:
- multipart/form-data:
- schema:
- $ref: 'components.yaml#/components/schemas/MultipartFile'
- required: true
responses:
- 201:
- $ref: 'components.yaml#/components/responses/Created'
+ 200:
+ $ref: 'components.yaml#/components/responses/Ok'
400:
$ref: 'components.yaml#/components/responses/BadRequest'
401:
$ref: 'components.yaml#/components/responses/Unauthorized'
403:
- $ref: 'components.yaml#/components/responses/Forbidden' \ No newline at end of file
+ $ref: 'components.yaml#/components/responses/Forbidden'
+ 404:
+ $ref: 'components.yaml#/components/responses/NotFound'
+ x-codegen-request-body-name: requestBody \ No newline at end of file