BwManagementApi.yaml 18.4 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
1
2
openapi: 3.0.0

3
info:
Michel Roy's avatar
Michel Roy committed
4
5
6
  title: 'ETSI GS MEC 015 Bandwidth Management API'
  version: 2.1.1
  description: The ETSI MEC ISG Bandwidth Management API described using OpenAPI.
7
  license:
ETSI CTI's avatar
ETSI CTI committed
8
    name: BSD-3-Clause
Michel Roy's avatar
Michel Roy committed
9
10
    url: 'https://forge.etsi.org/legal-matters'

11
externalDocs:
Michel Roy's avatar
Michel Roy committed
12
13
14
  description: ETSI GS MEC015 V2.1.1 Traffic Management APIs
  url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/015/02.01.01_60/gs_MEC015v020101p.pdf'

Walter Featherstone's avatar
Walter Featherstone committed
15
servers:
Michel Roy's avatar
Michel Roy committed
16
17
  - url: 'https://{apiRoot}/bwm/v1'

18
paths:
Michel Roy's avatar
Michel Roy committed
19
  /bw_allocations:
20
    get:
Walter Featherstone's avatar
Walter Featherstone committed
21
      tags:
Michel Roy's avatar
Michel Roy committed
22
23
24
25
26
27
28
29
      - ""
      summary: "Retrieve information about a list of bandwidthAllocation resources"
      description: "Retrieves information about a list of bandwidthAllocation resources. Typically used in 'Get configured bandwidth allocation from Bandwidth Management Service' procedure as described in clause 6.2.5."
      operationId: "bandwidthAllocationListGET"
      parameters:
        - $ref: '#/components/parameters/Query.app_instance_id'
        - $ref: '#/components/parameters/Query.app_name'
        - $ref: '#/components/parameters/Query.session_id'
30
      responses:
Michel Roy's avatar
Michel Roy committed
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
        200:
          description: "Upon success, a response body containing an array of the bandwidthAllocations is returned."
          content:
            application/json:
              schema:
                type: object
                properties:
                  bwInfo:
                    type: array
                    items:
                      $ref: "#/components/schemas/BwInfo"
        400:
          $ref: "#/components/responses/400"
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
48
    post:
Walter Featherstone's avatar
Walter Featherstone committed
49
      tags:
Michel Roy's avatar
Michel Roy committed
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
      - ""
      summary: "Create a bandwidthAllocation resource"
      description: "Used to create a bandwidthAllocation resource. Typically used in 'Register to Bandwidth Management Service' procedure as described in clause 6.2.1."
      operationId: "bandwidthAllocationPOST"
      parameters: []
      requestBody:
        description: "Entity body in the request contains BwInfo to be created."
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                bwInfo:
                  $ref: '#/components/schemas/BwInfo'
65
      responses:
Michel Roy's avatar
Michel Roy committed
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
        201:
          description: "Upon success, the HTTP response shall include a 'Location' HTTP header that contains the resource URI of the created resource."
          content:
            application/json:
              schema:
                type: object
                required:
                - bwInfo
                properties:
                  bwInfo:
                    $ref: "#/components/schemas/BwInfo"
        400:
          $ref: "#/components/responses/400"
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
  /bw_allocations/{allocationId}:
84
    get:
Walter Featherstone's avatar
Walter Featherstone committed
85
      tags:
Michel Roy's avatar
Michel Roy committed
86
87
88
89
90
91
      - ""
      summary: "Retrieve information about a specific bandwidthAllocation"
      description: "Retrieves information about a bandwidthAllocation resource. Typically used in 'Get configured bandwidth allocation from Bandwidth Management Service' procedure as described in clause 6.2.5."
      operationId: "bandwidthAllocationGET"
      parameters:
        - $ref: '#/components/parameters/Path.allocationId'
92
      responses:
Michel Roy's avatar
Michel Roy committed
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
        200:
          description: "Used to indicate nonspecific success. The response body contains a representation of the resource."
          content:
            application/json:
              schema:
                type: object
                required:
                  - bwInfo
                properties:
                  bwInfo:
                    $ref: "#/components/schemas/BwInfo"
        400:
          $ref: "#/components/responses/400"
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
110
    put:
Walter Featherstone's avatar
Walter Featherstone committed
111
      tags:
Michel Roy's avatar
Michel Roy committed
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
      - ""
      summary: "Update the information about a specific bandwidthAllocation"
      description: "Updates the information about a bandwidthAllocation resource. As specified in ETSI GS MEC 009 [6], the PUT HTTP method has 'replace' semantics."
      operationId: "bandwidthAllocationPUT"
      requestBody:
        description: "BwInfo with updated information is included as entity body of the request."
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                bwInfo:
                  $ref: '#/components/schemas/BwInfo'
      parameters:
        - $ref: '#/components/parameters/Path.allocationId'
128
      responses:
Michel Roy's avatar
Michel Roy committed
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
        200:
          description: "Used to indicate nonspecific success. The response body contains a representation of the resource."
          content:
            application/json:
              schema:
                type: object
                required:
                - bwInfo
                properties:
                  bwInfo:
                    $ref: "#/components/schemas/BwInfo"
        400:
          $ref: "#/components/responses/400"
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
148
    patch:
Walter Featherstone's avatar
Walter Featherstone committed
149
      tags:
Michel Roy's avatar
Michel Roy committed
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
      - ""
      summary: "Modify the information about a specific existing bandwidthAllocation by sending updates on the data structure"
      description: "Updates the information about a bandwidthAllocation resource. As specified in ETSI GS MEC 009 [6], the PATCH HTTP method updates a resource on top of the existing resource state by just including the changes ('deltas') in the request body."
      operationId: "bandwidthAllocationPATCH"
      requestBody:
        description: "Description of the changes to instruct the server how to modify the resource representation."
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                bwInfoDeltas:
                  $ref: '#/components/schemas/BwInfoDeltas'
      parameters:
        - $ref: '#/components/parameters/Path.allocationId'
166
      responses:
Michel Roy's avatar
Michel Roy committed
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
        200:
          description: "Used to indicate nonspecific success. The response body contains a representation of the resource."
          content:
            application/json:
              schema:
                type: object
                required:
                - bwInfo
                properties:
                  bwInfo:
                    $ref: "#/components/schemas/BwInfo"
        400:
          $ref: "#/components/responses/400"
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
186
    delete:
Walter Featherstone's avatar
Walter Featherstone committed
187
      tags:
Michel Roy's avatar
Michel Roy committed
188
189
190
191
192
193
      - ""
      summary: "Remove a specific bandwidthAllocation"
      description: "Used in 'Unregister from Bandwidth Management Service' procedure as described in clause 6.2.3."
      operationId: "bandwidthAllocationDELETE"
      parameters:
        - $ref: '#/components/parameters/Path.allocationId'
194
      responses:
Michel Roy's avatar
Michel Roy committed
195
196
197
198
199
200
        204:
          $ref: '#/components/responses/204'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
Walter Featherstone's avatar
Walter Featherstone committed
201
components:
Michel Roy's avatar
Michel Roy committed
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
  responses:
    204:
      description: "Upon success, a response 204 No Content without any response body is returned."
    400:
      description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
      content:
        application/json:
          schema:
            type: object
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    403:
      description: 'Forbidden :  operation is not allowed given the current status of the resource.'
      content:
        application/json:
          schema:
            type: object
            required:
              - problemDetails
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    404:
      description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
      content:
        application/json:
          schema:
            type: object
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    412:
      description: 'Precondition failed :  used when a condition has failed during conditional requests, e.g. when
        using ETags to avoid write conflicts when using PUT'
      content:
        application/json:
          schema:
            type: object
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
Walter Featherstone's avatar
Walter Featherstone committed
244
  parameters:
Michel Roy's avatar
Michel Roy committed
245
    Path.allocationId:
Walter Featherstone's avatar
Walter Featherstone committed
246
      name: allocationId
Michel Roy's avatar
Michel Roy committed
247
248
      in: "path"
      description: "Represents a bandwidth allocation instance"
Walter Featherstone's avatar
Walter Featherstone committed
249
250
251
      required: true
      schema:
        type: string
Michel Roy's avatar
Michel Roy committed
252
    Query.app_instance_id:
Walter Featherstone's avatar
Walter Featherstone committed
253
      name: app_instance_id
Michel Roy's avatar
Michel Roy committed
254
255
      in: "query"
      description: "A MEC application instance may use multiple app_instance_ids as an input parameter to query the bandwidth allocation of a list of MEC application instances. See note."
Walter Featherstone's avatar
Walter Featherstone committed
256
257
258
259
260
      required: false
      schema:
        type: array
        items:
          type: string
Michel Roy's avatar
Michel Roy committed
261
    Query.app_name:
Walter Featherstone's avatar
Walter Featherstone committed
262
      name: app_name
Michel Roy's avatar
Michel Roy committed
263
264
      in: "query"
      description: "A MEC application instance may use multiple app_names as an input parameter to query the bandwidth allocation of a list of MEC application instances. See note."
Walter Featherstone's avatar
Walter Featherstone committed
265
266
267
268
269
      required: false
      schema:
        type: array
        items:
          type: string
Michel Roy's avatar
Michel Roy committed
270
    Query.session_id:
Walter Featherstone's avatar
Walter Featherstone committed
271
      name: session_id
Michel Roy's avatar
Michel Roy committed
272
273
      in: "query"
      description: "A MEC application instance may use session_id as an input parameter to query the bandwidth allocation of a list of sessions. See note."
Walter Featherstone's avatar
Walter Featherstone committed
274
275
276
277
278
279
280
      required: false
      schema:
        type: array
        items:
          type: string
  schemas:
    BwInfo:
281
      properties:
Michel Roy's avatar
Michel Roy committed
282
283
284
285
286
287
288
289
        allocationDirection:
          description: 'The direction of the requested BW allocation:
            00 = Downlink (towards the UE)
            01 = Uplink (towards the application/session)
            10 = Symmetrical'
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
Walter Featherstone's avatar
Walter Featherstone committed
290
        appInsId:
Michel Roy's avatar
Michel Roy committed
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
          description: Application instance identifier
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        fixedAllocation:
          description: Size of requested fixed BW allocation in [bps]
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        fixedBWPriority:
          description: Indicates the allocation priority when dealing with several applications or sessions in parallel. Values are not defined in the present document
          enum:
          - SEE_DESCRIPTION
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Enum
Walter Featherstone's avatar
Walter Featherstone committed
307
        requestType:
Michel Roy's avatar
Michel Roy committed
308
309
310
311
312
313
314
315
316
          description: 'Numeric value (0 - 255) corresponding to specific type of consumer as following:
            0 = APPLICATION_SPECIFIC_BW_ALLOCATION
            1 = SESSION_SPECIFIC_BW_ALLOCATION'
          type: string
          enum:
          - 0
          - 1
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Enum_inlined
Walter Featherstone's avatar
Walter Featherstone committed
317
        sessionFilter:
Michel Roy's avatar
Michel Roy committed
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
          description: Session filtering criteria, applicable when requestType is set as SESSION_SPECIFIC_BW_ALLOCATION. Any filtering criteria shall define a single session only. In case multiple sessions match sessionFilter the request shall be rejected
          items:
            type: object
            properties:
              dstAddress:
                description: Destination address identity of session (including range)
                type: string
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: String
              dstPort:
                description: Destination port identity of session
                items:
                  type: string
                minItems: 0
                type: array
                x-etsi-mec-cardinality: 0..N
                x-etsi-mec-origin-type: String
              protocol:
                description: Protocol number
                type: string
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: String
              sourceIp:
                description: Source address identity of session (including range)
                type: string
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: String
              sourcePort:
                description: Source port identity of session
                items:
                  type: string
                minItems: 0
                type: array
                x-etsi-mec-cardinality: 0..N
                x-etsi-mec-origin-type: String
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Structure (inlined)
        timeStamp:
          description: Time stamp to indicate when the corresponding information elements are sent
          properties:
            nanoSeconds:
              type: integer
              format: uint32
              description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Uint32
            seconds:
              type: integer
              format: uint32
              description: The seconds part of the Time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Uint32
          required:
          - seconds
          - nanoSeconds
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
      required:
      - appInsId
      - requestType
      - fixedAllocation
      - allocationDirection
Walter Featherstone's avatar
Walter Featherstone committed
383
      type: object
Michel Roy's avatar
Michel Roy committed
384
385
      x-etsi-ref: 7.2.2
    BwInfoDeltas:
Walter Featherstone's avatar
Walter Featherstone committed
386
      properties:
Michel Roy's avatar
Michel Roy committed
387
388
389
390
391
392
393
394
        allocationDirection:
          description: 'The direction of the requested BW allocation:
            00 = Downlink (towards the UE)
            01 = Uplink (towards the application/session)
            10 = Symmetrical'
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
Walter Featherstone's avatar
Walter Featherstone committed
395
        appInsId:
Michel Roy's avatar
Michel Roy committed
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
          description: Application instance identifier
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        fixedAllocation:
          description: Size of requested fixed BW allocation in [bps]
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        fixedBWPriority:
          description: Indicates the allocation priority when dealing with several applications or sessions in parallel. Values are not defined in the present document
          enum:
          - SEE DESCRIPTION
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Enum_inlined
Walter Featherstone's avatar
Walter Featherstone committed
412
        requestType:
Michel Roy's avatar
Michel Roy committed
413
414
415
416
417
418
419
420
421
          description: 'Numeric value (0 - 255) corresponding to specific type of consumer as following:
            0 = APPLICATION_SPECIFIC_BW_ALLOCATION
            1 = SESSION_SPECIFIC_BW_ALLOCATION'
          type: string
          enum:
          - 0
          - 1
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Enum_inlined
Walter Featherstone's avatar
Walter Featherstone committed
422
        sessionFilter:
Michel Roy's avatar
Michel Roy committed
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
          description: Session filtering criteria, applicable when requestType is set as SESSION_SPECIFIC_BW_ALLOCATION. Any filtering criteria shall define a single session only. In case multiple sessions match sessionFilter the request shall be rejected
          items:
            type: object
            properties:
              dstAddress:
                description: Destination address identity of session (including range)
                type: string
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: String
              dstPort:
                description: Destination port identity of session
                items:
                  type: string
                minItems: 0
                type: array
                x-etsi-mec-cardinality: 0..N
                x-etsi-mec-origin-type: String
              protocol:
                description: Protocol number
                type: string
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: String
              sourceIp:
                description: Source address identity of session (including range)
                type: string
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: String
              sourcePort:
                description: 'Source port identity of session '
                items:
                  type: string
                minItems: 0
                type: array
                x-etsi-mec-cardinality: 0..N
                x-etsi-mec-origin-type: String
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Structure (inlined)
Walter Featherstone's avatar
Walter Featherstone committed
462
      required:
Michel Roy's avatar
Michel Roy committed
463
464
465
466
467
      - appInsId
      - requestType
      type: object
      x-etsi-ref: 7.2.3
    ProblemDetails:
Walter Featherstone's avatar
Walter Featherstone committed
468
      properties:
Michel Roy's avatar
Michel Roy committed
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
        detail:
          description: A human-readable explanation specific to this occurrence of the problem
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        instance:
          description: A URI reference that identifies the specific occurrence of the problem
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
        status:
          description: The HTTP status code for this occurrence of the problem
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        title:
          description: A short, human-readable summary of the problem type
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        type:
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
      type: object