Skip to content
GitLab
Commits (8)
Hide whitespace changes
Inline Side-by-side
.jenkins.sh
View file @ f87d2918
#!/bin/bash
specfiles=$(ls | egrep "^[^.]*Api.(json|yaml)")
specfiles=$(ls | egrep "^[^.]*.(json|yaml)")
fres=0
for i in $specfiles ; do
echo "-- Validating OpenAPI file $i..."
swagger-tools validate $i
echo "-- Validating and linting OpenAPI file $i..."
swagger-cli validate $i
res=$?
fres=$(($fres||$res))
echo -e "-- Validator returned $res.\n"
speccy lint "$i"
res2=$?
fres=$(($fres||$res||$res2))
echo "--- Validator returned $res, linter returned $res2."
done
echo "-- Final validator returns $fres."
exit $fres
exit $fres
\ No newline at end of file
BwManagementApi.json
View file @ f87d2918
{
"swagger": "2.0",
"info": {
"description": "The ETSI MEC ISG MEC015 Bandwidth Management API described using OpenAPI",
"version": "1.1.1",
"title": "BWM API",
"license": {
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
}
},
"externalDocs": {
"description": "ETSI MEC015 V1.1.1 Bandwidth Management API",
"url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/015/01.01.01_60/gs_MEC015v010101p.pdf"
},
"host": "127.0.0.1:8081",
"basePath": "/bwm/v1",
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"OauthSecurity": [
"all"
]
}
],
"securityDefinitions": {
"OauthSecurity": {
"type": "oauth2",
"flow": "application",
"tokenUrl": "https://oauth.exampleAPI/token",
"scopes": {
"all": "Single oauth2 scope for API"
}
}
"openapi": "3.0.0",
"info": {
"contact": {
"url": "https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api"
},
"parameters": {
"Body.BwInfo": {
"name": "bwInfo",
"in": "body",
"description": "BwInfo with updated information is included as entity body of the request",
"required": true,
"schema": {
"$ref": "#/definitions/BwInfo"
}
},
"Body.BwInfoDeltas": {
"name": "bwInfoDeltas",
"in": "body",
"description": "Description of the changes to instruct the server how to modify the resource representation. ",
"required": true,
"schema": {
"$ref": "#/definitions/BwInfoDeltas"
}
},
"Path.AllocationId": {
"name": "allocationId",
"in": "path",
"description": "Represents a bandwidth allocation instance",
"required": true,
"type": "string"
},
"Query.AppInstanceId": {
"name": "app_instance_id",
"in": "query",
"description": "A mobile edge application instance may use multiple app_instance_ids as an input parameter to query the bandwidth allocation of a list of mobile edge application instances. ",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
"Query.AppName": {
"name": "app_name",
"in": "query",
"description": "A mobile edge application instance may use multiple ser_names as an input parameter to query the bandwidth allocation of a list of mobile edge application instances. ",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
"Query.SessionId": {
"name": "session_id",
"in": "query",
"description": "A mobile edge application instance may use session_id as an input parameter to query the bandwidth allocation of a list of sessions. ",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
},
"paths": {
"/bw_allocations": {
"get": {
"description": "This method retrieves information about a list of bandwidthAllocation resources",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/Query.AppInstanceId"
},
{
"$ref": "#/parameters/Query.AppName"
},
{
"$ref": "#/parameters/Query.SessionId"
}
],
"responses": {
"200": {
"description": "Upon success, a response body containing an array of the bandwidthAllocations is returned.",
"schema": {
"required": [
"bwInfo"
],
"properties": {
"bwInfo": {
"$ref": "#/definitions/BwInfo"
}
}
}
},
"400": {
"description": "It is used to indicate that incorrect parameters were passed to the request. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"schema": {
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
},
"403": {
"description": "The operation is not allowed given the current status of the resource. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
"schema": {
"required": [
"ProblemDetails"
],
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
"title": "ETSI GS MEC 015 Bandwidth Management API",
"version": "2.1.1",
"description": "The ETSI MEC ISG Bandwidth Management API described using OpenAPI.",
"license": {
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
}
},
"externalDocs": {
"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"
},
"servers": [
{
"url": "https://localhost/bwm/v1"
}
],
"tags": [
{
"name": "bwm"
}
],
"paths": {
"/bw_allocations": {
"get": {
"tags": [
"bwm"
],
"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"
}
],
"responses": {
"200": {
"description": "Upon success, a response body containing an array of the bandwidthAllocations is returned.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BwInfo"
}
}
}
},
"404": {
"description": "It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
}
},
"post": {
"tags": [
"bwm"
],
"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": {
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
"$ref": "#/components/schemas/BwInfo"
}
}
}
},
"post": {
"description": "This method is used to create a bandwidthAllocation resource.",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/Body.BwInfo"
}
],
"responses": {
"201": {
"description": "Upon success, the HTTP response shall include a \"Location\" HTTP header that contains the resource URI of the created resource.",
"schema": {
"required": [
"bwInfo"
],
"properties": {
"bwInfo": {
"$ref": "#/definitions/BwInfo"
}
}
}
},
"400": {
"description": "It is used to indicate that incorrect parameters were passed to the request. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"schema": {
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
},
"403": {
"description": "The operation is not allowed given the current status of the resource. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
"schema": {
"required": [
"ProblemDetails"
],
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
"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": {
"$ref": "#/components/schemas/BwInfo"
}
}
},
"404": {
"description": "It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"schema": {
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
}
}
},
"/bw_allocations/{allocationId}": {
"get": {
"tags": [
"bwm"
],
"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"
}
],
"responses": {
"200": {
"description": "Used to indicate nonspecific success. The response body contains a representation of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BwInfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
}
},
"/bw_allocations/{allocationId}": {
"get": {
"description": "This method retrieves information about a specific bandwidthAllocation resource. ",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/Path.AllocationId"
}
],
"responses": {
"200": {
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"schema": {
"required": [
"bwInfo"
],
"properties": {
"bwInfo": {
"$ref": "#/definitions/BwInfo"
}
}
}
},
"400": {
"description": "It is used to indicate that incorrect parameters were passed to the request. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"schema": {
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
},
"403": {
"description": "The operation is not allowed given the current status of the resource. More information shall be provided in the \"detail\" attribute of the \"ProblemDetails\" structure. required:\n - ProblemDetails\nproperties:\n ProblemDetails:\n $ref: '#/definitions/ProblemDetails'"
},
"404": {
"description": "It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"put": {
"tags": [
"bwm"
],
"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": {
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
"$ref": "#/components/schemas/BwInfo"
}
}
}
},
"put": {
"description": "This method updates the information about a specific bandwidthAllocation resource. ",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/Path.AllocationId"
},
{
"$ref": "#/parameters/Body.BwInfo"
}
],
"responses": {
"200": {
"description": "Upon success, a response body containing data type describing the updated BwInfo is returned.",
"schema": {
"required": [
"bwInfo"
],
"properties": {
"bwInfo": {
"$ref": "#/definitions/BwInfo"
}
}
}
},
"400": {
"description": "It is used to indicate that incorrect parameters were passed to the request. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"schema": {
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
},
"403": {
"description": "The operation is not allowed given the current status of the resource. More information shall be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
"schema": {
"required": [
"ProblemDetails"
],
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
},
"404": {
"description": "It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"schema": {
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
},
"412": {
"description": "It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"schema": {
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
"parameters": [
{
"$ref": "#/components/parameters/Path.allocationId"
}
],
"responses": {
"200": {
"description": "Used to indicate nonspecific success. The response body contains a representation of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BwInfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"412": {
"$ref": "#/components/responses/412"
}
},
"patch": {
"description": "This method updates the information about a specific bandwidthAllocation resource. ",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/Path.AllocationId"
},
{
"$ref": "#/parameters/Body.BwInfoDeltas"
}
],
"responses": {
"200": {
"description": "Upon success, a response body containing data type describing the updated BwInfo is returned.",
"schema": {
"required": [
"bwInfo"
],
"properties": {
"bwInfo": {
"$ref": "#/definitions/BwInfo"
}
}
}
},
"400": {
"description": "It is used to indicate that incorrect parameters were passed to the request. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"schema": {
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
},
"403": {
"description": "The operation is not allowed given the current status of the resource. More information shall be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
"schema": {
"required": [
"ProblemDetails"
],
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
},
"404": {
"description": "It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"schema": {
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
},
"412": {
"description": "It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
}
},
"patch": {
"tags": [
"bwm"
],
"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": {
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
"$ref": "#/components/schemas/BwInfoDeltas"
}
}
}
},
"delete": {
"description": "Remove a specific bandwidthAllocation resource. DELETE method is typically used in \"Unregister from Bandwidth Management Service\" procedure",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/Path.AllocationId"
}
],
"responses": {
"204": {
"description": "No Content"
},
"403": {
"description": "The operation is not allowed given the current status of the resource. More information shall be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
"schema": {
"required": [
"ProblemDetails"
],
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
},
"404": {
"description": "It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"schema": {
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
"parameters": [
{
"$ref": "#/components/parameters/Path.allocationId"
}
],
"responses": {
"200": {
"description": "Used to indicate nonspecific success. The response body contains a representation of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BwInfo"
}
}
}
}
}
}
},
"definitions": {
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/Problem.type"
},
"title": {
"$ref": "#/definitions/Problem.title"
"400": {
"$ref": "#/components/responses/400"
},
"status": {
"$ref": "#/definitions/Problem.status"
"403": {
"$ref": "#/components/responses/403"
},
"detail": {
"$ref": "#/definitions/Problem.detail"
"404": {
"$ref": "#/components/responses/404"
},
"instance": {
"$ref": "#/definitions/Problem.instance"
"412": {
"$ref": "#/components/responses/412"
}
}
},
"Problem.type": {
"type": "string",
"format": "uri",
"description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
"delete": {
"tags": [
"bwm"
],
"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"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
}
}
}
},
"components": {
"responses": {
"204": {
"description": "Upon success, a response 204 No Content without any response body is returned."
},
"Problem.title": {
"type": "string",
"description": "A short, human-readable summary of the problem type"
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"Problem.status": {
"type": "integer",
"format": "uint32",
"description": "The HTTP status code for this occurrence of the problem"
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"Problem.detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem"
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/problem+json": {
"schema": {
"$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/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"parameters": {
"Path.allocationId": {
"name": "allocationId",
"in": "path",
"description": "Represents a bandwidth allocation instance",
"required": true,
"schema": {
"type": "string"
}
},
"Query.app_instance_id": {
"name": "app_instance_id",
"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.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Problem.instance": {
"type": "string",
"format": "uri",
"description": "A URI reference that identifies the specific occurrence of the problem"
"Query.app_name": {
"name": "app_name",
"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.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Query.session_id": {
"name": "session_id",
"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.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"schemas": {
"BwInfo": {
"description": "information of bandwidth resource",
"type": "object",
"required": [
"appInsId",
"requestType",
"fixedAllocation",
"allocationDirection"
],
"properties": {
"timeStamp": {
"$ref": "#/definitions/TimeStamp"
"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"
},
"appInsId": {
"$ref": "#/definitions/AppInsId"
"description": "Application instance identifier",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"requestType": {
"$ref": "#/definitions/RequestType"
},
"sessionFilter": {
"$ref": "#/definitions/SessionFilter"
"fixedAllocation": {
"description": "Size of requested fixed BW allocation in [bps]",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"fixedBWPriority": {
"$ref": "#/definitions/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"
},
"fixedAllocation": {
"$ref": "#/definitions/FixedAllocation"
"requestType": {
"description": "Numeric value (0 - 255) corresponding to specific type of consumer as following: 0 = APPLICATION_SPECIFIC_BW_ALLOCATION 1 = SESSION_SPECIFIC_BW_ALLOCATION",
"type": "integer",
"enum": [
0,
1
],
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum_inlined"
},
"allocationDirection": {
"$ref": "#/definitions/AllocationDirection"
"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",
"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": "int32",
"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": "int32",
"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"
],
"type": "object",
"x-etsi-ref": "7.2.2"
},
"BwInfoDeltas": {
"description": "Conform to JSON merge patch format and processing rules specified IETF RFC 7396 [8], this type represents the attributes whose value are allowed to be updated with HTTP PATCH method in content format JSON",
"type": "object",
"properties": {
"appInsId": {
"$ref": "#/definitions/AppInsId"
"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"
},
"requestType": {
"$ref": "#/definitions/RequestType"
"appInsId": {
"description": "Application instance identifier",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"sessionFilter": {
"$ref": "#/definitions/SessionFilter"
"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": {
"$ref": "#/definitions/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"
},
"fixedAllocation": {
"$ref": "#/definitions/FixedAllocation"
"requestType": {
"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"
},
"allocationDirection": {
"$ref": "#/definitions/AllocationDirection"
"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",
"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": {
"type": "object",
},
"required": [
"seconds",
"nanoSeconds"
"appInsId",
"requestType"
],
"type": "object",
"x-etsi-ref": "7.2.3"
},
"ProblemDetails": {
"properties": {
"seconds": {
"$ref": "#/definitions/Seconds"
"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"
},
"nanoSeconds": {
"$ref": "#/definitions/NanoSeconds"
}
}
},
"AppInsId": {
"description": "Application instance identifier",
"type": "string"
},
"RequestType": {
"description": "Numeric value (0 - 255) corresponding to specific type of consumer",
"type": "string",
"enum": [
"APPLICATION_SPECIFIC_BW_ALLOCATION",
"SESSION_SPECIFIC_BW_ALLOCATION"
]
},
"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",
"type": "array",
"items": {
"type": "object",
"properties": {
"sourceIp": {
"$ref": "#/definitions/SourceIp"
},
"sourcePort": {
"$ref": "#/definitions/SourcePort"
},
"dstAddress": {
"$ref": "#/definitions/DstAddress"
},
"dstPort": {
"$ref": "#/definitions/DstPort"
},
"protocol": {
"$ref": "#/definitions/Protocol"
}
"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": "int32",
"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"
}
}
},
"FixedBWPriority": {
"description": "Indicates the allocation priority when dealing with several applications or sessions in parallel. Values are not defined in the present document",
"type": "string",
"enum": [
"not defined in the present document"
]
},
"FixedAllocation": {
"description": "Size of requested fixed BW allocation in [bps]",
"type": "string"
},
"AllocationDirection": {
"description": "The direction of the requested BW allocation",
"type": "string",
"enum": [
"00 = Downlink (towards the UE)",
"01 = Uplink (towards the application/session)",
"10 = Symmetrical"
]
},
"Seconds": {
"description": "The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
"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",
"type": "integer",
"format": "uint32"
},
"SourceIp": {
"description": "Source address identity of session (including range)",
"type": "string"
},
"SourcePort": {
"description": "Source port identity of session ",
"type": "array",
"items": {
"type": "string"
}
},
"DstAddress": {
"description": "Destination address identity of session (including range)",
"type": "string"
},
"DstPort": {
"description": "Destination port identity of session ",
"type": "array",
"items": {
"type": "string"
}
},
"Protocol": {
"description": "Protocol number",
"type": "string"
},
"type": "object"
}
}
}
}
\ No newline at end of file
BwManagementApi.yaml
View file @ f87d2918
swagger: '2.0'
openapi: 3.0.0
info:
description: >-
The ETSI MEC ISG MEC015 Bandwidth Management API described using OpenAPI
version: 1.1.1
title: BWM API
contact:
url: https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api
title: 'ETSI GS MEC 015 Bandwidth Management API'
version: 2.1.1
description: The ETSI MEC ISG Bandwidth Management API described using OpenAPI.
license:
name: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
externalDocs:
description: ETSI MEC015 V1.1.1 Bandwidth Management API
url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/015/01.01.01_60/gs_MEC015v010101p.pdf'
host: '127.0.0.1:8081'
basePath: /bwm/v1
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
security:
- OauthSecurity:
- all
securityDefinitions:
OauthSecurity:
type: oauth2
flow: application
tokenUrl: 'https://oauth.exampleAPI/token'
scopes:
all: Single oauth2 scope for API
parameters:
Body.BwInfo:
name: bwInfo
in: body
description: >-
BwInfo with updated information is included as entity body of the request
required: true
schema:
$ref: '#/definitions/BwInfo'
Body.BwInfoDeltas:
name: bwInfoDeltas
in: body
description: >-
Description of the changes to instruct the server how to modify the resource representation.
required: true
schema:
$ref: '#/definitions/BwInfoDeltas'
Path.AllocationId:
name: allocationId
in: path
description: >-
Represents a bandwidth allocation instance
required: true
type: string
Query.AppInstanceId:
name: app_instance_id
in: query
description: >-
A mobile edge application instance may use multiple app_instance_ids as an input parameter to query the bandwidth allocation of a list of mobile edge application instances.
required: false
type: array
items:
type: string
Query.AppName:
name: app_name
in: query
description: >-
A mobile edge application instance may use multiple ser_names as an input parameter to query the bandwidth allocation of a list of mobile edge application instances.
required: false
type: array
items:
type: string
Query.SessionId:
name: session_id
in: query
description: >-
A mobile edge application instance may use session_id as an input parameter to query the bandwidth allocation of a list of sessions.
required: false
type: array
items:
type: string
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'
servers:
- url: 'https://localhost/bwm/v1'
tags:
- name: "bwm"
paths:
/bw_allocations:
get:
description: >-
This method retrieves information about a list of bandwidthAllocation resources
produces:
- application/json
tags:
- "bwm"
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: '#/parameters/Query.AppInstanceId'
- $ref: '#/parameters/Query.AppName'
- $ref: '#/parameters/Query.SessionId'
- $ref: '#/components/parameters/Query.app_instance_id'
- $ref: '#/components/parameters/Query.app_name'
- $ref: '#/components/parameters/Query.session_id'
responses:
'200':
description: >-
Upon success, a response body containing an array of the bandwidthAllocations is returned.
schema:
required:
- bwInfo
properties:
bwInfo:
$ref: '#/definitions/BwInfo'
'400':
description: It is used to indicate that incorrect parameters were passed to the request. In the returned ProblemDetails structure, the "detail" attribute should convey more information about the error.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: >-
The operation is not allowed given the current status of the resource. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: >-
It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the "detail" attribute should convey more information about the error.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
200:
description: "Upon success, a response body containing an array of the bandwidthAllocations is returned."
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/BwInfo"
400:
$ref: "#/components/responses/400"
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
post:
description: >-
This method is used to create a bandwidthAllocation resource.
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.BwInfo'
tags:
- "bwm"
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:
$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.
schema:
required:
- bwInfo
properties:
bwInfo:
$ref: '#/definitions/BwInfo'
'400':
description: It is used to indicate that incorrect parameters were passed to the request. In the returned ProblemDetails structure, the "detail" attribute should convey more information about the error.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: >-
The operation is not allowed given the current status of the resource. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: >-
It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the "detail" attribute should convey more information about the error.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
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:
$ref: "#/components/schemas/BwInfo"
400:
$ref: "#/components/responses/400"
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
/bw_allocations/{allocationId}:
get:
description: >-
This method retrieves information about a specific bandwidthAllocation resource.
produces:
- application/json
tags:
- "bwm"
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: '#/parameters/Path.AllocationId'
- $ref: '#/components/parameters/Path.allocationId'
responses:
'200':
description: >-
It is used to indicate nonspecific success. The response body contains a representation of the resource.
schema:
required:
- bwInfo
properties:
bwInfo:
$ref: '#/definitions/BwInfo'
'400':
description: It is used to indicate that incorrect parameters were passed to the request. In the returned ProblemDetails structure, the "detail" attribute should convey more information about the error.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: >-
The operation is not allowed given the current status of the resource. More information shall be provided in the "detail" attribute of the "ProblemDetails" structure.
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: >-
It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the "detail" attribute should convey more information about the error.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
200:
description: "Used to indicate nonspecific success. The response body contains a representation of the resource."
content:
application/json:
schema:
$ref: "#/components/schemas/BwInfo"
400:
$ref: "#/components/responses/400"
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
put:
description: >-
This method updates the information about a specific bandwidthAllocation resource.
produces:
- application/json
tags:
- "bwm"
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:
$ref: '#/components/schemas/BwInfo'
parameters:
- $ref: '#/parameters/Path.AllocationId'
- $ref: '#/parameters/Body.BwInfo'
- $ref: '#/components/parameters/Path.allocationId'
responses:
'200':
description: >-
Upon success, a response body containing data type describing the updated BwInfo is returned.
schema:
required:
- bwInfo
properties:
bwInfo:
$ref: '#/definitions/BwInfo'
'400':
description: It is used to indicate that incorrect parameters were passed to the request. In the returned ProblemDetails structure, the "detail" attribute should convey more information about the error.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: >-
The operation is not allowed given the current status of the resource. More information shall be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: >-
It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the "detail" attribute should convey more information about the error.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'412':
description: >-
It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts. In the returned ProblemDetails structure, the "detail" attribute should convey more information about the error.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
200:
description: "Used to indicate nonspecific success. The response body contains a representation of the resource."
content:
application/json:
schema:
$ref: "#/components/schemas/BwInfo"
400:
$ref: "#/components/responses/400"
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
patch:
description: >-
This method updates the information about a specific bandwidthAllocation resource.
produces:
- application/json
tags:
- "bwm"
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:
$ref: '#/components/schemas/BwInfoDeltas'
parameters:
- $ref: '#/parameters/Path.AllocationId'
- $ref: '#/parameters/Body.BwInfoDeltas'
- $ref: '#/components/parameters/Path.allocationId'
responses:
'200':
description: >-
Upon success, a response body containing data type describing the updated BwInfo is returned.
schema:
required:
- bwInfo
properties:
bwInfo:
$ref: '#/definitions/BwInfo'
'400':
description: It is used to indicate that incorrect parameters were passed to the request. In the returned ProblemDetails structure, the "detail" attribute should convey more information about the error.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: >-
The operation is not allowed given the current status of the resource. More information shall be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: >-
It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the "detail" attribute should convey more information about the error.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'412':
description: >-
It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts. In the returned ProblemDetails structure, the "detail" attribute should convey more information about the error.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
200:
description: "Used to indicate nonspecific success. The response body contains a representation of the resource."
content:
application/json:
schema:
$ref: "#/components/schemas/BwInfo"
400:
$ref: "#/components/responses/400"
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
delete:
description: Remove a specific bandwidthAllocation resource. DELETE method is typically used in "Unregister from Bandwidth Management Service" procedure
produces:
- application/json
tags:
- "bwm"
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: '#/parameters/Path.AllocationId'
- $ref: '#/components/parameters/Path.allocationId'
responses:
'204':
description: No Content
'403':
description: >-
The operation is not allowed given the current status of the resource. More information shall be provided in the "detail" attribute of the "ProblemDetails" structure.
204:
$ref: '#/components/responses/204'
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
components:
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/problem+json:
schema:
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: >-
It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the "detail" attribute should convey more information about the error.
$ref: '#/components/schemas/ProblemDetails'
403:
description: 'Forbidden : operation is not allowed given the current status of the resource.'
content:
application/problem+json:
schema:
$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/problem+json:
schema:
$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/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
parameters:
Path.allocationId:
name: allocationId
in: "path"
description: "Represents a bandwidth allocation instance"
required: true
schema:
type: string
Query.app_instance_id:
name: app_instance_id
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."
required: false
schema:
type: array
items:
type: string
Query.app_name:
name: app_name
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."
required: false
schema:
type: array
items:
type: string
Query.session_id:
name: session_id
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."
required: false
schema:
type: array
items:
type: string
schemas:
BwInfo:
properties:
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
appInsId:
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
requestType:
description: 'Numeric value (0 - 255) corresponding to specific type of consumer as following:
0 = APPLICATION_SPECIFIC_BW_ALLOCATION
1 = SESSION_SPECIFIC_BW_ALLOCATION'
type: integer
enum:
- 0
- 1
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum_inlined
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
items:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
definitions:
ProblemDetails:
type: object
properties:
type:
$ref: '#/definitions/Problem.type'
title:
$ref: '#/definitions/Problem.title'
status:
$ref: '#/definitions/Problem.status'
detail:
$ref: '#/definitions/Problem.detail'
instance:
$ref: '#/definitions/Problem.instance'
Problem.type:
type: string
format: uri
description: >-
A URI reference according to IETF RFC 3986 that identifies the problem
type
Problem.title:
type: string
description: 'A short, human-readable summary of the problem type'
Problem.status:
type: integer
format: uint32
description: The HTTP status code for this occurrence of the problem
Problem.detail:
type: string
description: A human-readable explanation specific to this occurrence of the problem
Problem.instance:
type: string
format: uri
description: A URI reference that identifies the specific occurrence of the problem
BwInfo:
description: information of bandwidth resource
type: object
required:
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: int32
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: int32
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
properties:
timeStamp:
$ref: '#/definitions/TimeStamp'
appInsId:
$ref: '#/definitions/AppInsId'
requestType:
$ref: '#/definitions/RequestType'
sessionFilter:
$ref: '#/definitions/SessionFilter'
fixedBWPriority:
$ref: '#/definitions/FixedBWPriority'
fixedAllocation:
$ref: '#/definitions/FixedAllocation'
allocationDirection:
$ref: '#/definitions/AllocationDirection'
BwInfoDeltas:
description: Conform to JSON merge patch format and processing rules specified IETF RFC 7396 [8], this type represents the attributes whose value are allowed to be updated with HTTP PATCH method in content format JSON
type: object
properties:
appInsId:
$ref: '#/definitions/AppInsId'
requestType:
$ref: '#/definitions/RequestType'
sessionFilter:
$ref: '#/definitions/SessionFilter'
fixedBWPriority:
$ref: '#/definitions/FixedBWPriority'
fixedAllocation:
$ref: '#/definitions/FixedAllocation'
allocationDirection:
$ref: '#/definitions/AllocationDirection'
TimeStamp:
type: object
required:
- seconds
- nanoSeconds
properties:
seconds:
$ref: '#/definitions/Seconds'
nanoSeconds:
$ref: '#/definitions/NanoSeconds'
AppInsId:
description: >-
Application instance identifier
type: string
RequestType:
description: >-
Numeric value (0 - 255) corresponding to specific type of consumer
type: string
enum:
- APPLICATION_SPECIFIC_BW_ALLOCATION
- SESSION_SPECIFIC_BW_ALLOCATION
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
type: array
items:
type: object
x-etsi-ref: 7.2.2
BwInfoDeltas:
properties:
sourceIp:
$ref: '#/definitions/SourceIp'
sourcePort:
$ref: '#/definitions/SourcePort'
dstAddress:
$ref: '#/definitions/DstAddress'
dstPort:
$ref: '#/definitions/DstPort'
protocol:
$ref: '#/definitions/Protocol'
FixedBWPriority:
description: >-
Indicates the allocation priority when dealing with several applications or sessions in parallel. Values are not defined in the present document
type: string
enum:
- not defined in the present document
FixedAllocation:
description: >-
Size of requested fixed BW allocation in [bps]
type: string
AllocationDirection:
description: >-
The direction of the requested BW allocation
type: string
enum:
- 00 = Downlink (towards the UE)
- 01 = Uplink (towards the application/session)
- 10 = Symmetrical
Seconds:
description: >-
The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
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
type: integer
format: uint32
SourceIp:
description: >-
Source address identity of session (including range)
type: string
SourcePort:
description: >-
Source port identity of session
type: array
items:
type: string
DstAddress:
description: >-
Destination address identity of session (including range)
type: string
DstPort:
description: >-
Destination port identity of session
type: array
items:
type: string
Protocol:
description: >-
Protocol number
type: string
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
appInsId:
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
requestType:
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
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
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)
required:
- appInsId
- requestType
type: object
x-etsi-ref: 7.2.3
ProblemDetails:
properties:
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: int32
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
LICENSE
View file @ f87d2918
Copyright 2019 ETSI
Redistribution and use in source and binary forms, with or without
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.
README.md
View file @ f87d2918
......@@ -4,12 +4,14 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E
## Online resources
* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs015-bandwith-mgmt-api/raw/master/BwManagementApi.yaml).
* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs015-bandwith-mgmt-api/raw/master/BwManagementApi.yaml).
* [Navigate the Bandwidth Management API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs015-bandwith-mgmt-api/raw/stf593/BwManagementApi.yaml).
* [Edit the Bandwidth Management API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs015-bandwith-mgmt-api/raw/stf593/BwManagementApi.yaml).
* [Navigate the Traffic Steering API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs015-bandwith-mgmt-api/raw/stf593/TrafficSteeringApi.yaml).
* [Edit the Traffic Steering API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs015-bandwith-mgmt-api/raw/stf593/TrafficSteeringApi.yaml).
## License
Unless specified otherwise, the content of this repository and the files
contained are released under the BSD-3-Clause license.
Unless specified otherwise, the content of this repository and the files contained
are released under the BSD-3-Clause license.
See the attached LICENSE file or visit https://forge.etsi.org/legal-matters.
TrafficSteeringApi.json 0 → 100644
View file @ f87d2918
{
"openapi": "3.0.0",
"info": {
"contact": {
"url": "https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api"
},
"title": "ETSI GS MEC 015 Multi-access Traffic Steering APIs",
"version": "2.1.1",
"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"
}
},
"externalDocs": {
"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"
},
"servers": [
{
"url": "https://localhost/mts/v1"
}
],
"tags": [
{
"name": "mts"
}
],
"paths": {
"/mts_capability_info": {
"get": {
"tags": [
"mts"
],
"summary": "Retrieve the MTS capability informations",
"description": "Used to query information about the MTS information. Typically used in the 'Get MTS service Info from the MTS Service' procedure as described in clause 6.2.6.",
"operationId": "mtsCapabilityInfoGET",
"parameters": [],
"responses": {
"200": {
"description": "Upon success, a response body containing the MTS capability information is returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MtsCapabilityInfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
}
}
},
"/mts_sessions": {
"get": {
"tags": [
"mts"
],
"summary": "Retrieve information about a list of MTS sessions",
"description": "Retrieves information about a list of MTS sessions. Typically used in the 'Get configured MTS Session Info from the MTS Service' procedure as described in clause 6.2.10.",
"operationId": "mtsSessionsListGET",
"parameters": [
{
"$ref": "#/components/parameters/Query.app_instance_id"
},
{
"$ref": "#/components/parameters/Query.app_name"
},
{
"$ref": "#/components/parameters/Query.session_id"
}
],
"responses": {
"200": {
"description": "Upon success, a response body containing an array of the MTS sessions is returned.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MtsSessionInfo"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
}
},
"post": {
"tags": [
"mts"
],
"summary": "Create a MTS session",
"description": "Used to create a MTS session. This method is typically used in 'Register application to the MTS Service' procedure as described in clause 6.2.7.",
"operationId": "mtsSessionPOST",
"parameters": [],
"requestBody": {
"description": "Entity body in the request contains MtsSessionInfo to be created.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MtsSessionInfo"
}
}
}
},
"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": {
"$ref": "#/components/schemas/MtsSessionInfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
}
}
},
"/mts_sessions/{sessionId}": {
"get": {
"tags": [
"mts"
],
"summary": "Retrieve information about specific MTS session",
"description": "Retrieves information about an individual MTS session. Typically used in the 'Get configured MTS Session Info from the MTS Service' procedure as described in clause 6.2.10.",
"operationId": "mtsSessionGET",
"parameters": [
{
"$ref": "#/components/parameters/Path.sessionId"
}
],
"responses": {
"200": {
"description": "Used to indicate nonspecific success. The response body contains a representation of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MtsSessionInfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
}
},
"put": {
"tags": [
"mts"
],
"summary": "Update the information about specific MTS session",
"description": "Updates the information about an individual MTS session. As specified in ETSI GS MEC 009 [6], the PUT HTTP method has 'replace' semantics. ",
"operationId": "mtsSessionPUT",
"parameters": [
{
"$ref": "#/components/parameters/Path.sessionId"
}
],
"requestBody": {
"description": "MtsSessionInfo with updated information is included as entity body of the request.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MtsSessionInfo"
}
}
}
},
"responses": {
"200": {
"description": "Used to indicate nonspecific success. The response body contains a representation of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MtsSessionInfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"412": {
"$ref": "#/components/responses/412"
}
}
},
"delete": {
"tags": [
"mts"
],
"summary": "Remove specific MTS session",
"description": "DELETE method is typically used in 'Unregister from the MTS Service' procedure as described in clause 6.2.8.",
"operationId": "mtsSessionDELETE",
"parameters": [
{
"$ref": "#/components/parameters/Path.sessionId"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
}
}
}
},
"components": {
"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/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/problem+json": {
"schema": {
"$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/problem+json": {
"schema": {
"$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/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"parameters": {
"Path.sessionId": {
"name": "sessionId",
"in": "path",
"description": "Represents a MTS session instance",
"required": true,
"schema": {
"type": "string"
}
},
"Query.app_instance_id": {
"name": "app_instance_id",
"in": "query",
"description": "A MEC application instance may use multiple app_instance_ids as an input parameter to query the MTS session of a list of MEC application instances. See note.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Query.app_name": {
"name": "app_name",
"in": "query",
"description": "A MEC application instance may use multiple app_names as an input parameter to query the MTS session of a list of MEC application instances. See note.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Query.session_id": {
"name": "session_id",
"in": "query",
"description": "A MEC application instance may use session_id as an input parameter to query the information of a list of MTS sessions. See note.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"schemas": {
"MtsCapabilityInfo": {
"properties": {
"mtsAccessInfo": {
"description": "The information on access network connection as defined below",
"items": {
"type": "object",
"properties": {
"accessId": {
"type": "integer",
"format": "int32",
"description": "Unique identifier for the access network connection",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
},
"accessType": {
"type": "integer",
"format": "int32",
"description": "Numeric value (0-255) corresponding to specific type of access network as following: 0 = Unknown 1 = Any IEEE802.11-based WLAN technology 2 = Any 3GPP-based Cellular technology 3 = Any Fixed Access 11 = IEEE802.11 a/b/g WLAN 12 = IEEE 802.11 a/b/g/n WLAN 13 = IEEE 802.11 a/b/g/n/ac WLAN 14 = IEEE 802.11 a/b/g/n/ac/ax WLAN (Wi-Fi 6) 15 = IEEE 802.11 b/g/n WLAN 31 = 3GPP GERAN/UTRA (2G/3G) 32 = 3GPP E-UTRA (4G/LTE) 33 = 3GPP NR (5G)",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
},
"metered": {
"type": "integer",
"format": "int32",
"description": "Numeric value (0-255) corresponding to the following: 0: the connection is not metered (see note) 1: the connection is metered 2: unknown ",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
}
}
},
"required": [
"accessId",
"accessType",
"metered"
],
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"mtsMode": {
"description": "Numeric value corresponding to a specific MTS operation supported by the TMS 0 = low cost, i.e. using the unmetered access network connection whenever it is available 1 = low latency, i.e. using the access network connection with lower latency 2 = high throughput, i.e. using the access network connection with higher throughput, or/and multiple access network connection simultaneously if supported 3 = redundancy, i.e. sending duplicated (redundancy) packets over multiple access network connections for highreliability and low-latency applications 4 = QoS, i.e. performing MTS based on the specific QoS requirements from the app",
"items": {
"type": "integer",
"format": "int32"
},
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "Uint32"
},
"timeStamp": {
"description": "Time stamp to indicate when the corresponding information elements are sent",
"properties": {
"nanoSeconds": {
"type": "integer",
"format": "int32",
"description": "Time in nanoseconds in 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": "int32",
"description": "Time in seconds in Unix-time 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": [
"mtsAccessInfo",
"mtsMode"
],
"type": "object",
"x-etsi-notes": "NOTE:\tA metered connection is a network connection that has a maximum data usage in a specific period, e.g. per hour/day/week/month. The user may get billed extra charges if they go over the allotted amount.",
"x-etsi-ref": "7.2.4"
},
"MtsSessionInfo": {
"properties": {
"appInsId": {
"description": "Application instance identifier",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"flowFilter": {
"description": "Traffic flow filtering criteria, applicable only if when requestType is set as FLOW_SPECIFIC_MTS_SESSION. Any filtering criteria shall define a single session only. In case multiple sessions match flowFilter the request shall be rejected. If the flowFilter field is included, at least one of its subfields shall be included. Any flowFilter subfield that is not included shall be ignored in traffic flow filtering",
"items": {
"type": "object",
"properties": {
"dscp": {
"type": "integer",
"format": "int32",
"description": "DSCP in the IPv4 header or Traffic Class in the IPv6 header",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"dstIp": {
"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": "integer",
"format": "int32"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Uint32"
},
"flowlabel": {
"type": "integer",
"format": "int32",
"description": "Flow Label in the IPv6 header, applicable only if the flow is IPv6",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"protocol": {
"type": "integer",
"format": "int32",
"description": "Protocol number",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"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": "integer",
"format": "int32"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Uint32"
}
}
},
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"mtsMode": {
"type": "integer",
"format": "int32",
"description": "Numeric value (0 - 255) corresponding to a specific MTS mode of the MTS session: 0 = low cost, i.e. using the unmetered access network connection whenever it is available 1 = low latency, i.e. using the access network connection with lower latency 2 = high throughput, i.e. using the access network connection with higher throughput, or multiple access network connection simultaneously 3 = redundancy, i.e. sending duplicated (redundancy) packets over multiple access network connections for high-reliability and low-latency applications 4 = QoS, i.e. performing MTS based on the QoS requirement (qosD)",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
},
"qosD": {
"description": "QoS requirement description of the MTS session, applicable only if mtsMode = 4 (QoS). If the qosD field is included, at least one of its subfields shall be included. Any qosD subfield that is not included shall be ignored in Multi-access Traffic Steering (MTS)",
"properties": {
"maxJitter": {
"description": "tolerable jitter in [10 nanoseconds]",
"type": "integer",
"format": "int32",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"maxLatency": {
"description": "tolerable (one-way) delay in [10 nanoseconds]",
"type": "integer",
"format": "int32",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"maxLoss": {
"description": "tolerable packet loss rate in [1/10^x]",
"type": "integer",
"format": "int32",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"minTpt": {
"description": "minimal throughput in [kbps]",
"type": "integer",
"format": "int32",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"priority": {
"description": "numeric value (0 - 255) corresponding to the traffic priority 0: low; 1: medium; 2: high; 3: critical",
"type": "integer",
"format": "int32",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
}
},
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure"
},
"requestType": {
"description": "Numeric value (0 - 255) corresponding to specific type of consumer as following: 0 = APPLICATION_SPECIFIC_MTS_SESSION 1 = FLOW_SPECIFIC_MTS_SESSION",
"enum": [
0,
1
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum_inlined"
},
"timeStamp": {
"description": "Time stamp to indicate when the corresponding information elements are sent ",
"properties": {
"nanoSeconds": {
"type": "integer",
"format": "int32",
"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": "int32",
"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)"
},
"trafficDirection": {
"description": "The direction of the requested MTS session: 00 = Downlink (towards the UE) 01 = Uplink (towards the application/session) 10 = Symmetrical (see note) ",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
"appInsId",
"requestType",
"flowFilter",
"qosD",
"mtsMode",
"trafficDirection"
],
"type": "object",
"x-etsi-notes": "NOTE:\tFor the downlink direction of a symmetrical flow, \"sourceIp\" and \"sourcePort\" in the \"flowFilter\" structure are used for source address and port, respectively; \"dstIp\" and \"dstPort\" are used for destination address and port, respectively. For the uplink direction of a symmetrical flow, \"sourceIp\" and \"sourcePort\" are used for destination address and port, respectively; \"dstIp\" and \"dstPort\" are used for source address and port, respectively.",
"x-etsi-ref": "7.2.5"
},
"ProblemDetails": {
"properties": {
"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": "int32",
"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"
}
}
}
}
\ No newline at end of file
TrafficSteeringApi.yaml 0 → 100644
View file @ f87d2918
openapi: 3.0.0
info:
contact:
url: https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api
title: 'ETSI GS MEC 015 Multi-access Traffic Steering APIs'
version: 2.1.1
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'
externalDocs:
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'
servers:
- url: 'https://localhost/mts/v1'
tags:
- name: "mts"
paths:
/mts_capability_info:
get:
tags:
- "mts"
summary: "Retrieve the MTS capability informations"
description: "Used to query information about the MTS information. Typically used in the 'Get MTS service Info from the MTS Service' procedure as described in clause 6.2.6."
operationId: "mtsCapabilityInfoGET"
parameters: []
responses:
200:
description: "Upon success, a response body containing the MTS capability information is returned."
content:
application/json:
schema:
$ref: "#/components/schemas/MtsCapabilityInfo"
400:
$ref: "#/components/responses/400"
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
/mts_sessions:
get:
tags:
- "mts"
summary: "Retrieve information about a list of MTS sessions"
description: "Retrieves information about a list of MTS sessions. Typically used in the 'Get configured MTS Session Info from the MTS Service' procedure as described in clause 6.2.10."
operationId: "mtsSessionsListGET"
parameters:
- $ref: '#/components/parameters/Query.app_instance_id'
- $ref: '#/components/parameters/Query.app_name'
- $ref: '#/components/parameters/Query.session_id'
responses:
200:
description: "Upon success, a response body containing an array of the MTS sessions is returned."
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/MtsSessionInfo"
400:
$ref: "#/components/responses/400"
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
post:
tags:
- "mts"
summary: "Create a MTS session"
description: "Used to create a MTS session. This method is typically used in 'Register application to the MTS Service' procedure as described in clause 6.2.7."
operationId: "mtsSessionPOST"
parameters: []
requestBody:
description: "Entity body in the request contains MtsSessionInfo to be created."
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MtsSessionInfo'
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:
$ref: "#/components/schemas/MtsSessionInfo"
400:
$ref: "#/components/responses/400"
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
/mts_sessions/{sessionId}:
get:
tags:
- "mts"
summary: "Retrieve information about specific MTS session"
description: "Retrieves information about an individual MTS session. Typically used in the 'Get configured MTS Session Info from the MTS Service' procedure as described in clause 6.2.10."
operationId: "mtsSessionGET"
parameters:
- $ref: '#/components/parameters/Path.sessionId'
responses:
200:
description: "Used to indicate nonspecific success. The response body contains a representation of the resource."
content:
application/json:
schema:
$ref: "#/components/schemas/MtsSessionInfo"
400:
$ref: "#/components/responses/400"
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
put:
tags:
- "mts"
summary: "Update the information about specific MTS session"
description: "Updates the information about an individual MTS session. As specified in ETSI GS MEC 009 [6], the PUT HTTP method has 'replace' semantics. "
operationId: "mtsSessionPUT"
parameters:
- $ref: '#/components/parameters/Path.sessionId'
requestBody:
description: "MtsSessionInfo with updated information is included as entity body of the request."
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MtsSessionInfo'
responses:
200:
description: "Used to indicate nonspecific success. The response body contains a representation of the resource."
content:
application/json:
schema:
$ref: "#/components/schemas/MtsSessionInfo"
400:
$ref: "#/components/responses/400"
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
delete:
tags:
- "mts"
summary: "Remove specific MTS session"
description: "DELETE method is typically used in 'Unregister from the MTS Service' procedure as described in clause 6.2.8."
operationId: "mtsSessionDELETE"
parameters:
- $ref: '#/components/parameters/Path.sessionId'
responses:
204:
$ref: '#/components/responses/204'
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
components:
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/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
403:
description: 'Forbidden : operation is not allowed given the current status of the resource.'
content:
application/problem+json:
schema:
$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/problem+json:
schema:
$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/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
parameters:
Path.sessionId:
name: sessionId
in: "path"
description: "Represents a MTS session instance"
required: true
schema:
type: string
Query.app_instance_id:
name: app_instance_id
in: "query"
description: "A MEC application instance may use multiple app_instance_ids as an input parameter to query the MTS session of a list of MEC application instances. See note."
required: false
schema:
type: array
items:
type: string
Query.app_name:
name: app_name
in: "query"
description: "A MEC application instance may use multiple app_names as an input parameter to query the MTS session of a list of MEC application instances. See note."
required: false
schema:
type: array
items:
type: string
Query.session_id:
name: session_id
in: "query"
description: "A MEC application instance may use session_id as an input parameter to query the information of a list of MTS sessions. See note."
required: false
schema:
type: array
items:
type: string
schemas:
MtsCapabilityInfo:
properties:
mtsAccessInfo:
description: The information on access network connection as defined below
items:
type: object
properties:
accessId:
type: integer
format: int32
description: Unique identifier for the access network connection
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uint32
accessType:
type: integer
format: int32
description: "Numeric value (0-255) corresponding to specific type of access network as following:
0 = Unknown
1 = Any IEEE802.11-based WLAN technology
2 = Any 3GPP-based Cellular technology
3 = Any Fixed Access
11 = IEEE802.11 a/b/g WLAN
12 = IEEE 802.11 a/b/g/n WLAN
13 = IEEE 802.11 a/b/g/n/ac WLAN
14 = IEEE 802.11 a/b/g/n/ac/ax WLAN (Wi-Fi 6)
15 = IEEE 802.11 b/g/n WLAN
31 = 3GPP GERAN/UTRA (2G/3G)
32 = 3GPP E-UTRA (4G/LTE)
33 = 3GPP NR (5G)"
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uint32
metered:
type: integer
format: int32
description: 'Numeric value (0-255) corresponding to the following:
0: the connection is not metered (see note)
1: the connection is metered
2: unknown '
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uint32
required:
- accessId
- accessType
- metered
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Structure (inlined)
mtsMode:
description: 'Numeric value corresponding to a specific MTS operation supported by the TMS
0 = low cost, i.e. using the unmetered access network connection whenever it is available
1 = low latency, i.e. using the access network connection with lower latency
2 = high throughput, i.e. using the access network connection with higher throughput, or/and multiple access network connection simultaneously if supported
3 = redundancy, i.e. sending duplicated (redundancy) packets over multiple access network connections for highreliability and low-latency applications
4 = QoS, i.e. performing MTS based on the specific QoS requirements from the app'
items:
type: integer
format: int32
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Uint32
timeStamp:
description: Time stamp to indicate when the corresponding information elements are sent
properties:
nanoSeconds:
type: integer
format: int32
description: Time in nanoseconds in 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: int32
description: Time in seconds in Unix-time 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:
- mtsAccessInfo
- mtsMode
type: object
x-etsi-notes: "NOTE:\tA metered connection is a network connection that has\
\ a maximum data usage in a specific period, e.g. per hour/day/week/month.\
\ The user may get billed extra charges if they go over the allotted amount."
x-etsi-ref: 7.2.4
MtsSessionInfo:
properties:
appInsId:
description: Application instance identifier
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
flowFilter:
description: Traffic flow filtering criteria, applicable only if when requestType is set as FLOW_SPECIFIC_MTS_SESSION. Any filtering criteria shall define a single session only. In case multiple sessions match flowFilter the request shall be rejected. If the flowFilter field is included, at least one of its subfields shall be included. Any flowFilter subfield that is not included shall be ignored in traffic flow filtering
items:
type: object
properties:
dscp:
type: integer
format: int32
description: DSCP in the IPv4 header or Traffic Class in the IPv6 header
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uint32
dstIp:
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: integer
format: int32
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Uint32
flowlabel:
type: integer
format: int32
description: Flow Label in the IPv6 header, applicable only if the flow is IPv6
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uint32
protocol:
type: integer
format: int32
description: Protocol number
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uint32
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: integer
format: int32
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Uint32
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Structure (inlined)
mtsMode:
type: integer
format: int32
description: 'Numeric value (0 - 255) corresponding to a specific MTS mode of the MTS session:
0 = low cost, i.e. using the unmetered access network connection whenever it is available
1 = low latency, i.e. using the access network connection with lower latency
2 = high throughput, i.e. using the access network connection with higher throughput, or multiple access network connection simultaneously
3 = redundancy, i.e. sending duplicated (redundancy) packets over multiple access network connections for high-reliability and low-latency applications
4 = QoS, i.e. performing MTS based on the QoS requirement (qosD)'
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uint32
qosD:
description: QoS requirement description of the MTS session, applicable only if mtsMode = 4 (QoS). If the qosD field is included, at least one of its subfields shall be included. Any qosD subfield that is not included shall be ignored in Multi-access Traffic Steering (MTS)
properties:
maxJitter:
description: tolerable jitter in [10 nanoseconds]
type: integer
format: int32
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uint32
maxLatency:
description: tolerable (one-way) delay in [10 nanoseconds]
type: integer
format: int32
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uint32
maxLoss:
description: tolerable packet loss rate in [1/10^x]
type: integer
format: int32
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uint32
minTpt:
description: minimal throughput in [kbps]
type: integer
format: int32
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uint32
priority:
description: "numeric value (0 - 255) corresponding to the traffic priority 0: low; 1: medium; 2: high; 3: critical"
type: integer
format: int32
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uint32
type: object
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Structure
requestType:
description: 'Numeric value (0 - 255) corresponding to specific type of consumer as following:
0 = APPLICATION_SPECIFIC_MTS_SESSION
1 = FLOW_SPECIFIC_MTS_SESSION'
enum:
- 0
- 1
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum_inlined
timeStamp:
description: 'Time stamp to indicate when the corresponding information elements are sent '
properties:
nanoSeconds:
type: integer
format: int32
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: int32
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)
trafficDirection:
description: 'The direction of the requested MTS session:
00 = Downlink (towards the UE)
01 = Uplink (towards the application/session)
10 = Symmetrical (see note) '
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
required:
- appInsId
- requestType
- flowFilter
- qosD
- mtsMode
- trafficDirection
type: object
x-etsi-notes: "NOTE:\tFor the downlink direction of a symmetrical flow, \"sourceIp\"\
\ and \"sourcePort\" in the \"flowFilter\" structure are used for source address\
\ and port, respectively; \"dstIp\" and \"dstPort\" are used for destination\
\ address and port, respectively. For the uplink direction of a symmetrical\
\ flow, \"sourceIp\" and \"sourcePort\" are used for destination address and\
\ port, respectively; \"dstIp\" and \"dstPort\" are used for source address\
\ and port, respectively."
x-etsi-ref: 7.2.5
ProblemDetails:
properties:
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: int32
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