1 # ==================================================================================
2 # Copyright (c) 2019 Nordix Foundation.
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
15 # ==================================================================================
21 '/A1-ADAPTER-API:getNearRT-RICs':
24 Get a list of all nearRT-RICs
27 operationId: a1.controller.get_all_nearrt_rics
31 Successfully got the response.
35 "$ref": "#/components/schemas/output_NRRids_list_code_schema"
37 '/A1-ADAPTER-API:getHealthCheck':
40 Get health status for a Near-RT-RIC. true - health ok, false - health is not ok.
43 operationId: a1.controller.get_healthcheck
49 "$ref": "#/components/schemas/input_NRRid_schema"
53 Successfully got the response.
57 "$ref": "#/components/schemas/output_healthstatus_code_schema"
59 '/A1-ADAPTER-API:getPolicyTypes':
62 Get a list of all registered policy-type-ids.
65 operationId: a1.controller.get_all_policy_types
71 "$ref": "#/components/schemas/input_NRRid_schema"
75 Successfully got the response.
79 "$ref": "#/components/schemas/output_PTids_list_code_schema"
81 '/A1-ADAPTER-API:createPolicyType':
87 operationId: a1.controller.create_policy_type
93 "$ref": "#/components/schemas/input_NRRid_PTid_desc_name_PT_schema"
97 Successfully got the response.
101 "$ref": "#/components/schemas/output_code_schema"
103 '/A1-ADAPTER-API:getPolicyType':
109 operationId: a1.controller.get_policy_type
115 "$ref": "#/components/schemas/input_NRRid_PTid_schema"
119 Successfully got the response.
123 "$ref": "#/components/schemas/output_desc_name_PT_code_schema"
125 '/A1-ADAPTER-API:deletePolicyType':
128 Delete a policy type.
131 operationId: a1.controller.delete_policy_type
137 "$ref": "#/components/schemas/input_NRRid_PTid_schema"
141 Successfully got the response.
145 "$ref": "#/components/schemas/output_code_schema"
147 '/A1-ADAPTER-API:getPolicyInstances':
150 Get a list of all policy-instance-ids for this policy-type-id.
153 operationId: a1.controller.get_all_instances_for_type
159 "$ref": "#/components/schemas/input_NRRid_PTid_schema"
163 Successfully got the response.
167 "$ref": "#/components/schemas/output_PIids_list_code_schema"
169 '/A1-ADAPTER-API:createPolicyInstance':
172 Create a policy instance.
175 operationId: a1.controller.create_policy_instance
181 "$ref": "#/components/schemas/input_NRRid_PTid_PIid_PI_schema"
185 Successfully got the response.
189 "$ref": "#/components/schemas/output_code_schema"
191 '/A1-ADAPTER-API:getPolicyInstance':
194 Get a policy instance.
197 operationId: a1.controller.get_policy_instance
203 "$ref": "#/components/schemas/input_NRRid_PTid_PIid_schema"
207 Successfully got the response.
211 "$ref": "#/components/schemas/output_PI_code_schema"
213 '/A1-ADAPTER-API:deletePolicyInstance':
216 Delete a policy instance.
219 operationId: a1.controller.delete_policy_instance
225 "$ref": "#/components/schemas/input_NRRid_PTid_PIid_schema"
229 Successfully got the response.
233 "$ref": "#/components/schemas/output_code_schema"
235 '/A1-ADAPTER-API:getStatus':
238 Get the status for a policy instance.
241 operationId: a1.controller.get_policy_instance_status
247 "$ref": "#/components/schemas/input_NRRid_PTid_PIid_schema"
251 Successfully got the response.
255 "$ref": "#/components/schemas/output_status_code_schema"
263 additionalProperties: false
269 additionalProperties: false
272 "$ref": "#/components/schemas/near_rt_ric_id"
274 input_NRRid_PTid_schema:
278 additionalProperties: false
285 additionalProperties: false
288 "$ref": "#/components/schemas/near_rt_ric_id"
290 "$ref": "#/components/schemas/policy_type_id"
292 input_NRRid_PTid_PIid_schema:
296 additionalProperties: false
304 additionalProperties: false
307 "$ref": "#/components/schemas/near_rt_ric_id"
309 "$ref": "#/components/schemas/policy_type_id"
311 "$ref": "#/components/schemas/policy_instance_id"
313 input_NRRid_PTid_PIid_PI_schema:
317 additionalProperties: false
326 additionalProperties: false
329 "$ref": "#/components/schemas/near_rt_ric_id"
331 "$ref": "#/components/schemas/policy_type_id"
333 "$ref": "#/components/schemas/policy_instance_id"
335 "$ref": "#/components/schemas/policy_instance"
337 input_NRRid_PTid_desc_name_PT_schema:
341 additionalProperties: false
351 additionalProperties: false
354 "$ref": "#/components/schemas/near_rt_ric_id"
356 "$ref": "#/components/schemas/policy_type_id"
362 "$ref": "#/components/schemas/policy_type"
364 output_NRRids_list_code_schema:
368 additionalProperties: false
373 - near-rt-ric-id-list
375 additionalProperties: false
380 "$ref": "#/components/schemas/near_rt_ric_id"
384 output_healthstatus_code_schema:
388 additionalProperties: false
395 additionalProperties: false
402 output_desc_name_PT_code_schema:
406 additionalProperties: false
415 additionalProperties: false
422 "$ref": "#/components/schemas/policy_type"
426 output_PTids_list_code_schema:
430 additionalProperties: false
435 - policy-type-id-list
437 additionalProperties: false
442 "$ref": "#/components/schemas/policy_type_id"
446 output_PIids_list_code_schema:
450 additionalProperties: false
455 - policy-instance-id-list
457 additionalProperties: false
459 policy-instance-id-list:
462 "$ref": "#/components/schemas/policy_instance_id"
466 output_PI_code_schema:
470 additionalProperties: false
477 additionalProperties: false
480 "$ref": "#/components/schemas/policy_instance"
488 additionalProperties: false
494 additionalProperties: false
499 output_status_code_schema:
503 additionalProperties: false
510 additionalProperties: false
519 represents a near RT RIC identifier. Currently this can be any string.
521 example: near-rt-ric-1
525 represents a policy type identifier. Currently this is an integer.
531 represents a policy instance identifier. UUIDs are advisable but can be any string
533 example: 3d2157af-6a8f-4a7c-810f-38c2f824bf12
537 represents a policy type. String is used for now to represent this
544 represents a policy instance. String is used for now to represent this
547 "{slice_id: slice-1, priority_level: high}"