blob: 6ed4f0223768df6f7823f3246c4d27ab63a104d0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
# ============LICENSE_START=======================================================
# Copyright (C) 2021 Nordix Foundation
# Modifications Copyright (C) 2021 Pantheon.tech
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# ============LICENSE_END=========================================================
nodeByCmHandleAndXpath:
get:
description: Get a node with an option to retrieve all the children for a given cm Handle
tags:
- network-cm-proxy
summary: Get a node given a cm Handle and xpath
operationId: getNodeByCmHandleAndXpath
parameters:
- $ref: 'components.yaml#/components/parameters/cmHandleInPath'
- $ref: 'components.yaml#/components/parameters/xpathInQuery'
- $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
responses:
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'
404:
$ref: 'components.yaml#/components/responses/NotFound'
nodesByCmHandleAndCpsPath:
get:
description: Query nodes for the given cps path and cm Handle
tags:
- network-cm-proxy
summary: Query data nodes
operationId: queryNodesByCmHandleAndCpsPath
parameters:
- $ref: 'components.yaml#/components/parameters/cmHandleInPath'
- $ref: 'components.yaml#/components/parameters/cpsPathInQuery'
- $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
responses:
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'
404:
$ref: 'components.yaml#/components/responses/NotFound'
nodesByCmHandleAndXpath:
post:
description: Create a node with descendants for the given CM Handle; top level or under existing node (requires xpath)
tags:
- network-cm-proxy
summary: Create a node with descendants
operationId: createNode
parameters:
- $ref: 'components.yaml#/components/parameters/cmHandleInPath'
- $ref: 'components.yaml#/components/parameters/xpathInQuery'
requestBody:
required: true
content:
application/json:
schema:
type: string
responses:
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'
patch:
description: Update node leaves for the given cps path and cm Handle
tags:
- network-cm-proxy
summary: Update node leaves
operationId: updateNodeLeaves
parameters:
- $ref: 'components.yaml#/components/parameters/cmHandleInPath'
- $ref: 'components.yaml#/components/parameters/xpathInQuery'
requestBody:
required: true
content:
application/json:
schema:
type: string
responses:
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'
404:
$ref: 'components.yaml#/components/responses/NotFound'
put:
description: Replace a node with descendants for the given cps path and cm Handle
tags:
- network-cm-proxy
summary: Replace a node with descendants
operationId: replaceNode
parameters:
- $ref: 'components.yaml#/components/parameters/cmHandleInPath'
- $ref: 'components.yaml#/components/parameters/xpathInQuery'
requestBody:
required: true
content:
application/json:
schema:
type: string
responses:
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'
404:
$ref: 'components.yaml#/components/responses/NotFound'
listNodeByCmHandleAndXpath:
post:
description: Add one or more list-node child elements under existing node for the given CM Handle
tags:
- network-cm-proxy
summary: Add list-node child element(s)
operationId: addListNodeElements
parameters:
- $ref: 'components.yaml#/components/parameters/cmHandleInPath'
- $ref: 'components.yaml#/components/parameters/requiredXpathInQuery'
requestBody:
required: true
content:
application/json:
schema:
type: string
responses:
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'
|
