-
Notifications
You must be signed in to change notification settings - Fork 249
/
TS28623_ComDefs.yaml
411 lines (398 loc) · 10.5 KB
/
TS28623_ComDefs.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
openapi: 3.0.1
info:
title: Common Type Definitions
version: 18.6.0
description: >-
OAS 3.0.1 specification of common type definitions in the Generic NRM
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 28.623; Generic NRM; Common type definitions
url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/
paths: {}
components:
schemas:
Float:
type: number
format: float
DateTime:
type: string
format: date-time
FullTime:
type: string
description: format (e.g., full-time) is from RFC 3339
format: full-time
DateMonth:
type: string
format: date-month
DateMonthDay:
type: string
format: date-mday
DayInYear:
type: object
properties:
month:
$ref: '#/components/schemas/DateMonth'
monthDay:
$ref: '#/components/schemas/DateMonthDay'
Latitude:
type: number
format: float
minimum: -90
maximum: 90
Longitude:
type: number
format: float
minimum: -180
maximum: 180
Dn:
type: string
DnList:
type: array
items:
$ref: '#/components/schemas/Dn'
Mcc:
type: string
pattern: '^[0-9]{3}$'
Mnc:
type: string
pattern: '^[0-9]{2,3}$'
Nid:
type: string
pattern: '^[A-Fa-f0-9]{11}$'
PlmnId:
type: object
properties:
mcc:
$ref: '#/components/schemas/Mcc'
mnc:
$ref: '#/components/schemas/Mnc'
Tac:
type: string
pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)'
UtraCellId:
type: integer
EutraCellId:
type: string
pattern: '^[A-Fa-f0-9]{7}$'
NrCellId:
type: string
pattern: '^[A-Fa-f0-9]{9}$'
TimeWindow:
oneOf:
- type: object
properties:
startTime:
$ref: '#/components/schemas/DateTime'
endTime:
$ref: '#/components/schemas/DateTime'
- type: object
properties:
startTime:
$ref: '#/components/schemas/DateTime'
- type: object
properties:
endTime:
$ref: '#/components/schemas/DateTime'
GeoCoordinate:
type: object
properties:
latitude:
$ref: '#/components/schemas/Latitude'
longitude:
$ref: '#/components/schemas/Longitude'
altitude:
$ref: '#/components/schemas/Float'
ConvexGeoPolygon:
type: array
items:
$ref: '#/components/schemas/GeoCoordinate'
minItems: 3
GeoArea:
type: object
properties:
convexGeoPolygon:
$ref: '#/components/schemas/ConvexGeoPolygon'
GeoAreaToCellMapping:
type: object
properties:
geoArea:
$ref: '#/components/schemas/GeoArea'
associationThreshold:
type: integer
AreaOfInterest:
oneOf:
- $ref: '#/components/schemas/GeoAreaToCellMapping'
- type: array
items:
$ref: 'TS28623_GenericNrm.yaml#/components/schemas/Tai'
- type: array
items:
$ref: '#/components/schemas/NrCellId'
- type: array
items:
$ref: '#/components/schemas/EutraCellId'
- type: array
items:
$ref: '#/components/schemas/UtraCellId'
Fqdn:
type: string
Ipv4Addr:
type: string
pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$'
example: '198.51.100.1'
Ipv6Addr:
type: string
allOf:
- pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$'
- pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$'
example: '2001:db8:85a3::8a2e:370:7334'
Ipv6Prefix:
type: string
allOf:
- pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))(\/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))$'
- pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$'
example: '2001:db8:abcd:12::0/64'
IpAddr:
oneOf:
- $ref: '#/components/schemas/Ipv4Addr'
- $ref: '#/components/schemas/Ipv6Addr'
- $ref: '#/components/schemas/Ipv6Prefix'
HostAddr:
# This definition will be deprecated, when all occurances of HostAddr
# are replaced by Host.
oneOf:
- $ref: '#/components/schemas/Ipv4Addr'
- $ref: '#/components/schemas/Ipv6Addr'
- $ref: '#/components/schemas/Fqdn'
Host:
oneOf:
- $ref: '#/components/schemas/IpAddr'
- $ref: '#/components/schemas/Fqdn'
Uri:
type: string
TimeInterval:
type: object
properties:
intervalStart:
$ref: '#/components/schemas/FullTime'
intervalEnd:
$ref: '#/components/schemas/FullTime'
AdministrativeState:
type: string
enum:
- LOCKED
- UNLOCKED
OperationalState:
type: string
enum:
- ENABLED
- DISABLED
UsageState:
type: string
enum:
- IDEL
- ACTIVE
- BUSY
AvailabilityStatus:
type: string
enum:
- IN_TEST
- FAILED
- POWER_OFF
- OFF_LINE
- OFF_DUTY
- DEPENDENCY
- DEGRADED
- NOT_INSTALLED
- LOG_FULL
AttributeNameValuePairSet:
description: >-
The key of this map is the attribute name, and the value the attribute value.
type: object
minProperties: 1
additionalProperties:
nullable: true
AttributeValueChangeSet:
description: >-
The first array item contains the attribute name value pairs with the new values,
and the second array item the attribute name value pairs with the optional old values.
type: array
items:
$ref: '#/components/schemas/AttributeNameValuePairSet'
minItems: 1
maxItems: 2
Filter:
description: >-
The filter format shall be compliant to Jex (TS 32.161).
type: string
SystemDN:
type: string
NotificationId:
type: integer
NotificationType:
oneOf:
- $ref: 'TS28111_FaultNrm.yaml#/components/schemas/AlarmNotificationTypes'
- $ref: 'TS28532_ProvMnS.yaml#/components/schemas/CmNotificationTypes'
- $ref: 'TS28532_PerfMnS.yaml#/components/schemas/PerfNotificationTypes'
- $ref: 'TS28532_HeartbeatNtf.yaml#/components/schemas/HeartbeatNotificationTypes'
- $ref: 'TS28532_FileDataReportingMnS.yaml#/components/schemas/FileNotificationTypes'
NotificationHeader:
type: object
properties:
href:
$ref: '#/components/schemas/Uri'
notificationId:
$ref: '#/components/schemas/NotificationId'
notificationType:
$ref: '#/components/schemas/NotificationType'
eventTime:
$ref: '#/components/schemas/DateTime'
systemDN:
$ref: '#/components/schemas/SystemDN'
required:
- href
- notificationId
- notificationType
- eventTime
- systemDN
ErrorResponse:
description: >-
Default schema for the response message body in case the request
is not successful.
type: object
properties:
error:
type: object
properties:
errorInfo:
type: string
Subscription:
type: object
properties:
consumerReference:
$ref: '#/components/schemas/Uri'
timeTick:
type: integer
filter:
$ref: '#/components/schemas/Filter'
ErrorResponseGet:
description: >-
Default schema for the response message body in case the Get
is not successful.
type: object
properties:
status:
type: string
type:
type: string
reason:
type: string
title:
type: string
badQueryParams:
type: array
items:
type: string
otherProblems:
type: array
items:
type: object
properties:
status:
type: string
type:
type: string
reason:
type: string
title:
type: string
badQueryParams:
type: array
items:
type: string
required:
- type
required:
- type
ErrorResponseDefault:
type: object
properties:
status:
type: string
type:
type: string
reason:
type: string
title:
type: string
badAttributes:
type: array
items:
type: string
badObjects:
type: array
items:
type: string
otherProblems:
type: array
items:
type: object
properties:
status:
type: string
type:
type: string
reason:
type: string
title:
type: string
badAttributes:
type: array
items:
type: string
badObjects:
type: array
items:
type: string
required:
- type
required:
- type
ErrorResponsePatch:
description: >-
Default schema for the response message body in case the patch
is not successful.
type: object
properties:
status:
type: string
type:
type: string
reason:
type: string
title:
type: string
badOP:
type: string
otherProblems:
type: array
items:
type: object
properties:
status:
type: string
type:
type: string
reason:
type: string
title:
type: string
badOp:
type: string
required:
- type
- badOp
required:
- type
- badOp