"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"
}
}
}
},
"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"
}
}
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/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.",
"schema":{
"properties":{
"ProblemDetails":{
"$ref":"#/definitions/ProblemDetails"
}
}
}
}
}
},
"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"
}
}
}
}
}
},
"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.",
