Skip to content

GitLab

Commit 45334f00 authored by Michel Roy's avatar Michel Roy
Browse files

added v2.1.1 draft versions

parent 4d94451a
Pipeline #4985 failed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
Showing with 2203 additions and 919 deletions
BwManagementApi.json
View file @ 45334f00
{
"openapi": "3.0.2",
"openapi": "3.0.0",
"info": {
"description": "The ETSI MEC ISG MEC015 Bandwidth Management API described using OpenAPI",
"version": "1.1.1",
"title": "BWM 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"
},
"contact": {
"email": "cti_support@etsi.org"
}
},
"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"
"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": "http://127.0.0.1:8081/bwm/v1"
},
{
"url": "https://127.0.0.1:8081/bwm/v1"
}
],
"security": [
{
"OauthSecurity": [
"all"
]
}
],
"tags": [
{
"name": "BandwithAllocation"
},
{
"name": "BandwithAllocations"
"url": "https://{apiRoot}/bwm/v1"
}
],
"paths": {
"/bw_allocations": {
"get": {
"description": "This method retrieves information about a list of bandwidthAllocation resources. In queries, either \"app_instance_id\" or \"app_name\" or \"session_Id\" or none of them shall be present.",
"tags": [
""
],
"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.AppInstanceId"
"$ref": "#/components/parameters/Query.app_instance_id"
},
{
"$ref": "#/components/parameters/Query.AppName"
"$ref": "#/components/parameters/Query.app_name"
},
{
"$ref": "#/components/parameters/Query.SessionId"
"$ref": "#/components/parameters/Query.session_id"
}
],
"operationId": "BandwithAllocations_GET",
"tags": [
"BandwithAllocations"
],
"responses": {
"200": {
"$ref": "#/components/responses/BandwithAllocations"
"description": "Upon success, a response body containing an array of the bandwidthAllocations is returned.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bwInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BwInfo"
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/Error.400"
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/Error.403"
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/Error.404"
"$ref": "#/components/responses/404"
}
}
},
"post": {
"description": "This method is used to create a bandwidthAllocation resource.",
"requestBody": {
"$ref": "#/components/requestBodies/BwInfo"
},
"operationId": "BandwithAllocations_POST",
"tags": [
"BandwithAllocations"
""
],
"summary": "Create a bandwidthAllocation resource",
"description": "Used to create a bandwidthAllocation resource. Typically used in 'Register to Bandwidth Management Service' procedure as described in clause 6.2.1.",
"operationId": "bandwidthAllocationPOST",
"parameters": [],
"requestBody": {
"description": "Entity body in the request contains BwInfo to be created.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bwInfo": {
"$ref": "#/components/schemas/BwInfo"
}
}
}
}
}
},
"responses": {
"201": {
"$ref": "#/components/responses/BandwithAllocation.201"
"description": "Upon success, the HTTP response shall include a 'Location' HTTP header that contains the resource URI of the created resource.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"bwInfo"
],
"properties": {
"bwInfo": {
"$ref": "#/components/schemas/BwInfo"
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/Error.400"
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/Error.403"
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/Error.404"
"$ref": "#/components/responses/404"
}
}
}
},
"/bw_allocations/{allocationId}": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AllocationId"
}
],
"get": {
"description": "This method retrieves information about a specific bandwidthAllocation resource.",
"operationId": "BandwithAllocation_GET",
"tags": [
"BandwithAllocation"
""
],
"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": {
"$ref": "#/components/responses/BandwithAllocation"
"description": "Used to indicate nonspecific success. The response body contains a representation of the resource.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"bwInfo"
],
"properties": {
"bwInfo": {
"$ref": "#/components/schemas/BwInfo"
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/Error.400"
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/Error.403"
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/Error.404"
"$ref": "#/components/responses/404"
}
}
},
"put": {
"description": "This method updates the information about a specific bandwidthAllocation resource.",
"tags": [
""
],
"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": {
"$ref": "#/components/requestBodies/BwInfo"
"description": "BwInfo with updated information is included as entity body of the request.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bwInfo": {
"$ref": "#/components/schemas/BwInfo"
}
}
}
}
}
},
"operationId": "BandwithAllocation_PUT",
"tags": [
"BandwithAllocation"
"parameters": [
{
"$ref": "#/components/parameters/Path.allocationId"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/BandwithAllocation"
"description": "Used to indicate nonspecific success. The response body contains a representation of the resource.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"bwInfo"
],
"properties": {
"bwInfo": {
"$ref": "#/components/schemas/BwInfo"
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/Error.400"
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/Error.403"
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/Error.404"
"$ref": "#/components/responses/404"
},
"412": {
"$ref": "#/components/responses/Error.412"
"$ref": "#/components/responses/412"
}
}
},
"patch": {
"description": "This method updates the information about a specific bandwidthAllocation resource.",
"tags": [
""
],
"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": {
"$ref": "#/components/requestBodies/BwInfoDeltas"
"description": "Description of the changes to instruct the server how to modify the resource representation.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bwInfoDeltas": {
"$ref": "#/components/schemas/BwInfoDeltas"
}
}
}
}
}
},
"operationId": "BandwithAllocation_PAT",
"tags": [
"BandwithAllocation"
"parameters": [
{
"$ref": "#/components/parameters/Path.allocationId"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/BandwithAllocation"
"description": "Used to indicate nonspecific success. The response body contains a representation of the resource.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"bwInfo"
],
"properties": {
"bwInfo": {
"$ref": "#/components/schemas/BwInfo"
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/Error.400"
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/Error.403"
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/Error.404"
"$ref": "#/components/responses/404"
},
"412": {
"$ref": "#/components/responses/Error.412"
"$ref": "#/components/responses/412"
}
}
},
"delete": {
"description": "Remove a specific bandwidthAllocation resource. DELETE method is typically used in \"Unregister from Bandwidth Management Service\" procedure",
"operationId": "BandwithAllocation_DEL",
"tags": [
"BandwithAllocation"
""
],
"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": {
"description": "No Content"
"$ref": "#/components/responses/204"
},
"403": {
"$ref": "#/components/responses/Error.403"
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/Error.404"
"$ref": "#/components/responses/404"
}
}
}
}
},
"components": {
"parameters": {
"Path.AllocationId": {
"name": "allocationId",
"in": "path",
"description": "Represents a bandwidth allocation instance",
"required": true,
"schema": {
"type": "string"
}
},
"Query.AppInstanceId": {
"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 mobile edge application instances.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Query.AppName": {
"name": "app_name",
"in": "query",
"description": "A MEC 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,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Query.SessionId": {
"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.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"requestBodies": {
"BwInfo": {
"description": "Bandwidth Allocation information",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BwInfo"
}
}
}
"responses": {
"204": {
"description": "Upon success, a response 204 No Content without any response body is returned."
},
"BwInfoDeltas": {
"description": "Description of the changes to instruct the server how to modify the Bandwidth Allocation information.",
"required": true,
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BwInfoDeltas"
"type": "object",
"properties": {
"problemDetails": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"links": {
"GetBandwithAllocation": {
"operationId": "BandwithAllocation_GET",
"description": "The `allocationId` value returned in the response can be used as the `allocationId` parameter in 'GET .../bw_allocations/{allocationId}''",
"parameters": {
"description": "regex = \\/bwm\\/v1\\/bw_allocations\\/(.*); allocationId = location.match(regex)[1]; where \"location\" is the location header uri returned from operationId BandwithAllocations_POST ",
"allocationId": "TBC"
}
},
"PatBandwithAllocation": {
"operationId": "BandwithAllocation_PAT",
"description": "The `allocationId` value returned in the response can be used as the `allocationId` parameter in 'PATCH .../bw_allocations/{allocationId}''",
"parameters": {
"description": "regex = \\/bwm\\/v1\\/bw_allocations\\/(.*); allocationId = location.match(regex)[1]; where \"location\" is the location header uri returned from operationId BandwithAllocations_POST ",
"allocationId": "TBC"
}
},
"PutBandwithAllocation": {
"operationId": "BandwithAllocation_PUT",
"description": "The `allocationId` value returned in the response can be used as the `allocationId` parameter in 'PUT .../bw_allocations/{allocationId}''",
"parameters": {
"description": "regex = \\/bwm\\/v1\\/bw_allocations\\/(.*); allocationId = location.match(regex)[1]; where \"location\" is the location header uri returned from operationId BandwithAllocations_POST ",
"allocationId": "TBC"
}
},
"DelBandwithAllocation": {
"operationId": "BandwithAllocation_DEL",
"description": "The `allocationId` value returned in the response can be used as the `allocationId` parameter in 'DELETE .../bw_allocations/{allocationId}''",
"parameters": {
"description": "regex = \\/bwm\\/v1\\/bw_allocations\\/(.*); allocationId = location.match(regex)[1]; where \"location\" is the location header uri returned from operationId BandwithAllocations_POST ",
"allocationId": "TBC"
}
}
},
"responses": {
"BandwithAllocation": {
"description": "Bandwidth Allocation.",
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BwInfo"
"type": "object",
"required": [
"problemDetails"
],
"properties": {
"problemDetails": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
},
"BandwithAllocation.201": {
"description": "Bandwidth Allocation.",
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BwInfo"
}
}
},
"headers": {
"location": {
"description": "The resource URI of the created resource",
"schema": {
"type": "string",
"format": "uri"
"type": "object",
"properties": {
"problemDetails": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
},
"BandwithAllocations": {
"description": "Bandwidth Allocations.",
"412": {
"description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
"content": {
"application/json": {
"schema": {
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/components/schemas/BwInfo"
"type": "object",
"properties": {
"problemDetails": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"links": {
"getBandwithAllocation": {
"$ref": "#/components/links/GetBandwithAllocation"
},
"patBandwithAllocation": {
"$ref": "#/components/links/PatBandwithAllocation"
},
"putBandwithAllocation": {
"$ref": "#/components/links/PutBandwithAllocation"
},
"delBandwithAllocation": {
"$ref": "#/components/links/DelBandwithAllocation"
}
}
},
"Error.400": {
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Empty"
}