fix issue for k8scluster on action "kdu_name" instead 'vdu_name'
[osm/NBI.git] / osm_nbi / resources_to_operations.yml
1 # Copyright 2018 Whitestack, LLC
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License"); you may
4 # not use this file except in compliance with the License. You may obtain
5 # a copy of the License at
6 #
7 #         http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 # License for the specific language governing permissions and limitations
13 # under the License.
14 #
15 # For those usages not covered by the Apache License, Version 2.0 please
16 # contact: esousa@whitestack.com or glavado@whitestack.com
17 ##
18
19 ### NOTE: This is INFORMATIVE ONLY!!!!
20 ### The right values are at module osm_nbi/nbi.py variable 'valid_url_methods' under ROLE_OPERATIONS key
21 ---
22 resources_to_operations:
23
24 ##
25 # The resources are defined using the following pattern:
26 #
27 #     "<METHOD> <PATH>": <OPERATION>
28 #
29 # Where <METHOD> refers to the HTTP Method being used, i.e. GET, POST, DELETE.
30 # The <PATH> refers to the path after http(s)://<ip-or-domain>:<port>/osm
31 # In the <PATH> variable parts should be replaced, using the <variable_name>
32 # notation. Inside the RBAC module these variables can be extracted for further
33 # analysis.
34 #
35 # NOTE: the <artifactPath> tag is reserved for artifact path (or file locations).
36 #       meaning that it retains a special meaning.
37 #
38 # Operations are organized in a hierarchical tree, where <OPERATION> defines
39 # the full path until the leaf (all the nodes in between need to be specified).
40 #
41 # NOTE: The end user should not modify this file.
42 ##
43
44 ################################################################################
45 ##################################### NSDs #####################################
46 ################################################################################
47
48   "GET /nsd/v1/ns_descriptors_content": "nsds:get"
49   "GET /nsd/v1/ns_descriptors": "nsds:get"
50
51   "POST /nsd/v1/ns_descriptors_content": "nsds:content:post"
52
53   "GET /nsd/v1/ns_descriptors_content/<nsdInfoId>": "nsds:id:get"
54   "GET /nsd/v1/ns_descriptors/<nsdInfoId>": "nsds:id:get"
55
56   "PUT /nsd/v1/ns_descriptors_content/<nsdInfoId>": "nsds:id:put"
57
58   "DELETE /nsd/v1/ns_descriptors_content/<nsdInfoId>": "nsds:id:delete"
59   "DELETE /nsd/v1/ns_descriptors/<nsdInfoId>": "nsds:id:delete"
60
61   "POST /nsd/v1/ns_descriptors": "nsds:post"
62
63   "PATCH /nsd/v1/ns_descriptors/<nsdInfoId>": "nsds:id:patch"
64
65   "GET /nsd/v1/ns_descriptors/<nsdInfoId>/nsd_content": "nsds:id:content:get"
66
67   "PUT /nsd/v1/ns_descriptors/<nsdInfoId>/nsd_content": "nsds:id:content:put"
68
69   "GET /nsd/v1/ns_descriptors/<nsdInfoId>/nsd": "nsds:id:nsd:get"
70
71   "GET /nsd/v1/ns_descriptors/<nsdInfoId>/artifacts": "nsds:id:nsd_artifact:get"
72   "GET /nsd/v1/ns_descriptors/<nsdInfoId>/artifacts/<artifactPath>": "nsds:id:nsd_artifact:get"
73
74 ################################################################################
75 ##################################### VNFDs ####################################
76 ################################################################################
77
78   "GET /vnfpkgm/v1/vnf_packages_content": "vnfds:get"
79   "GET /vnfpkgm/v1/vnf_packages": "vnfds:get"
80
81   "POST /vnfpkgm/v1/vnf_packages_content": "vnfds:content:post"
82
83   "GET /vnfpkgm/v1/vnf_packages_content/<vnfPkgId>": "vnfds:id:get"
84   "GET /vnfpkgm/v1/vnf_packages/<vnfPkgId>": "vnfds:id:get"
85
86   "PUT /vnfpkgm/v1/vnf_packages_content/<vnfPkgId>": "vnfds:id:put"
87
88   "DELETE /vnfpkgm/v1/vnf_packages_content/<vnfPkgId>": "vnfds:id:delete"
89   "DELETE /vnfpkgm/v1/vnf_packages/<vnfPkgId>": "vnfds:id:delete"
90
91   "POST /vnfpkgm/v1/vnf_packages": "vnfds:post"
92
93   "PATCH /vnfpkgm/v1/vnf_packages/<vnfPkgId>": "vnfds:id:patch"
94
95   "GET /vnfpkgm/v1/vnf_packages/<vnfPkgId>/package_content": "vnfds:id:content:get"
96
97   "PUT /vnfpkgm/v1/vnf_packages/<vnfPkgId>/package_content": "vnfds:id:content:put"
98
99   "POST /vnfpkgm/v1/vnf_packages/<vnfPkgId>/package_content/upload_from_uri": "vnfds:id:upload:post"
100
101   "GET /vnfpkgm/v1/vnf_packages/<vnfPkgId>/vnfd": "vnfds:id:vnfd:get"
102
103   "GET /vnfpkgm/v1/vnf_packages/<vnfPkgId>/artifacts": "vnfds:id:vnfd_artifact:get"
104   "GET /vnfpkgm/v1/vnf_packages/<vnfPkgId>/artifacts/<artifactPath>": "vnfds:id:vnfd_artifact:get"
105
106 ################################################################################
107 ################################## NS Instances ################################
108 ################################################################################
109
110   "GET /nslcm/v1/ns_instances_content": "ns_instances:get"
111   "GET /nslcm/v1/ns_instances": "ns_instances:get"
112
113   "POST /nslcm/v1/ns_instances_content": "ns_instances:content:post"
114
115   "GET /nslcm/v1/ns_instances_content/<nsInstanceId>": "ns_instances:id:get"
116   "GET /nslcm/v1/ns_instances/<nsInstanceId>": "ns_instances:id:get"
117
118   "DELETE /nslcm/v1/ns_instances_content/<nsInstanceId>": "ns_instances:id:delete"
119   "DELETE /nslcm/v1/ns_instances/<nsInstanceId>": "ns_instances:id:delete"
120
121   "POST /nslcm/v1/ns_instances": "ns_instances:post"
122
123   "POST /nslcm/v1/ns_instances/<nsInstanceId>/instantiate": "ns_instances:id:instantiate:post"
124
125   "POST /nslcm/v1/ns_instances/<nsInstanceId>/terminate": "ns_instances:id:terminate:post"
126
127   "POST /nslcm/v1/ns_instances/<nsInstanceId>/action": "ns_instances:id:action:post"
128
129   "POST /nslcm/v1/ns_instances/<nsInstanceId>/scale": "ns_instances:id:scale:post"
130
131   "GET /nslcm/v1/ns_lcm_op_occs": "ns_instances:opps:get"
132
133   "GET /nslcm/v1/ns_lcm_op_occs/<nsLcmOpOccId>": "ns_instances:opps:id:get"
134
135 ################################################################################
136 ################################# VNF Instances ################################
137 ################################################################################
138
139   "GET /nslcm/v1/vnfrs": "vnf_instances:get"
140   "GET /nslcm/v1/vnf_instances": "vnf_instances:get"
141
142   "GET /nslcm/v1/vnfrs/<vnfInstanceId>": "vnf_instances:id:get"
143   "GET /nslcm/v1/vnf_instances/<vnfInstanceId>": "vnf_instances:id:get"
144
145 ################################################################################
146 #################################### Tokens ####################################
147 ################################################################################
148
149   "GET /admin/v1/tokens": "tokens:get"
150
151   "POST /admin/v1/tokens": "tokens:post"
152
153   "DELETE /admin/v1/tokens": "tokens:delete"
154
155   "GET /admin/v1/tokens/<id>": "tokens:id:get"
156
157   "DELETE /admin/v1/tokens/<id>": "tokens:id:delete"
158
159 ################################################################################
160 ##################################### Users ####################################
161 ################################################################################
162
163   "GET /admin/v1/users": "users:get"
164
165   "POST /admin/v1/users": "users:post"
166
167   "GET /admin/v1/users/<id>": "users:id:get"
168
169   "DELETE /admin/v1/users/<id>": "users:id:delete"
170
171   "PATCH /admin/v1/users/<id>": "users:id:patch"
172
173 ################################################################################
174 #################################### Projects ##################################
175 ################################################################################
176
177   "GET /admin/v1/projects": "projects:get"
178
179   "POST /admin/v1/projects": "projects:post"
180
181   "GET /admin/v1/projects/<id>": "projects:id:get"
182
183   "PATCH /admin/v1/projects/<id>": "projects:id:patch"
184
185   "DELETE /admin/v1/projects/<id>": "projects:id:delete"
186
187 ################################################################################
188 ##################################### VIMs #####################################
189 ################################################################################
190
191   "GET /admin/v1/vims": "vims:get"
192
193   "POST /admin/v1/vims": "vims:post"
194
195   "GET /admin/v1/vims/<id>": "vims:id:get"
196
197   "DELETE /admin/v1/vims/<id>": "vims:id:delete"
198
199   "PATCH /admin/v1/vims/<id>": "vims:id:patch"
200
201 ################################################################################
202 ################################## VIM Accounts ################################
203 ################################################################################
204
205   "GET /admin/v1/vim_accounts": "vim_accounts:get"
206
207   "POST /admin/v1/vim_accounts": "vim_accounts:post"
208
209   "GET /admin/v1/vim_accounts/<id>": "vim_accounts:id:get"
210
211   "DELETE /admin/v1/vim_accounts/<id>": "vim_accounts:id:delete"
212
213   "PATCH /admin/v1/vim_accounts/<id>": "vim_accounts:id:patch"
214
215 ################################################################################
216 ################################# SDN Controllers ##############################
217 ################################################################################
218
219   "GET /admin/v1/sdns": "sdn_controllers:get"
220
221   "POST /admin/v1/sdns": "sdn_controllers:post"
222
223   "GET /admin/v1/sdns/<id>": "sdn_controllers:id:get"
224
225   "DELETE /admin/v1/sdns/<id>": "sdn_controllers:id:delete"
226
227   "PATCH /admin/v1/sdns/<id>": "sdn_controllers:id:patch"
228
229 ################################################################################
230 ##################################### WIMs #####################################
231 ################################################################################
232
233   "GET /admin/v1/wims": "wims:get"
234
235   "POST /admin/v1/wims": "wims:post"
236
237   "GET /admin/v1/wims/<id>": "wims:id:get"
238
239   "DELETE /admin/v1/wims/<id>": "wims:id:delete"
240
241   "PATCH /admin/v1/wims/<id>": "wims:id:patch"
242
243 ################################################################################
244 ################################## WIM Accounts ################################
245 ################################################################################
246
247   "GET /admin/v1/wim_accounts": "wim_accounts:get"
248
249   "POST /admin/v1/wim_accounts": "wim_accounts:post"
250
251   "GET /admin/v1/wim_accounts/<id>": "wim_accounts:id:get"
252
253   "DELETE /admin/v1/wim_accounts/<id>": "wim_accounts:id:delete"
254
255   "PATCH /admin/v1/wim_accounts/<id>": "wim_accounts:id:patch"
256
257 ################################################################################
258 ##################################### Roles ####################################
259 ################################################################################
260
261   "GET /admin/v1/roles": "roles:get"
262
263   "POST /admin/v1/roles": "roles:post"
264
265   "GET /admin/v1/roles/<id>": "roles:id:get"
266
267   "DELETE /admin/v1/roles/<id>": "roles:id:delete"
268
269   "PATCH /admin/v1/roles/<id>": "roles:id:patch"
270
271 ################################################################################
272 ##################################### PDUDs ####################################
273 ################################################################################
274
275   "GET /pdu/v1/pdu_descriptors": "pduds:get"
276
277   "POST /pdu/v1/pdu_descriptors": "pduds:post"
278
279   "PUT /pdu/v1/pdu_descriptors": "pduds:put"
280
281   "DELETE /pdu/v1/pdu_descriptors": "pduds:delete"
282
283   "PATCH /pdu/v1/pdu_descriptors": "pduds:patch"
284
285   "GET /pdu/v1/pdu_descriptors/<id>": "pduds:id:get"
286
287   "POST /pdu/v1/pdu_descriptors/<id>": "pduds:id:post"
288
289   "PUT /pdu/v1/pdu_descriptors/<id>": "pduds:id:put"
290
291   "DELETE /pdu/v1/pdu_descriptors/<id>": "pduds:id:delete"
292
293   "PATCH /pdu/v1/pdu_descriptors/<id>": "pduds:id:patch"
294
295 ################################################################################
296 ############################ Network Slice Templates ###########################
297 ################################################################################
298
299   "GET /nst/v1/netslice_templates_content": "slice_templates:get"
300   "GET /nst/v1/netslice_templates": "slice_templates:get"
301
302   "POST /nst/v1/netslice_templates_content": "slice_templates:content:post"
303
304   "GET /nst/v1/netslice_templates_content/<nstInfoId>": "slice_templates:id:get"
305   "GET /nst/v1/netslice_templates/<nstInfoId>": "slice_templates:id:get"
306
307   "PUT /nst/v1/netslice_templates_content/<nstInfoId>": "slice_templates:id:put"
308
309   "DELETE /nst/v1/netslice_templates_content/<nstInfoId>": "slice_templates:id:delete"
310   "DELETE /nst/v1/netslice_templates/<nstInfoId>": "slice_templates:id:delete"
311
312   "PATCH /nst/v1/netslice_templates/<nstInfoId>": "slice_templates:id:patch"
313
314   "GET /nst/v1/netslice_templates/<nstInfoId>/nst_content": "slice_templates:content:get"
315
316   "PUT /nst/v1/netslice_templates/<nstInfoId>/nst_content": "slice_templates:content:put"
317
318   "GET /nst/v1/netslice_templates/<nstInfoId>/nst": "slice_templates:id:nst:get"
319
320   "GET /nst/v1/netslice_templates/<nstInfoId>/artifacts": "slice_templates:id:nst_artifact:get"
321   "GET /nst/v1/netslice_templates/<nstInfoId>/artifacts/<artifactPath>": "slice_templates:id:nst_artifact:get"
322
323 ################################################################################
324 ############################ Network Slice Instances ###########################
325 ################################################################################
326
327   "GET /nsilcm/v1/netslice_instances_content": "slice_instances:get"
328   "GET /nsilcm/v1/netslice_instances": "slice_instances:get"
329
330   "POST /nsilcm/v1/netslice_instances_content": "slice_instances:content:post"
331
332   "GET /nsilcm/v1/netslice_instances_content/<SliceInstanceId>": "slice_instances:id:get"
333   "GET /nsilcm/v1/netslice_instances/<SliceInstanceId>": "slice_instances:id:get"
334
335   "DELETE /nsilcm/v1/netslice_instances_content/<SliceInstanceId>": "slice_instances:id:delete"
336   "DELETE /nsilcm/v1/netslice_instances/<SliceInstanceId>": "slice_instances:id:delete"
337
338   "POST /nsilcm/v1/netslice_instances": "slice_instances:post"
339
340   "POST /nsilcm/v1/netslice_instances/<SliceInstanceId>/instantiate": "slice_instances:id:instantiate:post"
341
342   "POST /nsilcm/v1/netslice_instances/<SliceInstanceId>/terminate": "slice_instances:id:terminate:post"
343
344   "POST /nsilcm/v1/netslice_instances/<SliceInstanceId>/action": "slice_instances:id:action:post"
345
346   "GET /nsilcm/v1/nsi_lcm_op_occs": "slice_instances:opps:get"
347
348   "GET /nsilcm/v1/nsi_lcm_op_occs/<nsiLcmOpOccId>": "slice_instances:opps:id:get"
349
350 ################################################################################
351 ############################ QUERY STRING admin operations #####################
352 ################################################################################
353
354   "GET ?ADMIN":    "admin:get"
355   "POST ?ADMIN":   "admin:post"
356   "PATCH ?ADMIN":  "admin:patch"
357   "PUT ?ADMIN":    "admin:put"
358   "DELETE ?ADMIN": "admin:delete"
359
360   "GET ?FORCE":    "force:get"
361   "POST ?FORCE":   "force:post"
362   "PATCH ?FORCE":  "force:patch"
363   "PUT ?FORCE":    "force:put"
364   "DELETE ?FORCE": "force:delete"
365
366   "GET ?PUBLIC":    "public:get"
367   "POST ?PUBLIC":   "public:post"
368   "PATCH ?PUBLIC":  "public:patch"
369   "PUT ?PUBLIC":    "public:put"
370   "DELETE ?PUBLIC": "public:delete"
371
372   "GET ?SET_PROJECT":    "set_project:get"
373   "POST ?SET_PROJECT":   "set_project:post"
374   "PATCH ?SET_PROJECT":  "set_project:patch"
375   "PUT ?SET_PROJECT":    "set_project:put"
376   "DELETE ?SET_PROJECT": "set_project:delete"