3 title: 'External Server for A1 simulator'
7 © 2022, O-RAN Alliance.
10 description: 'An external server building CRUD RestFUL APIs which is provisioned by A1 simulator. It will be a refrence point for the callouts'
11 url: 'https://www.testserver/specifications'
16 default: 'https://testserver.com'
20 operationId: server.get_all_a1_policies
21 description: 'Get all a1 policies'
26 description: 'Array of all a1 policies'
32 "$ref": "#/components/schemas/A1PolicyObject"
35 "$ref": "#/components/responses/429-TooManyRequests"
37 "$ref": "#/components/responses/503-ServiceUnavailable"
38 '/a1policy/{a1policyId}':
44 "$ref": "#/components/schemas/A1PolicyId"
46 operationId: server.get_a1_policy
47 description: 'Query for an A1 policy'
49 - Single A1 Policy Object
52 description: 'The requested A1 policy object'
56 "$ref": "#/components/schemas/A1PolicyObject"
58 "$ref": "#/components/responses/404-NotFound"
60 "$ref": "#/components/responses/409-Conflict"
62 "$ref": "#/components/responses/429-TooManyRequests"
64 "$ref": "#/components/responses/503-ServiceUnavailable"
66 operationId: server.put_a1_policy
67 description: 'Create an A1 policy'
69 - Individual A1 policy Object
75 "$ref": "#/components/schemas/A1PolicyObject"
78 description: 'The A1 policy was updated'
82 "$ref": "#/components/schemas/A1PolicyObject"
84 description: 'The A1 policy was created'
88 "$ref": "#/components/schemas/A1PolicyObject"
91 description: 'Contains the URI of the created A1 policy'
96 "$ref": "#/components/responses/400-BadRequest"
98 "$ref": "#/components/responses/409-Conflict"
100 "$ref": "#/components/responses/429-TooManyRequests"
102 "$ref": "#/components/responses/503-ServiceUnavailable"
104 "$ref": "#/components/responses/507-InsufficientStorage"
107 operationId: server.delete_a1_policy
108 description: 'Delete an A1 policy'
110 - Individual a1policy Object
113 description: 'The A1 policy was deleted'
115 "$ref": "#/components/responses/404-NotFound"
117 "$ref": "#/components/responses/429-TooManyRequests"
119 "$ref": "#/components/responses/503-ServiceUnavailable"
124 # Representation objects
128 description: 'A generic A1 policy object'
132 description: 'A problem detail to carry details in a HTTP response according to RFC 7807'
150 description: 'A JSON schema following http://json-schema.org/draft-07/schema'
154 description: 'A1 policy identifier.'
159 description: 'A1 policy not properly formulated or not related to the method'
161 application/problem+json:
163 "$ref": "#/components/schemas/ProblemDetails"
166 description: 'No resource found at the URI'
168 application/problem+json:
170 "$ref": "#/components/schemas/ProblemDetails"
172 405-MethodNotAllowed:
173 description: 'Method not allowed for the URI'
175 application/problem+json:
177 "$ref": "#/components/schemas/ProblemDetails"
180 description: 'Request could not be processed in the current state of the resource'
182 application/problem+json:
184 "$ref": "#/components/schemas/ProblemDetails"
187 description: 'Too many requests have been sent in a given amount of time'
189 application/problem+json:
191 "$ref": "#/components/schemas/ProblemDetails"
193 503-ServiceUnavailable:
194 description: 'The provider is currently unable to handle the request due to a temporary overload'
196 application/problem+json:
198 "$ref": "#/components/schemas/ProblemDetails"
200 507-InsufficientStorage:
201 description: 'The method could not be performed on the resource because the provider is unable to store the representation needed to successfully complete the request'
203 application/problem+json:
205 "$ref": "#/components/schemas/ProblemDetails"