1
1
openapi : 3.0.0
2
2
info :
3
3
title : M1_ContentHostingProvisioning
4
- version : 2.1 .0
4
+ version : 2.2 .0
5
5
description : |
6
6
5GMS AF M1 Content Hosting Provisioning API
7
- © 2022 , 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
7
+ © 2023 , 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
8
8
All rights reserved.
9
9
tags :
10
10
- name : M1_ContentHostingProvisioning
11
11
description : ' 5G Media Streaming: Provisioning (M1) APIs: Content Hosting Provisioning'
12
12
externalDocs :
13
- description : ' TS 26.512 V17.3 .0; 5G Media Streaming (5GMS); Protocols'
13
+ description : ' TS 26.512 V17.4 .0; 5G Media Streaming (5GMS); Protocols'
14
14
url : ' https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
15
15
servers :
16
16
- url : ' {apiRoot}/3gpp-m1/v2'
45
45
description : ' URL of the newly created Content Hosting Configuration (same as request URL).'
46
46
required : true
47
47
schema :
48
- $ref : ' TS26512_CommonData.yaml#/components/schemas/Url '
48
+ $ref : ' TS26512_CommonData.yaml#/components/schemas/AbsoluteUrl '
49
49
get :
50
50
operationId : retrieveContentHostingConfiguration
51
51
summary : ' Retrieve the Content Hosting Configuration of the specified Provisioning Session'
@@ -123,14 +123,49 @@ paths:
123
123
schema :
124
124
properties :
125
125
pattern :
126
- description : ' Keyword'
127
- type : string
128
- value :
129
126
description : ' The regular expression'
130
127
type : string
131
128
responses :
132
129
' 200 ' :
130
+ # OK
133
131
description : ' Content Purged'
132
+ content :
133
+ application/json :
134
+ schema :
135
+ description : ' The aggregate number of cache entries purged in all 5GMSd AS instances distributing content for the requested Provisioning Session.'
136
+ type : integer
137
+ minimum : 1
138
+ ' 204 ' :
139
+ # No Content
140
+ description : ' No Content Purged'
141
+ ' 404 ' :
142
+ # Not Found
143
+ $ref : ' TS29571_CommonData.yaml#/components/responses/404'
144
+ ' 413 ' :
145
+ # Payload Too Large
146
+ $ref : ' TS29571_CommonData.yaml#/components/responses/413'
147
+ ' 414 ' :
148
+ # URI Too Long
149
+ $ref : ' TS29571_CommonData.yaml#/components/responses/414'
150
+ ' 415 ' :
151
+ # Unsupported Media Type
152
+ $ref : ' TS29571_CommonData.yaml#/components/responses/415'
153
+ ' 422 ' :
154
+ # Unprocessable Entity (e.g. syntactically invalid regular expression in request body)
155
+ description : ' Unprocessable Entity'
156
+ content :
157
+ application/problem+json :
158
+ schema :
159
+ $ref : ' TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
160
+ ' 500 ' :
161
+ # Internal Server Error
162
+ $ref : ' TS29571_CommonData.yaml#/components/responses/500'
163
+ ' 503 ' :
164
+ # Service Unavailable
165
+ $ref : ' TS29571_CommonData.yaml#/components/responses/503'
166
+ default :
167
+ $ref : ' TS29571_CommonData.yaml#/components/responses/default'
168
+
134
169
components :
135
170
schemas :
136
171
IngestConfiguration :
@@ -142,7 +177,25 @@ components:
142
177
protocol :
143
178
$ref : ' TS29571_CommonData.yaml#/components/schemas/Uri'
144
179
baseURL :
145
- $ref : ' TS26512_CommonData.yaml#/components/schemas/Url'
180
+ $ref : ' TS26512_CommonData.yaml#/components/schemas/AbsoluteUrl'
181
+
182
+ MediaEntryPoint :
183
+ description : " A typed entry point for downlink or uplink media streaming."
184
+ type : object
185
+ required :
186
+ - relativePath
187
+ - contentType
188
+ properties :
189
+ relativePath :
190
+ $ref : ' TS26512_CommonData.yaml#/components/schemas/RelativeUrl'
191
+ contentType :
192
+ type : string
193
+ profiles :
194
+ type : array
195
+ items :
196
+ $ref : ' TS29571_CommonData.yaml#/components/schemas/Uri'
197
+ minItems : 1
198
+
146
199
PathRewriteRule :
147
200
type : object
148
201
description : ' A rule to manipulate URL paths.'
@@ -154,6 +207,7 @@ components:
154
207
type : string
155
208
mappedPath :
156
209
type : string
210
+
157
211
CachingConfiguration :
158
212
type : object
159
213
description : ' A content caching configuration.'
@@ -176,18 +230,21 @@ components:
176
230
maxAge :
177
231
type : integer
178
232
format : int32
233
+
179
234
DistributionConfiguration :
180
235
type : object
181
236
description : ' A content distribution configuration.'
182
237
properties :
238
+ entryPoint :
239
+ $ref : ' #/components/schemas/MediaEntryPoint'
183
240
contentPreparationTemplateId :
184
241
$ref : ' TS26512_CommonData.yaml#/components/schemas/ResourceId'
185
242
canonicalDomainName :
186
243
type : string
187
244
domainNameAlias :
188
245
type : string
189
246
baseURL :
190
- $ref : ' TS26512_CommonData.yaml#/components/schemas/Url '
247
+ $ref : ' TS26512_CommonData.yaml#/components/schemas/AbsoluteUrl '
191
248
pathRewriteRules :
192
249
type : array
193
250
items :
@@ -249,6 +306,7 @@ components:
249
306
$ref : ' #/components/schemas/DistributionNetworkType'
250
307
distributionMode :
251
308
$ref : ' #/components/schemas/DistributionMode'
309
+
252
310
# Schema for the resource itself
253
311
ContentHostingConfiguration :
254
312
type : object
@@ -260,8 +318,6 @@ components:
260
318
properties :
261
319
name :
262
320
type : string
263
- entryPointPath :
264
- $ref : ' TS26512_CommonData.yaml#/components/schemas/Url'
265
321
ingestConfiguration :
266
322
$ref : ' #/components/schemas/IngestConfiguration'
267
323
distributionConfigurations :
0 commit comments