-
Notifications
You must be signed in to change notification settings - Fork 263
/
Copy pathTS29549_SS_ADAE_ServiceApiAnalytics.yaml
251 lines (242 loc) · 8.72 KB
/
TS29549_SS_ADAE_ServiceApiAnalytics.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
openapi: 3.0.0
info:
title: SS_ADAE_ServiceApiAnalytics
description: |
API for ADAE service API analytics service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.0.0-alpha.1"
externalDocs:
description: >
3GPP TS 29.549 V18.5.0 Service Enabler Architecture Layer for Verticals (SEAL);
Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
security:
- {}
- oAuth2ClientCredentials: []
servers:
- url: '{apiRoot}/ss-adae-sspa/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549
paths:
/service-api:
post:
description: >
Creates a new individual service API event subscription.
operationId: SrvApiSubs
tags:
- Service API event subscriptions (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SrvApiSub'
callbacks:
saaNotification:
'{$request.body#/notifUri}':
post:
requestBody: # contents of the callback message
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SrvApiNotif'
responses:
'204':
description: No Content (successful notification)
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
responses:
'201':
description: Service API event subscription resource created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/SrvApiSub'
headers:
Location:
description: Contains the URI of the newly created resource.
required: true
schema:
type: string
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/service-api/{srvApiId}:
get:
description: Retrieves an individual service API event subscription.
operationId: ReadIndSrvApiEventSubsc
tags:
- Individual service API event subscription (Document)
parameters:
- name: srvApiId
in: path
description: >
Identifier of an individual service API event subscription.
required: true
schema:
type: string
responses:
'200':
description: >
The individual service API event subscription matching the srvApiId is retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/SrvApiSub'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
description: Deletes an individual service API event subscription.
operationId: DeleteIndSrvApiEventSubsc
tags:
- Individual service API event subscription (Document)
parameters:
- name: srvApiId
in: path
description: >
Identifier of an individual service API event subscription.
required: true
schema:
type: string
responses:
'204':
description: >
The individual service API subscription matching the srvApiId is deleted.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
SrvApiSub:
description: Represents an individual service API event subscription.
type: object
properties:
notifUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
serviceApiName:
type: string
description: Service API name.
serviceApiType:
type: string
description: Service API type.
area:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
timeValidity:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
timeHorizon:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- notifUri
oneOf:
- required: [serviceApiName]
- required: [serviceApiType]
SrvApiNotif:
description: Represents notification of the service API event.
type: object
properties:
requestorId:
type: string
description: Identifier of the requestor of the analytics.
output:
type: string
description: Output for analytics.
area:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
confLevel:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
required:
- requestorId
- output