forked from jdegre/5GC_APIs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
TS26512_CommonData.yaml
247 lines (233 loc) · 7.63 KB
/
TS26512_CommonData.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
openapi: 3.0.0
info:
title: 5GMS Common Data Types
version: 2.0.2
description: |
5GMS Common Data Types
© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
tags:
- name: 5GMS Common Data Types
description: '5G Media Streaming: Common Data Types'
externalDocs:
description: 'TS 26.512 V17.6.0; 5G Media Streaming (5GMS); Protocols'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
paths: {}
components:
schemas:
#################################
# Clause 6.4.2: Simple data types
#################################
ResourceId:
type: string
description: String chosen by the 5GMS AF to serve as an identifier in a resource URI.
Percentage:
type: number
minimum: 0.0
maximum: 100.0
#DurationSec is defined in TS29571_CommonData
#DateTime is defined in TS29571_CommonData
#Uri is defined in TS29571_CommonData
Url:
type: string
format: uri-reference
description: 'Uniform Resource Locator, conforming with the "URI-reference" production specified in IETF RFC 3986, section 4.1.'
RelativeUrl:
type: string
format: uri-reference
description: 'Relative Uniform Resource Locator, conforming with the "relative-ref" production specified in IETF RFC 3986, section 4.2. Note that both "query" and "fragment" suffixes are permitted by this production.'
AbsoluteUrl:
type: string
format: uri
description: 'Absolute Uniform Resource Locator, conforming with the "absolute-URI" production specified in IETF RFC 3986, section 4.3 in which the scheme part is "http" or "https". Note that the "query" suffix is permitted by this production but the "fragment" suffix is not.'
#####################################
# Clause 6.4.3: Structured data types
#####################################
IpPacketFilterSet:
type: object
required:
- direction
properties:
srcIp:
type: string
dstIp:
type: string
protocol:
type: integer
srcPort:
type: integer
dstPort:
type: integer
toSTc:
type: string
flowLabel:
type: integer
spi:
type: integer
direction:
type: string
ServiceDataFlowDescription:
type: object
properties:
flowDescription:
$ref: '#/components/schemas/IpPacketFilterSet'
domainName:
type: string
M5QoSSpecification:
type: object
required:
- marBwDlBitRate
- marBwUlBitRate
- mirBwDlBitRate
- mirBwUlBitRate
properties:
marBwDlBitRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
marBwUlBitRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
minDesBwDlBitRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
minDesBwUlBitRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
mirBwDlBitRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
mirBwUlBitRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
desLatency:
type: integer
minimum: 0
desLoss:
type: integer
minimum: 0
M1QoSSpecification:
type: object
properties:
qosReference:
type: string
maxBtrUl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
maxBtrDl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
maxAuthBtrUl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
maxAuthBtrDl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
defPacketLossRateDl:
type: integer
minimum: 0
defPacketLossRateUl:
type: integer
minimum: 0
ChargingSpecification:
type: object
properties:
sponId:
type: string
sponStatus:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/SponsoringStatus'
gpsi:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
TypedLocation:
type: object
required:
- locationIdentifierType
- location
properties:
locationIdentifierType:
$ref: '#/components/schemas/CellIdentifierType'
location:
type: string
OperationSuccessResponse:
type: object
required:
- success
properties:
success:
type: boolean
reason:
type: string
EndpointAddress:
type: object
required:
- portNumber
properties:
hostname:
type: string
ipv4Addr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
ipv6Addr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
portNumber:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16'
EdgeProcessingEligibilityCriteria:
type: object
required:
- serviceDataFlowDescriptions
- ueLocations
- timeWindows
- appRequest
properties:
serviceDataFlowDescriptions:
type: array
items:
$ref: '#/components/schemas/ServiceDataFlowDescription'
ueLocations:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
timeWindows:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
appRequest:
type: boolean
#####################################
# Clause 6.4.4: Enumerated data types
#####################################
CellIdentifierType:
anyOf:
- type: string
enum: [CGI, ECGI, NCGI]
- type: string
description: >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
SdfMethod:
anyOf:
- type: string
enum: [5_TUPLE, 2_TUPLE, TYPE_OF_SERVICE_MARKING, FLOW_LABEL, DOMAIN_NAME]
- type: string
description: >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
ProvisioningSessionType:
anyOf:
- type: string
enum: [DOWNLINK, UPLINK]
- type: string
description: >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
CacheStatus:
anyOf:
- type: string
enum: [HIT, MISS, EXPIRED]
- type: string
description: >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
EASRelocationTolerance:
anyOf:
- type: string
enum: [RELOCATION_UNAWARE, RELOCATION_TOLERANT, RELOCATION_INTOLERANT]
- type: string
description: >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.