3 title: 'External Server for A1 simulator'
7 © 2022, O-RAN Alliance.
10 name: Copyright (C) 2022 Nordix Foundation. Licensed under the Apache License.
11 url: http://www.apache.org/licenses/LICENSE-2.0
13 description: 'An external server building CRUD RestFUL APIs which is provisioned by A1 simulator. It will be a refrence point for the callouts'
14 url: 'https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/latest/EXT_SRV_api.html'
19 default: 'http://www.example.com'
23 operationId: server.get_all_a1_policies
24 description: 'Get all a1 policies'
29 description: 'Array of all a1 policies'
35 "$ref": "#/components/schemas/A1PolicyObject"
38 "$ref": "#/components/responses/429-TooManyRequests"
40 "$ref": "#/components/responses/503-ServiceUnavailable"
41 '/a1policy/{a1policyId}':
47 "$ref": "#/components/schemas/A1PolicyId"
49 operationId: server.get_a1_policy
50 description: 'Query for an A1 policy'
52 - Single A1 Policy Object
55 description: 'The requested A1 policy object'
59 "$ref": "#/components/schemas/A1PolicyObject"
61 "$ref": "#/components/responses/404-NotFound"
63 "$ref": "#/components/responses/409-Conflict"
65 "$ref": "#/components/responses/429-TooManyRequests"
67 "$ref": "#/components/responses/503-ServiceUnavailable"
69 operationId: server.put_a1_policy
70 description: 'Create an A1 policy'
72 - Individual A1 policy Object
78 "$ref": "#/components/schemas/A1PolicyObject"
81 description: 'The A1 policy was updated'
85 "$ref": "#/components/schemas/A1PolicyObject"
87 description: 'The A1 policy was created'
91 "$ref": "#/components/schemas/A1PolicyObject"
94 description: 'Contains the URI of the created A1 policy'
99 "$ref": "#/components/responses/400-BadRequest"
101 "$ref": "#/components/responses/409-Conflict"
103 "$ref": "#/components/responses/429-TooManyRequests"
105 "$ref": "#/components/responses/503-ServiceUnavailable"
107 "$ref": "#/components/responses/507-InsufficientStorage"
110 operationId: server.delete_a1_policy
111 description: 'Delete an A1 policy'
113 - Individual a1policy Object
116 description: 'The A1 policy was deleted'
118 "$ref": "#/components/responses/404-NotFound"
120 "$ref": "#/components/responses/429-TooManyRequests"
122 "$ref": "#/components/responses/503-ServiceUnavailable"
127 # Representation objects
131 description: 'A generic A1 policy object'
135 description: 'A problem detail to carry details in a HTTP response according to RFC 7807'
153 description: 'A JSON schema following http://json-schema.org/draft-07/schema'
157 description: 'A1 policy identifier.'
162 description: 'A1 policy not properly formulated or not related to the method'
164 application/problem+json:
166 "$ref": "#/components/schemas/ProblemDetails"
169 description: 'No resource found at the URI'
171 application/problem+json:
173 "$ref": "#/components/schemas/ProblemDetails"
175 405-MethodNotAllowed:
176 description: 'Method not allowed for the URI'
178 application/problem+json:
180 "$ref": "#/components/schemas/ProblemDetails"
183 description: 'Request could not be processed in the current state of the resource'
185 application/problem+json:
187 "$ref": "#/components/schemas/ProblemDetails"
190 description: 'Too many requests have been sent in a given amount of time'
192 application/problem+json:
194 "$ref": "#/components/schemas/ProblemDetails"
196 503-ServiceUnavailable:
197 description: 'The provider is currently unable to handle the request due to a temporary overload'
199 application/problem+json:
201 "$ref": "#/components/schemas/ProblemDetails"
203 507-InsufficientStorage:
204 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'
206 application/problem+json:
208 "$ref": "#/components/schemas/ProblemDetails"