1 # ==================================================================================
2 # Copyright (c) 2019 Nokia
3 # Copyright (c) 2018-2019 AT&T Intellectual Property.
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16 # ==================================================================================
22 '/A1-ADAPTER-API:getNearRT-RICs':
25 Get a list of all nearRT-RICs
28 operationId: a1.controller.get_all_nearrt_rics
32 Successfully got the list of all nearRT-RICs.
36 "$ref": "#/components/schemas/output_NRRids_list_schema"
38 '/A1-ADAPTER-API:getHealthCheck':
41 Get health status for a Near-RT-RIC. true - health ok, false - health is not ok.
44 operationId: a1.controller.get_healthcheck
50 "$ref": "#/components/schemas/input_NRRid_schema"
54 Successfully got the health status.
58 "$ref": "#/components/schemas/output_healthstatus_schema"
60 '/A1-ADAPTER-API:getPolicyTypes':
63 Get a list of all registered policy-type-ids.
66 operationId: a1.controller.get_all_policy_types
72 "$ref": "#/components/schemas/input_NRRid_schema"
76 Successfully got the list of all policy-type-ids.
80 "$ref": "#/components/schemas/output_PTids_list_schema"
82 '/A1-ADAPTER-API:createPolicyType':
88 operationId: a1.controller.create_policy_type
94 "$ref": "#/components/schemas/input_NRRid_PTid_desc_name_PT_schema"
98 Successfully created the policy type.
102 "$ref": "#/components/schemas/output_status_code_schema"
105 illegal policy_type_id, or this policy type already exists
107 '/A1-ADAPTER-API:getPolicyType':
113 operationId: a1.controller.get_policy_type
119 "$ref": "#/components/schemas/input_NRRid_PTid_schema"
123 Successfully got the policy type.
127 "$ref": "#/components/schemas/output_desc_name_PT_schema"
130 there is no policy type with this policy_type_id
132 '/A1-ADAPTER-API:deletePolicyType':
135 Delete a policy type.
138 operationId: a1.controller.delete_policy_type
144 "$ref": "#/components/schemas/input_NRRid_PTid_schema"
148 Successfully deleted the policy type.
151 Policy type cannot be deleted because there are instances. All instances must be removed before a policy type can be deleted.
154 there is no policy type with this policy_type_id
156 '/A1-ADAPTER-API:getPolicyInstances':
159 Get a list of all policy-instance-ids for this policy-type-id.
162 operationId: a1.controller.get_all_instances_for_type
168 "$ref": "#/components/schemas/input_NRRid_PTid_schema"
172 Successfully got the list of all policy-instance-ids for this policy-type-id.
176 "$ref": "#/components/schemas/output_PIids_list_schema"
179 there is no policy type with this policy_type_id
181 '/A1-ADAPTER-API:createPolicyInstance':
184 Create a policy instance.
187 operationId: a1.controller.create_policy_instance
193 "$ref": "#/components/schemas/input_NRRid_PTid_PIid_PI_schema"
197 Successfully created the policy instance.
200 Bad input data for this policy instance.
203 there is no policy type with this policy_type_id
205 '/A1-ADAPTER-API:getPolicyInstance':
208 Get a policy instance.
211 operationId: a1.controller.get_policy_instance
217 "$ref": "#/components/schemas/input_NRRid_PTid_PIid_schema"
221 Successfully got the policy instance.
225 "$ref": "#/components/schemas/output_PI_schema"
228 there is no policy instance with this policy_instance_id or there is no policy type with this policy_type_id
230 '/A1-ADAPTER-API:deletePolicyInstance':
233 Delete a policy instance.
236 operationId: a1.controller.delete_policy_instance
242 "$ref": "#/components/schemas/input_NRRid_PTid_PIid_schema"
246 Successfully deleted the policy instance.
249 there is no policy instance with this policy_instance_id or there is no policy type with this policy_type_id
251 '/A1-ADAPTER-API:getStatus':
254 Get the status for a policy instance.
257 operationId: a1.controller.get_policy_instance_status
263 "$ref": "#/components/schemas/input_NRRid_PTid_PIid_schema"
267 Successfully got the policy instance status.
271 "$ref": "#/components/schemas/output_status_schema"
274 there is no policy instance with this policy_instance_id or there is no policy type with this policy_type_id
282 additionalProperties: false
288 additionalProperties: false
291 "$ref": "#/components/schemas/near_rt_ric_id"
293 input_NRRid_PTid_schema:
297 additionalProperties: false
304 additionalProperties: false
307 "$ref": "#/components/schemas/near_rt_ric_id"
309 "$ref": "#/components/schemas/policy_type_id"
311 input_NRRid_PTid_PIid_schema:
315 additionalProperties: false
323 additionalProperties: false
326 "$ref": "#/components/schemas/near_rt_ric_id"
328 "$ref": "#/components/schemas/policy_type_id"
330 "$ref": "#/components/schemas/policy_instance_id"
332 input_NRRid_PTid_PIid_PI_schema:
336 additionalProperties: false
345 additionalProperties: false
348 "$ref": "#/components/schemas/near_rt_ric_id"
350 "$ref": "#/components/schemas/policy_type_id"
352 "$ref": "#/components/schemas/policy_instance_id"
354 "$ref": "#/components/schemas/policy_instance"
356 input_NRRid_PTid_desc_name_PT_schema:
360 additionalProperties: false
370 additionalProperties: false
373 "$ref": "#/components/schemas/near_rt_ric_id"
375 "$ref": "#/components/schemas/policy_type_id"
381 "$ref": "#/components/schemas/policy_type"
383 output_NRRids_list_schema:
387 additionalProperties: false
392 - near-rt-ric-id-list
393 additionalProperties: false
398 "$ref": "#/components/schemas/near_rt_ric_id"
400 output_healthstatus_schema:
404 additionalProperties: false
410 additionalProperties: false
415 output_desc_name_PT_schema:
419 additionalProperties: false
427 additionalProperties: false
434 "$ref": "#/components/schemas/policy_type"
436 output_PTids_list_schema:
440 additionalProperties: false
445 - policy-type-id-list
446 additionalProperties: false
451 "$ref": "#/components/schemas/policy_type_id"
453 output_PIids_list_schema:
457 additionalProperties: false
462 - policy-instance-id-list
463 additionalProperties: false
465 policy-instance-id-list:
468 "$ref": "#/components/schemas/policy_instance_id"
474 additionalProperties: false
480 additionalProperties: false
483 "$ref": "#/components/schemas/policy_instance"
485 output_status_schema:
489 additionalProperties: false
495 additionalProperties: false
500 output_status_code_schema:
504 additionalProperties: false
511 additionalProperties: false
520 represents a near RT RIC identifier. Currently this can be any string.
522 example: near-rt-ric-1
526 represents a policy type identifier. Currently this is restricted to an integer range.
534 represents a policy instance identifier. UUIDs are advisable but can be any string
536 example: 3d2157af-6a8f-4a7c-810f-38c2f824bf12
540 represents a policy type. String is used for now to represent this
547 represents a policy instance. String is used for now to represent this
550 "{slice_id: slice-1, priority_level: high}"