9 Perform a healthcheck on a1
12 operationId: a1.controller.get_healthcheck
16 A1 is healthy. Anything other than a 200 should be considered a1 as
21 description: Get a list of all registered policy type ids
24 operationId: a1.controller.get_all_policy_types
27 description: list of all registered policy type ids
35 $ref: '#/definitions/policy_type_id'
38 Potentially transient backend database error. Client should attempt
43 '/a1-p/policytypes/{policy_type_id}':
45 - name: policy_type_id
52 represents a policy type identifier. Currently this is restricted to
59 operationId: a1.controller.get_policy_type
62 description: policy type successfully found
64 $ref: '#/definitions/policy_type_schema'
70 Potentially transient backend database error. Client should attempt
77 Delete this policy type. Can only be performed if there are no instances
81 operationId: a1.controller.delete_policy_type
85 policy type successfully deleted
88 Policy type cannot be deleted because there are instances All
89 instances must be removed before a policy type can be deleted
95 Potentially transient backend database error. Client should attempt
100 Create a new policy type . Replace is not currently allowed; to replace,
101 for now do a DELETE and then a PUT again.
104 operationId: a1.controller.create_policy_type
107 description: policy type successfully created
109 description: 'illegal ID, or object already existed'
112 Potentially transient backend database error. Client should attempt
118 $ref: '#/definitions/policy_type_schema'
121 '/a1-p/policytypes/{policy_type_id}/policies':
123 - name: policy_type_id
130 represents a policy type identifier. Currently this is restricted to
133 description: get a list of all policy instance ids for this policy type id
136 operationId: a1.controller.get_all_instances_for_type
139 description: list of all policy instance ids for this policy type id
142 - 3d2157af-6a8f-4a7c-810f-38c2f824bf12
143 - 06911bfc-c127-444a-8eb1-1bffad27cc3d
147 $ref: '#/definitions/policy_instance_id'
150 Potentially transient backend database error. Client should attempt
155 '/a1-p/policytypes/{policy_type_id}/policies/{policy_instance_id}':
157 - name: policy_type_id
164 represents a policy type identifier. Currently this is restricted to
166 - name: policy_instance_id
171 represents a policy instance identifier. UUIDs are advisable but can
175 Retrieve the policy instance
178 operationId: a1.controller.get_policy_instance
182 The policy instance. the schema of this object is defined by the
183 create_schema field of the policy type
188 there is no policy instance with this policy_instance_id or there is
189 no policy type with this policy_type_id
192 Potentially transient backend database error. Client should attempt
199 Delete this policy instance
202 operationId: a1.controller.delete_policy_instance
206 policy instance deletion initiated
209 there is no policy instance with this policy_instance_id or there is
210 no policy type with this policy_type_id
213 Potentially transient backend database error. Client should attempt
218 Create or replace a policy instance of type policy_type_id. The schema
219 of the PUT body is defined by the create_schema field of the policy
223 operationId: a1.controller.create_or_replace_policy_instance
227 Policy instance creation initiated
230 Bad PUT body for this policy instance
233 There is no policy type with this policy_type_id
236 Potentially transient backend database error. Client should attempt
244 the schema of this object is defined by the create_schema field of
248 '/a1-p/policytypes/{policy_type_id}/policies/{policy_instance_id}/status':
250 - name: policy_type_id
257 represents a policy type identifier. Currently this is restricted to
259 - name: policy_instance_id
264 represents a policy instance identifier. UUIDs are advisable but can
268 Retrieve the policy instance status across all handlers of the policy If
269 this endpoint returns successfully (200), it is either IN EFFECT or NOT
270 IN EFFECT. IN EFFECT is returned if at least one policy handler in the
271 RIC is implementing the policy NOT IN EFFECT is returned otherwise If a
272 policy instance is successfully deleted, this endpoint will return a 404
276 operationId: a1.controller.get_policy_instance_status
280 successfully retrieved the status
296 there is no policy instance with this policy_instance_id or there is
297 no policy type with this policy_type_id
300 Potentially transient backend database error. Client should attempt
308 Deliver data produced by data producer.
310 - A1 EI Data Delivery
311 operationId: a1.controller.data_delivery
315 successfully delivered data from data producer
318 no job id defined for this data delivery
325 object to represent data object
336 additionalProperties: false
340 description: name of the policy type
343 description: description of the policy type
345 description: the integer of the policy type
350 jsonschema (following http://json-schema.org/draft-07/schema) of the
351 CREATE payload to be sent to handlers of this policy
354 represents a policy type identifier. Currently this is restricted to an
361 represents a policy instance identifier. UUIDs are advisable but can be
364 example: 3d2157af-6a8f-4a7c-810f-38c2f824bf12