Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / 6d13f166f2e3d1c357677ad6f37f6e35238aeac6 / . / cps-rest / docs / api / swagger / cpsData.yml
blob: 9abace2047783c824cd7890c8797d50f66cf5f7e [file] [log] [blame]
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]1nodesByDataspaceAndAnchor:
2 get:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame^]3 description: Get a node with an option to retrieve all the children for a given anchor and dataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]4 tags:
5 - cps-data
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame^]6 summary: Get a node
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]7 operationId: getNodeByDataspaceAndAnchor
8 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame^]9 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
10 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
11 - $ref: 'components.yml#/components/parameters/xpathInQuery'
12 - $ref: 'components.yml#/components/parameters/includeDescendantsOptionInQuery'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]13 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame^]14 '200':
15 $ref: 'components.yml#/components/responses/Ok'
16 '400':
17 $ref: 'components.yml#/components/responses/BadRequest'
18 '401':
19 $ref: 'components.yml#/components/responses/Unauthorized'
20 '403':
21 $ref: 'components.yml#/components/responses/Forbidden'
22 '404':
23 $ref: 'components.yml#/components/responses/NotFound'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]24 x-codegen-request-body-name: xpath
25
niamhcore74753d92021-01-28 16:11:52 +0000[diff] [blame]26 post:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame^]27 description: Create a node for a given anchor and dataspace
niamhcore74753d92021-01-28 16:11:52 +0000[diff] [blame]28 tags:
29 - cps-data
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame^]30 summary: Create a node
niamhcore74753d92021-01-28 16:11:52 +0000[diff] [blame]31 operationId: createNode
32 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame^]33 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
34 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
niamhcore74753d92021-01-28 16:11:52 +0000[diff] [blame]35 requestBody:
36 required: true
37 content:
38 application/json:
39 schema:
40 type: string
41 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame^]42 '201':
43 $ref: 'components.yml#/components/responses/Created'
44 '400':
45 $ref: 'components.yml#/components/responses/BadRequest'
46 '401':
47 $ref: 'components.yml#/components/responses/Unauthorized'
48 '403':
49 $ref: 'components.yml#/components/responses/Forbidden'
niamhcore74753d92021-01-28 16:11:52 +0000[diff] [blame]50
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]51nodesByDataspace:
52 get:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame^]53 description: Get all nodes for a given dataspace using an xpath or schema node identifier - DRAFT
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]54 tags:
55 - cps-data
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame^]56 summary: Get nodes
57 operationId: getNodesByDataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]58 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame^]59 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]60 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame^]61 '200':
62 $ref: 'components.yml#/components/responses/Ok'
63 '400':
64 $ref: 'components.yml#/components/responses/BadRequest'
65 '401':
66 $ref: 'components.yml#/components/responses/Unauthorized'
67 '403':
68 $ref: 'components.yml#/components/responses/Forbidden'
69 '404':
70 $ref: 'components.yml#/components/responses/NotFound'
71 x-codegen-request-body-name: requestBody