Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / 24bf350947acb7fcb62878932d520387bc922a96 / . / cps-rest / docs / api / swagger / cpsData.yml
blob: 54c89661b9e151e5e2f63243b2f78880e369eb3e [file] [log] [blame]
Rishi.Chaildacc6632021-01-27 04:27:34 +0000[diff] [blame]1nodeByDataspaceAndAnchor:
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]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
Rishi.Chaildacc6632021-01-27 04:27:34 +0000[diff] [blame]26nodesByDataspaceAndAnchor:
niamhcore74753d92021-01-28 16:11:52 +0000[diff] [blame]27 post:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]28 description: Create a node for a given anchor and dataspace
niamhcore74753d92021-01-28 16:11:52 +0000[diff] [blame]29 tags:
30 - cps-data
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]31 summary: Create a node
niamhcore74753d92021-01-28 16:11:52 +0000[diff] [blame]32 operationId: createNode
33 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]34 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
35 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
Ruslan Kashapov24bf3502021-04-19 12:40:01 +0300[diff] [blame^]36 - $ref: 'components.yml#/components/parameters/xpathInQuery'
niamhcore74753d92021-01-28 16:11:52 +0000[diff] [blame]37 requestBody:
38 required: true
39 content:
40 application/json:
41 schema:
42 type: string
43 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]44 '201':
45 $ref: 'components.yml#/components/responses/Created'
46 '400':
47 $ref: 'components.yml#/components/responses/BadRequest'
48 '401':
49 $ref: 'components.yml#/components/responses/Unauthorized'
50 '403':
51 $ref: 'components.yml#/components/responses/Forbidden'
niamhcore74753d92021-01-28 16:11:52 +0000[diff] [blame]52
Ruslan Kashapov24c72db2021-02-09 17:25:18 +0200[diff] [blame]53 patch:
54 description: Update a data node leaves for a given dataspace and anchor and a parent node xpath
55 tags:
56 - cps-data
57 summary: Update node leaves
58 operationId: updateNodeLeaves
59 parameters:
60 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
61 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
62 - $ref: 'components.yml#/components/parameters/xpathInQuery'
63 requestBody:
64 required: true
65 content:
66 application/json:
67 schema:
68 type: string
69 responses:
70 '200':
71 $ref: 'components.yml#/components/responses/Ok'
72 '400':
73 $ref: 'components.yml#/components/responses/BadRequest'
74 '401':
75 $ref: 'components.yml#/components/responses/Unauthorized'
76 '403':
77 $ref: 'components.yml#/components/responses/Forbidden'
78
79 put:
80 description: Replace a node with descendants for a given dataspace, anchor and a parent node xpath
81 tags:
82 - cps-data
83 summary: Replace a node with descendants
84 operationId: replaceNode
85 parameters:
86 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
87 - $ref: 'components.yml#/components/parameters/anchorNameInPath'
88 - $ref: 'components.yml#/components/parameters/xpathInQuery'
89 requestBody:
90 required: true
91 content:
92 application/json:
93 schema:
94 type: string
95 responses:
96 '200':
97 $ref: 'components.yml#/components/responses/Ok'
98 '400':
99 $ref: 'components.yml#/components/responses/BadRequest'
100 '401':
101 $ref: 'components.yml#/components/responses/Unauthorized'
102 '403':
103 $ref: 'components.yml#/components/responses/Forbidden'
104
105
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]106nodesByDataspace:
107 get:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]108 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]109 tags:
110 - cps-data
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]111 summary: Get nodes
112 operationId: getNodesByDataspace
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]113 parameters:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]114 - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]115 responses:
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]116 '200':
117 $ref: 'components.yml#/components/responses/Ok'
118 '400':
119 $ref: 'components.yml#/components/responses/BadRequest'
120 '401':
121 $ref: 'components.yml#/components/responses/Unauthorized'
122 '403':
123 $ref: 'components.yml#/components/responses/Forbidden'
124 '404':
125 $ref: 'components.yml#/components/responses/NotFound'
126 x-codegen-request-body-name: requestBody