1 # Copyright 2018 Whitestack, LLC
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
7 # http://www.apache.org/licenses/LICENSE-2.0
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
15 # For those usages not covered by the Apache License, Version 2.0 please
16 # contact: esousa@whitestack.com or glavado@whitestack.com
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
22 resources_to_operations:
25 # The resources are defined using the following pattern:
27 # "<METHOD> <PATH>": <OPERATION>
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
35 # NOTE: the <artifactPath> tag is reserved for artifact path (or file locations).
36 # meaning that it retains a special meaning.
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).
41 # NOTE: The end user should not modify this file.
44 ################################################################################
45 ##################################### NSDs #####################################
46 ################################################################################
48 "GET /nsd/v1/ns_descriptors_content": "nsds:get"
49 "GET /nsd/v1/ns_descriptors": "nsds:get"
51 "POST /nsd/v1/ns_descriptors_content": "nsds:content:post"
53 "GET /nsd/v1/ns_descriptors_content/<nsdInfoId>": "nsds:id:get"
54 "GET /nsd/v1/ns_descriptors/<nsdInfoId>": "nsds:id:get"
56 "PUT /nsd/v1/ns_descriptors_content/<nsdInfoId>": "nsds:id:put"
58 "DELETE /nsd/v1/ns_descriptors_content/<nsdInfoId>": "nsds:id:delete"
59 "DELETE /nsd/v1/ns_descriptors/<nsdInfoId>": "nsds:id:delete"
61 "POST /nsd/v1/ns_descriptors": "nsds:post"
63 "PATCH /nsd/v1/ns_descriptors/<nsdInfoId>": "nsds:id:patch"
65 "GET /nsd/v1/ns_descriptors/<nsdInfoId>/nsd_content": "nsds:id:content:get"
67 "PUT /nsd/v1/ns_descriptors/<nsdInfoId>/nsd_content": "nsds:id:content:put"
69 "GET /nsd/v1/ns_descriptors/<nsdInfoId>/nsd": "nsds:id:nsd:get"
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"
74 ################################################################################
75 ##################################### VNFDs ####################################
76 ################################################################################
78 "GET /vnfpkgm/v1/vnf_packages_content": "vnfds:get"
79 "GET /vnfpkgm/v1/vnf_packages": "vnfds:get"
81 "POST /vnfpkgm/v1/vnf_packages_content": "vnfds:content:post"
83 "GET /vnfpkgm/v1/vnf_packages_content/<vnfPkgId>": "vnfds:id:get"
84 "GET /vnfpkgm/v1/vnf_packages/<vnfPkgId>": "vnfds:id:get"
86 "PUT /vnfpkgm/v1/vnf_packages_content/<vnfPkgId>": "vnfds:id:put"
88 "DELETE /vnfpkgm/v1/vnf_packages_content/<vnfPkgId>": "vnfds:id:delete"
89 "DELETE /vnfpkgm/v1/vnf_packages/<vnfPkgId>": "vnfds:id:delete"
91 "POST /vnfpkgm/v1/vnf_packages": "vnfds:post"
93 "PATCH /vnfpkgm/v1/vnf_packages/<vnfPkgId>": "vnfds:id:patch"
95 "GET /vnfpkgm/v1/vnf_packages/<vnfPkgId>/package_content": "vnfds:id:content:get"
97 "PUT /vnfpkgm/v1/vnf_packages/<vnfPkgId>/package_content": "vnfds:id:content:put"
99 "POST /vnfpkgm/v1/vnf_packages/<vnfPkgId>/package_content/upload_from_uri": "vnfds:id:upload:post"
101 "GET /vnfpkgm/v1/vnf_packages/<vnfPkgId>/vnfd": "vnfds:id:vnfd:get"
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"
106 "POST /vnfpkgm/v1/vnf_packages/<vnfPkgId>/action": "vnfds:id:action:post"
108 "GET /vnfpkgm/v1/vnfpkg_op_occs": "vnfds:vnfpkgops:get"
109 "GET /vnfpkgm/v1/vnfpkg_op_occs/<vnfPkgOpId>": "vnfds:vnfpkgops:id:get"
111 ################################################################################
112 ################################## NS Instances ################################
113 ################################################################################
115 "GET /nslcm/v1/ns_instances_content": "ns_instances:get"
116 "GET /nslcm/v1/ns_instances": "ns_instances:get"
118 "POST /nslcm/v1/ns_instances_content": "ns_instances:content:post"
120 "GET /nslcm/v1/ns_instances_content/<nsInstanceId>": "ns_instances:id:get"
121 "GET /nslcm/v1/ns_instances/<nsInstanceId>": "ns_instances:id:get"
123 "DELETE /nslcm/v1/ns_instances_content/<nsInstanceId>": "ns_instances:id:delete"
124 "DELETE /nslcm/v1/ns_instances/<nsInstanceId>": "ns_instances:id:delete"
126 "POST /nslcm/v1/ns_instances": "ns_instances:post"
128 "POST /nslcm/v1/ns_instances/<nsInstanceId>/instantiate": "ns_instances:id:instantiate:post"
130 "POST /nslcm/v1/ns_instances/<nsInstanceId>/terminate": "ns_instances:id:terminate:post"
132 "POST /nslcm/v1/ns_instances/<nsInstanceId>/action": "ns_instances:id:action:post"
134 "POST /nslcm/v1/ns_instances/<nsInstanceId>/update": "ns_instances:id:update:post"
136 "POST /nslcm/v1/ns_instances/<nsInstanceId>/scale": "ns_instances:id:scale:post"
138 "POST /nslcm/v1/ns_instances/<nsInstanceId>/migrate": "ns_instances:id:migrate:post"
140 "GET /nslcm/v1/ns_lcm_op_occs": "ns_instances:opps:get"
142 "GET /nslcm/v1/ns_lcm_op_occs/<nsLcmOpOccId>": "ns_instances:opps:id:get"
144 ################################################################################
145 ################################# VNF Instances ################################
146 ################################################################################
148 "GET /nslcm/v1/vnfrs": "vnf_instances:get"
149 "GET /nslcm/v1/vnf_instances": "vnf_instances:get"
151 "GET /nslcm/v1/vnfrs/<vnfInstanceId>": "vnf_instances:id:get"
152 "GET /nslcm/v1/vnf_instances/<vnfInstanceId>": "vnf_instances:id:get"
154 "GET /vnflcm/v1/vnf_instances/": "vnflcm_instances:get"
155 "POST /vnflcm/v1/vnf_instances/": "vnflcm_instances:post"
157 "GET /vnflcm/v1/vnf_instances/<vnfInstanceId>": "vnflcm_instances:id:get"
158 "DELETE /vnflcm/v1/vnf_instances/<vnfInstanceId>": "vnflcm_instances:id:delete"
160 ################################################################################
161 #################################### Tokens ####################################
162 ################################################################################
164 "GET /admin/v1/tokens": "tokens:get"
166 "POST /admin/v1/tokens": "tokens:post"
168 "DELETE /admin/v1/tokens": "tokens:delete"
170 "GET /admin/v1/tokens/<id>": "tokens:id:get"
172 "DELETE /admin/v1/tokens/<id>": "tokens:id:delete"
174 ################################################################################
175 ##################################### Users ####################################
176 ################################################################################
178 "GET /admin/v1/users": "users:get"
180 "POST /admin/v1/users": "users:post"
182 "GET /admin/v1/users/<id>": "users:id:get"
184 "DELETE /admin/v1/users/<id>": "users:id:delete"
186 "PATCH /admin/v1/users/<id>": "users:id:patch"
188 "GET /admin/v1/domains": "domains:get"
190 ################################################################################
191 #################################### Projects ##################################
192 ################################################################################
194 "GET /admin/v1/projects": "projects:get"
196 "POST /admin/v1/projects": "projects:post"
198 "GET /admin/v1/projects/<id>": "projects:id:get"
200 "PATCH /admin/v1/projects/<id>": "projects:id:patch"
202 "DELETE /admin/v1/projects/<id>": "projects:id:delete"
204 ################################################################################
205 ##################################### VIMs #####################################
206 ################################################################################
208 "GET /admin/v1/vims": "vims:get"
210 "POST /admin/v1/vims": "vims:post"
212 "GET /admin/v1/vims/<id>": "vims:id:get"
214 "DELETE /admin/v1/vims/<id>": "vims:id:delete"
216 "PATCH /admin/v1/vims/<id>": "vims:id:patch"
218 ################################################################################
219 ################################## VIM Accounts ################################
220 ################################################################################
222 "GET /admin/v1/vim_accounts": "vim_accounts:get"
224 "POST /admin/v1/vim_accounts": "vim_accounts:post"
226 "GET /admin/v1/vim_accounts/<id>": "vim_accounts:id:get"
228 "DELETE /admin/v1/vim_accounts/<id>": "vim_accounts:id:delete"
230 "PATCH /admin/v1/vim_accounts/<id>": "vim_accounts:id:patch"
232 ################################################################################
233 ################################# K8s Clusters ##############################
234 ################################################################################
236 "GET /admin/v1/k8sclusters": "k8sclusters:get"
238 "POST /admin/v1/k8sclusters": "k8sclusters:post"
240 "GET /admin/v1/k8sclusters/<id>": "k8sclusters:id:get"
242 "DELETE /admin/v1/k8sclusters/<id>": "k8sclusters:id:delete"
244 "PATCH /admin/v1/k8sclusters/<id>": "k8sclusters:id:patch"
246 ################################################################################
247 ####################################### VCAs ###################################
248 ################################################################################
250 "GET /admin/v1/vca": "vca:get"
252 "POST /admin/v1/vca": "vca:post"
254 "GET /admin/v1/vca/<id>": "vca:id:get"
256 "DELETE /admin/v1/vca/<id>": "vca:id:delete"
258 "PATCH /admin/v1/vca/<id>": "vca:id:patch"
260 ################################################################################
261 ################################# K8s Repos ##############################
262 ################################################################################
264 "GET /admin/v1/k8srepos": "k8srepos:get"
266 "POST /admin/v1/k8srepos": "k8srepos:post"
268 "GET /admin/v1/k8srepos/<id>": "k8srepos:id:get"
270 "DELETE /admin/v1/k8srepos/<id>": "k8srepos:id:delete"
272 ################################################################################
273 ################################# SDN Controllers ##############################
274 ################################################################################
276 "GET /admin/v1/sdns": "sdn_controllers:get"
278 "POST /admin/v1/sdns": "sdn_controllers:post"
280 "GET /admin/v1/sdns/<id>": "sdn_controllers:id:get"
282 "DELETE /admin/v1/sdns/<id>": "sdn_controllers:id:delete"
284 "PATCH /admin/v1/sdns/<id>": "sdn_controllers:id:patch"
286 ################################################################################
287 ################################## WIM Accounts ################################
288 ################################################################################
290 "GET /admin/v1/wim_accounts": "wim_accounts:get"
292 "POST /admin/v1/wim_accounts": "wim_accounts:post"
294 "GET /admin/v1/wim_accounts/<id>": "wim_accounts:id:get"
296 "DELETE /admin/v1/wim_accounts/<id>": "wim_accounts:id:delete"
298 "PATCH /admin/v1/wim_accounts/<id>": "wim_accounts:id:patch"
300 ################################################################################
301 ##################################### Roles ####################################
302 ################################################################################
304 "GET /admin/v1/roles": "roles:get"
306 "POST /admin/v1/roles": "roles:post"
308 "GET /admin/v1/roles/<id>": "roles:id:get"
310 "DELETE /admin/v1/roles/<id>": "roles:id:delete"
312 "PATCH /admin/v1/roles/<id>": "roles:id:patch"
314 ################################################################################
315 ##################################### PDUDs ####################################
316 ################################################################################
318 "GET /pdu/v1/pdu_descriptors": "pduds:get"
320 "POST /pdu/v1/pdu_descriptors": "pduds:post"
322 "PUT /pdu/v1/pdu_descriptors": "pduds:put"
324 "DELETE /pdu/v1/pdu_descriptors": "pduds:delete"
326 "PATCH /pdu/v1/pdu_descriptors": "pduds:patch"
328 "GET /pdu/v1/pdu_descriptors/<id>": "pduds:id:get"
330 "POST /pdu/v1/pdu_descriptors/<id>": "pduds:id:post"
332 "PUT /pdu/v1/pdu_descriptors/<id>": "pduds:id:put"
334 "DELETE /pdu/v1/pdu_descriptors/<id>": "pduds:id:delete"
336 "PATCH /pdu/v1/pdu_descriptors/<id>": "pduds:id:patch"
338 ################################################################################
339 ############################ Network Slice Templates ###########################
340 ################################################################################
342 "GET /nst/v1/netslice_templates_content": "slice_templates:get"
343 "GET /nst/v1/netslice_templates": "slice_templates:get"
345 "POST /nst/v1/netslice_templates_content": "slice_templates:content:post"
347 "GET /nst/v1/netslice_templates_content/<nstInfoId>": "slice_templates:id:get"
348 "GET /nst/v1/netslice_templates/<nstInfoId>": "slice_templates:id:get"
350 "PUT /nst/v1/netslice_templates_content/<nstInfoId>": "slice_templates:id:put"
352 "DELETE /nst/v1/netslice_templates_content/<nstInfoId>": "slice_templates:id:delete"
353 "DELETE /nst/v1/netslice_templates/<nstInfoId>": "slice_templates:id:delete"
355 "PATCH /nst/v1/netslice_templates/<nstInfoId>": "slice_templates:id:patch"
357 "GET /nst/v1/netslice_templates/<nstInfoId>/nst_content": "slice_templates:content:get"
359 "PUT /nst/v1/netslice_templates/<nstInfoId>/nst_content": "slice_templates:content:put"
361 "GET /nst/v1/netslice_templates/<nstInfoId>/nst": "slice_templates:id:nst:get"
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"
366 ################################################################################
367 ############################ Network Slice Instances ###########################
368 ################################################################################
370 "GET /nsilcm/v1/netslice_instances_content": "slice_instances:get"
371 "GET /nsilcm/v1/netslice_instances": "slice_instances:get"
373 "POST /nsilcm/v1/netslice_instances_content": "slice_instances:content:post"
375 "GET /nsilcm/v1/netslice_instances_content/<SliceInstanceId>": "slice_instances:id:get"
376 "GET /nsilcm/v1/netslice_instances/<SliceInstanceId>": "slice_instances:id:get"
378 "DELETE /nsilcm/v1/netslice_instances_content/<SliceInstanceId>": "slice_instances:id:delete"
379 "DELETE /nsilcm/v1/netslice_instances/<SliceInstanceId>": "slice_instances:id:delete"
381 "POST /nsilcm/v1/netslice_instances": "slice_instances:post"
383 "POST /nsilcm/v1/netslice_instances/<SliceInstanceId>/instantiate": "slice_instances:id:instantiate:post"
385 "POST /nsilcm/v1/netslice_instances/<SliceInstanceId>/terminate": "slice_instances:id:terminate:post"
387 "POST /nsilcm/v1/netslice_instances/<SliceInstanceId>/action": "slice_instances:id:action:post"
389 "GET /nsilcm/v1/nsi_lcm_op_occs": "slice_instances:opps:get"
391 "GET /nsilcm/v1/nsi_lcm_op_occs/<nsiLcmOpOccId>": "slice_instances:opps:id:get"
393 ################################################################################
394 ############################ QUERY STRING admin operations #####################
395 ################################################################################
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"
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"
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"
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"