Enable pylint, black and flake8 in tox.ini
[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   "POST /vnfpkgm/v1/vnf_packages/<vnfPkgId>/action": "vnfds:id:action:post"
107
108   "GET /vnfpkgm/v1/vnfpkg_op_occs": "vnfds:vnfpkgops:get"
109   "GET /vnfpkgm/v1/vnfpkg_op_occs/<vnfPkgOpId>": "vnfds:vnfpkgops:id:get"
110
111 ################################################################################
112 ################################## NS Instances ################################
113 ################################################################################
114
115   "GET /nslcm/v1/ns_instances_content": "ns_instances:get"
116   "GET /nslcm/v1/ns_instances": "ns_instances:get"
117
118   "POST /nslcm/v1/ns_instances_content": "ns_instances:content:post"
119
120   "GET /nslcm/v1/ns_instances_content/<nsInstanceId>": "ns_instances:id:get"
121   "GET /nslcm/v1/ns_instances/<nsInstanceId>": "ns_instances:id:get"
122
123   "DELETE /nslcm/v1/ns_instances_content/<nsInstanceId>": "ns_instances:id:delete"
124   "DELETE /nslcm/v1/ns_instances/<nsInstanceId>": "ns_instances:id:delete"
125
126   "POST /nslcm/v1/ns_instances": "ns_instances:post"
127
128   "POST /nslcm/v1/ns_instances/<nsInstanceId>/instantiate": "ns_instances:id:instantiate:post"
129
130   "POST /nslcm/v1/ns_instances/<nsInstanceId>/terminate": "ns_instances:id:terminate:post"
131
132   "POST /nslcm/v1/ns_instances/<nsInstanceId>/action": "ns_instances:id:action:post"
133
134   "POST /nslcm/v1/ns_instances/<nsInstanceId>/update": "ns_instances:id:update:post"
135
136   "POST /nslcm/v1/ns_instances/<nsInstanceId>/scale": "ns_instances:id:scale:post"
137
138   "POST /nslcm/v1/ns_instances/<nsInstanceId>/migrate": "ns_instances:id:migrate:post"
139
140   "GET /nslcm/v1/ns_lcm_op_occs": "ns_instances:opps:get"
141
142   "GET /nslcm/v1/ns_lcm_op_occs/<nsLcmOpOccId>": "ns_instances:opps:id:get"
143
144 ################################################################################
145 ################################# VNF Instances ################################
146 ################################################################################
147
148   "GET /nslcm/v1/vnfrs": "vnf_instances:get"
149   "GET /nslcm/v1/vnf_instances": "vnf_instances:get"
150
151   "GET /nslcm/v1/vnfrs/<vnfInstanceId>": "vnf_instances:id:get"
152   "GET /nslcm/v1/vnf_instances/<vnfInstanceId>": "vnf_instances:id:get"
153
154   "GET /vnflcm/v1/vnf_instances/": "vnflcm_instances:get"
155   "POST /vnflcm/v1/vnf_instances/": "vnflcm_instances:post"
156
157   "GET /vnflcm/v1/vnf_instances/<vnfInstanceId>": "vnflcm_instances:id:get"
158   "DELETE /vnflcm/v1/vnf_instances/<vnfInstanceId>": "vnflcm_instances:id:delete"
159
160 ################################################################################
161 #################################### Tokens ####################################
162 ################################################################################
163
164   "GET /admin/v1/tokens": "tokens:get"
165
166   "POST /admin/v1/tokens": "tokens:post"
167
168   "DELETE /admin/v1/tokens": "tokens:delete"
169
170   "GET /admin/v1/tokens/<id>": "tokens:id:get"
171
172   "DELETE /admin/v1/tokens/<id>": "tokens:id:delete"
173
174 ################################################################################
175 ##################################### Users ####################################
176 ################################################################################
177
178   "GET /admin/v1/users": "users:get"
179
180   "POST /admin/v1/users": "users:post"
181
182   "GET /admin/v1/users/<id>": "users:id:get"
183
184   "DELETE /admin/v1/users/<id>": "users:id:delete"
185
186   "PATCH /admin/v1/users/<id>": "users:id:patch"
187
188   "GET /admin/v1/domains": "domains:get"
189
190 ################################################################################
191 #################################### Projects ##################################
192 ################################################################################
193
194   "GET /admin/v1/projects": "projects:get"
195
196   "POST /admin/v1/projects": "projects:post"
197
198   "GET /admin/v1/projects/<id>": "projects:id:get"
199
200   "PATCH /admin/v1/projects/<id>": "projects:id:patch"
201
202   "DELETE /admin/v1/projects/<id>": "projects:id:delete"
203
204 ################################################################################
205 ##################################### VIMs #####################################
206 ################################################################################
207
208   "GET /admin/v1/vims": "vims:get"
209
210   "POST /admin/v1/vims": "vims:post"
211
212   "GET /admin/v1/vims/<id>": "vims:id:get"
213
214   "DELETE /admin/v1/vims/<id>": "vims:id:delete"
215
216   "PATCH /admin/v1/vims/<id>": "vims:id:patch"
217
218 ################################################################################
219 ################################## VIM Accounts ################################
220 ################################################################################
221
222   "GET /admin/v1/vim_accounts": "vim_accounts:get"
223
224   "POST /admin/v1/vim_accounts": "vim_accounts:post"
225
226   "GET /admin/v1/vim_accounts/<id>": "vim_accounts:id:get"
227
228   "DELETE /admin/v1/vim_accounts/<id>": "vim_accounts:id:delete"
229
230   "PATCH /admin/v1/vim_accounts/<id>": "vim_accounts:id:patch"
231
232 ################################################################################
233 ################################# K8s Clusters ##############################
234 ################################################################################
235
236   "GET /admin/v1/k8sclusters": "k8sclusters:get"
237
238   "POST /admin/v1/k8sclusters": "k8sclusters:post"
239
240   "GET /admin/v1/k8sclusters/<id>": "k8sclusters:id:get"
241
242   "DELETE /admin/v1/k8sclusters/<id>": "k8sclusters:id:delete"
243
244   "PATCH /admin/v1/k8sclusters/<id>": "k8sclusters:id:patch"
245
246 ################################################################################
247 ####################################### VCAs ###################################
248 ################################################################################
249
250   "GET /admin/v1/vca": "vca:get"
251
252   "POST /admin/v1/vca": "vca:post"
253
254   "GET /admin/v1/vca/<id>": "vca:id:get"
255
256   "DELETE /admin/v1/vca/<id>": "vca:id:delete"
257
258   "PATCH /admin/v1/vca/<id>": "vca:id:patch"
259
260 ################################################################################
261 ################################# K8s Repos ##############################
262 ################################################################################
263
264   "GET /admin/v1/k8srepos": "k8srepos:get"
265
266   "POST /admin/v1/k8srepos": "k8srepos:post"
267
268   "GET /admin/v1/k8srepos/<id>": "k8srepos:id:get"
269
270   "DELETE /admin/v1/k8srepos/<id>": "k8srepos:id:delete"
271
272 ################################################################################
273 ################################# SDN Controllers ##############################
274 ################################################################################
275
276   "GET /admin/v1/sdns": "sdn_controllers:get"
277
278   "POST /admin/v1/sdns": "sdn_controllers:post"
279
280   "GET /admin/v1/sdns/<id>": "sdn_controllers:id:get"
281
282   "DELETE /admin/v1/sdns/<id>": "sdn_controllers:id:delete"
283
284   "PATCH /admin/v1/sdns/<id>": "sdn_controllers:id:patch"
285
286 ################################################################################
287 ################################## WIM Accounts ################################
288 ################################################################################
289
290   "GET /admin/v1/wim_accounts": "wim_accounts:get"
291
292   "POST /admin/v1/wim_accounts": "wim_accounts:post"
293
294   "GET /admin/v1/wim_accounts/<id>": "wim_accounts:id:get"
295
296   "DELETE /admin/v1/wim_accounts/<id>": "wim_accounts:id:delete"
297
298   "PATCH /admin/v1/wim_accounts/<id>": "wim_accounts:id:patch"
299
300 ################################################################################
301 ##################################### Roles ####################################
302 ################################################################################
303
304   "GET /admin/v1/roles": "roles:get"
305
306   "POST /admin/v1/roles": "roles:post"
307
308   "GET /admin/v1/roles/<id>": "roles:id:get"
309
310   "DELETE /admin/v1/roles/<id>": "roles:id:delete"
311
312   "PATCH /admin/v1/roles/<id>": "roles:id:patch"
313
314 ################################################################################
315 ##################################### PDUDs ####################################
316 ################################################################################
317
318   "GET /pdu/v1/pdu_descriptors": "pduds:get"
319
320   "POST /pdu/v1/pdu_descriptors": "pduds:post"
321
322   "PUT /pdu/v1/pdu_descriptors": "pduds:put"
323
324   "DELETE /pdu/v1/pdu_descriptors": "pduds:delete"
325
326   "PATCH /pdu/v1/pdu_descriptors": "pduds:patch"
327
328   "GET /pdu/v1/pdu_descriptors/<id>": "pduds:id:get"
329
330   "POST /pdu/v1/pdu_descriptors/<id>": "pduds:id:post"
331
332   "PUT /pdu/v1/pdu_descriptors/<id>": "pduds:id:put"
333
334   "DELETE /pdu/v1/pdu_descriptors/<id>": "pduds:id:delete"
335
336   "PATCH /pdu/v1/pdu_descriptors/<id>": "pduds:id:patch"
337
338 ################################################################################
339 ############################ Network Slice Templates ###########################
340 ################################################################################
341
342   "GET /nst/v1/netslice_templates_content": "slice_templates:get"
343   "GET /nst/v1/netslice_templates": "slice_templates:get"
344
345   "POST /nst/v1/netslice_templates_content": "slice_templates:content:post"
346
347   "GET /nst/v1/netslice_templates_content/<nstInfoId>": "slice_templates:id:get"
348   "GET /nst/v1/netslice_templates/<nstInfoId>": "slice_templates:id:get"
349
350   "PUT /nst/v1/netslice_templates_content/<nstInfoId>": "slice_templates:id:put"
351
352   "DELETE /nst/v1/netslice_templates_content/<nstInfoId>": "slice_templates:id:delete"
353   "DELETE /nst/v1/netslice_templates/<nstInfoId>": "slice_templates:id:delete"
354
355   "PATCH /nst/v1/netslice_templates/<nstInfoId>": "slice_templates:id:patch"
356
357   "GET /nst/v1/netslice_templates/<nstInfoId>/nst_content": "slice_templates:content:get"
358
359   "PUT /nst/v1/netslice_templates/<nstInfoId>/nst_content": "slice_templates:content:put"
360
361   "GET /nst/v1/netslice_templates/<nstInfoId>/nst": "slice_templates:id:nst:get"
362
363   "GET /nst/v1/netslice_templates/<nstInfoId>/artifacts": "slice_templates:id:nst_artifact:get"
364   "GET /nst/v1/netslice_templates/<nstInfoId>/artifacts/<artifactPath>": "slice_templates:id:nst_artifact:get"
365
366 ################################################################################
367 ############################ Network Slice Instances ###########################
368 ################################################################################
369
370   "GET /nsilcm/v1/netslice_instances_content": "slice_instances:get"
371   "GET /nsilcm/v1/netslice_instances": "slice_instances:get"
372
373   "POST /nsilcm/v1/netslice_instances_content": "slice_instances:content:post"
374
375   "GET /nsilcm/v1/netslice_instances_content/<SliceInstanceId>": "slice_instances:id:get"
376   "GET /nsilcm/v1/netslice_instances/<SliceInstanceId>": "slice_instances:id:get"
377
378   "DELETE /nsilcm/v1/netslice_instances_content/<SliceInstanceId>": "slice_instances:id:delete"
379   "DELETE /nsilcm/v1/netslice_instances/<SliceInstanceId>": "slice_instances:id:delete"
380
381   "POST /nsilcm/v1/netslice_instances": "slice_instances:post"
382
383   "POST /nsilcm/v1/netslice_instances/<SliceInstanceId>/instantiate": "slice_instances:id:instantiate:post"
384
385   "POST /nsilcm/v1/netslice_instances/<SliceInstanceId>/terminate": "slice_instances:id:terminate:post"
386
387   "POST /nsilcm/v1/netslice_instances/<SliceInstanceId>/action": "slice_instances:id:action:post"
388
389   "GET /nsilcm/v1/nsi_lcm_op_occs": "slice_instances:opps:get"
390
391   "GET /nsilcm/v1/nsi_lcm_op_occs/<nsiLcmOpOccId>": "slice_instances:opps:id:get"
392
393 ################################################################################
394 ############################ QUERY STRING admin operations #####################
395 ################################################################################
396
397   "GET ?ADMIN":    "admin:get"
398   "POST ?ADMIN":   "admin:post"
399   "PATCH ?ADMIN":  "admin:patch"
400   "PUT ?ADMIN":    "admin:put"
401   "DELETE ?ADMIN": "admin:delete"
402
403   "GET ?FORCE":    "force:get"
404   "POST ?FORCE":   "force:post"
405   "PATCH ?FORCE":  "force:patch"
406   "PUT ?FORCE":    "force:put"
407   "DELETE ?FORCE": "force:delete"
408
409   "GET ?PUBLIC":    "public:get"
410   "POST ?PUBLIC":   "public:post"
411   "PATCH ?PUBLIC":  "public:patch"
412   "PUT ?PUBLIC":    "public:put"
413   "DELETE ?PUBLIC": "public:delete"
414
415   "GET ?SET_PROJECT":    "set_project:get"
416   "POST ?SET_PROJECT":   "set_project:post"
417   "PATCH ?SET_PROJECT":  "set_project:patch"
418   "PUT ?SET_PROJECT":    "set_project:put"
419   "DELETE ?SET_PROJECT": "set_project:delete"