-
Notifications
You must be signed in to change notification settings - Fork 263
/
Copy pathTS29558_Eees_UELocation.yaml
556 lines (544 loc) · 20.5 KB
/
TS29558_Eees_UELocation.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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
openapi: 3.0.0
info:
title: EES UE Location Information_API
description: |
API for EES UE Location Information.
© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: 1.1.0-alpha.2
externalDocs:
description: >
3GPP TS 29.558 V18.1.0 Enabling Edge Applications;
Application Programming Interface (API) specification; Stage 3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/
security:
- {}
- oAuth2ClientCredentials: []
servers:
- url: '{apiRoot}/eees-uelocation/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558.
paths:
/fetch:
post:
summary: Fetch an UE location information.
operationId: FetchUELocation
tags:
- Fetch an UE location information
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LocationRequest'
responses:
'200':
description: OK (The requested location information)
content:
application/json:
schema:
$ref: '#/components/schemas/LocationResponse'
'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'
/subscriptions:
post:
summary: Creates a new Individual Location Information Subscription resource
operationId: CreateLocationInfoSubscription
tags:
- Location Information Subscriptions (Collection)
description: >
Create a Subscription resource for continious reporting of UE location
information to the EAS.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LocationSubscription'
responses:
'201':
description: >
Created (The individual location information subscription resource
is created successfully)
content:
application/json:
schema:
$ref: '#/components/schemas/LocationSubscription'
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'
callbacks:
LocationInformationNotification:
'{request.body#/notificationDestination}':
post:
requestBody: # contents of the callback message
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LocationNotification'
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'
UserConsentRevocationNotif:
'{request.body#/revocationNotifUri}':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConsentRevocNotif'
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'
/subscriptions/{subscriptionId}:
get:
summary: Read an Individual Location Information Subscription resource
operationId: ReadIndLocationInfoSubscription
tags:
- Individual Location Information Subscription (Document)
description: Retrieve an Individual location information subscription information.
parameters:
- name: subscriptionId
in: path
description: Subscription Id.
required: true
schema:
type: string
responses:
'200':
description: OK (Successfully get the location information subscription).
content:
application/json:
schema:
$ref: '#/components/schemas/LocationSubscription'
'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'
put:
summary: Update an Individual Location Information Subscription resource
operationId: UpdateIndLocationInfoSubscription
tags:
- Individual Location Information Subscription (Document)
description: Fully replace an existing Individual location information Subscription.
parameters:
- name: subscriptionId
in: path
description: Subscription Id.
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LocationSubscription'
responses:
'200':
description: OK (The individual location information subscription was modified successfully).
content:
application/json:
schema:
$ref: '#/components/schemas/LocationSubscription'
'204':
description: No Content.
'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'
patch:
summary: Modify an Individual Location Information Subscription resource
operationId: ModifyIndLocationInfoSubscription
tags:
- Individual Location Information Subscription (Document)
description: Partially update an existing Individual location information Subscription.
parameters:
- name: subscriptionId
in: path
description: Subscription Id.
required: true
schema:
type: string
requestBody:
description: Partial update an existing Individual AC information Subscription.
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/LocationSubscriptionPatch'
responses:
'200':
description: >
OK (The Individual location information Subscription is successfully
modified and the updated subscription information is returned in the response).
content:
application/json:
schema:
$ref: '#/components/schemas/LocationSubscription'
'204':
description: >
No Content (The individual location information subscription was modified successfully).
'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'
delete:
summary: Delete an Individual Location Information Subscription resource
operationId: DeleteIndLocationInfoSubscription
tags:
- Individual Location Information Subscription (Document)
description: Delete an existing Individual location information Subscription.
parameters:
- name: subscriptionId
in: path
description: Subscription Id.
required: true
schema:
type: string
responses:
'204':
description: The individual subscription 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
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
LocationSubscription:
type: object
description: Represents an Individual Location Information Subscription.
properties:
easId:
type: string
description: Identifier of the EAS subscribing for location information report.
ueId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
intGrpId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId'
extGrpId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId'
expTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
locGran:
$ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/Accuracy'
locQos:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocationQoS'
eventReq:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
notificationDestination:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
requestTestNotification:
type: boolean
description: >
Set to true by the EAS to request the EES to send a test notification.
Set to false or omitted otherwise.
revocationNotifUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
websockNotifConfig:
$ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
oneOf:
- required: [ueId]
- required: [intGrpId]
- required: [extGrpId]
required:
- easId
LocationSubscriptionPatch:
type: object
description: Represents the partial update of Individual AC Information Subscription.
properties:
eventReq:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
expTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
notificationDestination:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
revocationNotifUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
locGran:
$ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/Accuracy'
locQos:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocationQoS'
LocationNotification:
type: object
description: Represents the filters information for AC Information Subscription.
properties:
subId:
type: string
description: >
Identifier of the location information subscription for which the
location information notification is related to.
locEvs:
type: array
items:
$ref: '#/components/schemas/LocationEvent'
minItems: 1
description: List of notifications with location information.
required:
- subId
- locEvs
LocationEvent:
type: object
description: Location Information event notification.
properties:
ueId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
locInf:
$ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo'
locInfPred:
$ref: 'TS29522_AnalyticsExposure.yaml#/components/schemas/UeMobilityExposure'
oneOf:
- required: [locInf]
- required: [locInPred]
required:
- ueId
LocationRequest:
type: object
description: To request location information request.
properties:
ueId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
gran:
$ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/Accuracy'
locQos:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocationQoS'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- ueId
LocationResponse:
type: object
description: Contains the response location information request.
properties:
ueLocation:
$ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- ueLocation
ConsentRevocNotif:
description: >
Represents the user consent revocation information conveyed in a user consent
revocation notification.
type: object
properties:
subscriptionId:
type: string
description: >
Contains the identifier of the subscription to which the notification is related.
consentsRevoked:
type: array
items:
$ref: '#/components/schemas/ConsentRevoked'
minItems: 1
required:
- subscriptionId
- consentsRevoked
ConsentRevoked:
description: Represents the information related to a revoked user consent.
type: object
properties:
ucPurpose:
$ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/UcPurpose'
externalId:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId'
ueId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
required:
- ucPurpose
oneOf:
- required: [externalId]
- required: [ueId]