description:The present document focuses on the Multi-access Traffic Steering multi-access edge service. It describes the related application policy information including authorization and access control, information flows, required information and service aggregation patterns. The present document specifies the necessary API with the data model and data format.
license:
name:BSD-3-Clause
url:https://forge.etsi.org/legal-matters
version:2.2.1
paths:
/bw_allocations/{allocationId}:
get:
summary:Retrieve information about a specific bandwidthAllocation.
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'
responses:
'200':
description:Upon success, a response body containing data type describing the updated BwInfo is returned.
content:
application/json:
schema:
type:object
properties:
BwInfo:
$ref:'#/components/schemas/BwInfo'
'400':
$ref:'#/components/responses/400'
'404':
$ref:'#/components/responses/404'
'403':
$ref:'#/components/responses/403'
'412':
$ref:'#/components/responses/412'
delete:
summary:Remove a specific bandwidthAllocation.
description:DELETE method is typically used in "Unregister from Bandwidth Management Service" procedure as described in clause 6.2.3.
operationId:bwallocationsByIdDELETE
tags:
-bwm
responses:
'204':
$ref:'#/components/responses/204'
'404':
$ref:'#/components/responses/404'
'403':
$ref:'#/components/responses/403'
/bw_allocations:
get:
summary:Retrieve information about a list of bandwidthAllocation resources.
description:This method retrieves information about a list of bandwidthAllocation resources. This method is typically used in "Get configured bandwidth allocation from Bandwidth Management Service" procedure as described in clause 6.2.5.
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'
'404':
$ref:'#/components/responses/404'
'403':
$ref:'#/components/responses/403'
post:
summary:Create a bandwidthAllocation resource.
description:This method is used to create a bandwidthAllocation resource. This method is typically used in "Register to Bandwidth Management Service" procedure as described in clause 6.2.1.
operationId:bwallocationsPOST
tags:
-bwm
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'
responses:
'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
properties:
BwInfo:
$ref:'#/components/schemas/BwInfo'
'400':
$ref:'#/components/responses/400'
'404':
$ref:'#/components/responses/404'
'403':
$ref:'#/components/responses/403'
components:
schemas:
ProblemDetails:
type:object
properties:
type:
type:string
format:uri
description:A URI reference according to IETF RFC 3986 that identifies the problem type
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:URI
title:
type:string
description:A short, human-readable summary of the problem type
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:String
status:
type:integer
format:uint32
description:The HTTP status code for this occurrence of the problem
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:Uint32
detail:
type:string
description:A human-readable explanation specific to this occurrence of the problem
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:String
instance:
type:string
format:uri
description:A URI reference that identifies the specific occurrence of the problem
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
x-etsi-mec-origin-type:Enum
x-etsi-mec-cardinality:0..1
fixedAllocation:
description:Size of requested fixed BW allocation in [bps]
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
x-etsi-mec-origin-type:Enum_inlined
x-etsi-mec-cardinality:0..1
fixedAllocation:
description:Size of requested fixed BW allocation in [bps]
description:Time stamp to indicate when the corresponding information elements are sent
x-etsi-mec-origin-type:Structure (inlined)
x-etsi-mec-cardinality:0..1
type:object
properties:
seconds:
description:The seconds part of the Time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC
x-etsi-mec-origin-type:Uint32
x-etsi-mec-cardinality:'1'
type:integer
format:uint32
nanoSeconds:
description:The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
x-etsi-mec-origin-type:Uint32
x-etsi-mec-cardinality:'1'
type:integer
format:uint32
required:
-seconds
-nanoSeconds
SessionFilter:
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
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
