diff --git a/BwManagementApi.json b/BwManagementApi.json index ed86481eadf924874d776a125a426ed53bca9bb7..01dcb255ee83df2dbc707b4ebc27623d4ff0cbf6 100644 --- a/BwManagementApi.json +++ b/BwManagementApi.json @@ -1,5 +1,5 @@ { - "openapi": "3.0.0", + "openapi": "3.1.0", "info": { "contact": { "url": "https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api" @@ -29,9 +29,7 @@ "paths": { "/bw_allocations": { "get": { - "tags": [ - "bwm" - ], + "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", @@ -72,9 +70,7 @@ } }, "post": { - "tags": [ - "bwm" - ], + "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", @@ -115,9 +111,7 @@ }, "/bw_allocations/{allocationId}": { "get": { - "tags": [ - "bwm" - ], + "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", @@ -149,9 +143,7 @@ } }, "put": { - "tags": [ - "bwm" - ], + "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", @@ -197,9 +189,7 @@ } }, "patch": { - "tags": [ - "bwm" - ], + "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", @@ -245,9 +235,7 @@ } }, "delete": { - "tags": [ - "bwm" - ], + "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", @@ -386,9 +374,7 @@ }, "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" - ], + "enum": ["SEE_DESCRIPTION"], "type": "string", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Enum" @@ -396,10 +382,7 @@ "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 - ], + "enum": [0, 1], "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Enum_inlined" }, @@ -471,10 +454,7 @@ "x-etsi-mec-origin-type": "Uint32" } }, - "required": [ - "seconds", - "nanoSeconds" - ], + "required": ["seconds", "nanoSeconds"], "type": "object", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Structure (inlined)" @@ -511,20 +491,15 @@ }, "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" - ], + "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 - ], + "type": "integer", + "enum": [0, 1], "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Enum_inlined" }, @@ -579,10 +554,7 @@ "x-etsi-mec-origin-type": "Structure (inlined)" } }, - "required": [ - "appInsId", - "requestType" - ], + "required": ["appInsId", "requestType"], "type": "object", "x-etsi-ref": "7.2.3" }, @@ -626,4 +598,4 @@ } } } -} \ No newline at end of file +} diff --git a/BwManagementApi.yaml b/BwManagementApi.yaml index c579c72158ac3564b2ca9383e4c4cfa8479b133c..6392a968651de62ad8d1794f1560ae4d2ecf7610 100644 --- a/BwManagementApi.yaml +++ b/BwManagementApi.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.0 +openapi: 3.1.0 info: contact: url: https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api @@ -32,7 +32,7 @@ paths: - $ref: '#/components/parameters/Query.app_name' - $ref: '#/components/parameters/Query.session_id' responses: - 200: + "200": description: "Upon success, a response body containing an array of the bandwidthAllocations is returned." content: application/json: @@ -40,11 +40,11 @@ paths: type: array items: $ref: "#/components/schemas/BwInfo" - 400: + "400": $ref: "#/components/responses/400" - 403: + "403": $ref: '#/components/responses/403' - 404: + "404": $ref: '#/components/responses/404' post: tags: @@ -61,17 +61,17 @@ paths: schema: $ref: '#/components/schemas/BwInfo' responses: - 201: + "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: + "400": $ref: "#/components/responses/400" - 403: + "403": $ref: '#/components/responses/403' - 404: + "404": $ref: '#/components/responses/404' /bw_allocations/{allocationId}: get: @@ -83,17 +83,17 @@ paths: parameters: - $ref: '#/components/parameters/Path.allocationId' responses: - 200: + "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: + "400": $ref: "#/components/responses/400" - 403: + "403": $ref: '#/components/responses/403' - 404: + "404": $ref: '#/components/responses/404' put: tags: @@ -111,19 +111,19 @@ paths: parameters: - $ref: '#/components/parameters/Path.allocationId' responses: - 200: + "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: + "400": $ref: "#/components/responses/400" - 403: + "403": $ref: '#/components/responses/403' - 404: + "404": $ref: '#/components/responses/404' - 412: + "412": $ref: '#/components/responses/412' patch: tags: @@ -141,19 +141,19 @@ paths: parameters: - $ref: '#/components/parameters/Path.allocationId' responses: - 200: + "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: + "400": $ref: "#/components/responses/400" - 403: + "403": $ref: '#/components/responses/403' - 404: + "404": $ref: '#/components/responses/404' - 412: + "412": $ref: '#/components/responses/412' delete: tags: @@ -164,35 +164,35 @@ paths: parameters: - $ref: '#/components/parameters/Path.allocationId' responses: - 204: + "204": $ref: '#/components/responses/204' - 403: + "403": $ref: '#/components/responses/403' - 404: + "404": $ref: '#/components/responses/404' components: responses: - 204: + "204": description: "Upon success, a response 204 No Content without any response body is returned." - 400: + "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: + "403": description: 'Forbidden : operation is not allowed given the current status of the resource.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' - 404: + "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: + "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: @@ -371,7 +371,7 @@ components: 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 + type: integer enum: - 0 - 1 diff --git a/README.md b/README.md index 86d0f3ffb06808223181b17a96c979a815c9be71..ba46250bada727abe797c670eda1f3a55daec6a5 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E ## Online resources -* [Navigate the Bandwidth Management API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api/raw/v2.1.1/BwManagementApi.yaml). -* [Edit the Bandwidth Management API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api/raw/v2.1.1/BwManagementApi.yaml). +* [Navigate the Bandwidth Management API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api/raw/stf606-final/BwManagementApi.yaml). +* [Edit the Bandwidth Management API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api/raw/stf606-final/BwManagementApi.yaml). -* [Navigate the Traffic Steering API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api/raw/v2.1.1/TrafficSteeringApi.yaml). -* [Edit the Traffic Steering API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api/raw/v2.1.1/TrafficSteeringApi.yaml). +* [Navigate the Traffic Steering API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api/raw/stf606-final/TrafficSteeringApi.yaml). +* [Edit the Traffic Steering API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api/raw/stf606-final/TrafficSteeringApi.yaml). ## License diff --git a/TrafficSteeringApi.json b/TrafficSteeringApi.json index d58fb710965728b1c36e6037dd38b14c6944a9b6..057c721eaa413b3bacee51fb483939e777514779 100644 --- a/TrafficSteeringApi.json +++ b/TrafficSteeringApi.json @@ -1,5 +1,5 @@ { - "openapi": "3.0.0", + "openapi": "3.1.0", "info": { "contact": { "url": "https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api" @@ -29,9 +29,7 @@ "paths": { "/mts_capability_info": { "get": { - "tags": [ - "mts" - ], + "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", @@ -61,9 +59,7 @@ }, "/mts_sessions": { "get": { - "tags": [ - "mts" - ], + "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", @@ -104,9 +100,7 @@ } }, "post": { - "tags": [ - "mts" - ], + "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", @@ -147,9 +141,7 @@ }, "/mts_sessions/{sessionId}": { "get": { - "tags": [ - "mts" - ], + "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", @@ -181,9 +173,7 @@ } }, "put": { - "tags": [ - "mts" - ], + "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", @@ -229,9 +219,7 @@ } }, "delete": { - "tags": [ - "mts" - ], + "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", @@ -378,11 +366,7 @@ } } }, - "required": [ - "accessId", - "accessType", - "metered" - ], + "required": ["accessId", "accessType", "metered"], "minItems": 1, "type": "array", "x-etsi-mec-cardinality": "1..N", @@ -417,19 +401,13 @@ "x-etsi-mec-origin-type": "Uint32" } }, - "required": [ - "seconds", - "nanoSeconds" - ], + "required": ["seconds", "nanoSeconds"], "type": "object", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Structure (inlined)" } }, - "required": [ - "mtsAccessInfo", - "mtsMode" - ], + "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" @@ -561,10 +539,7 @@ }, "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 - ], + "enum": [0, 1], "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Enum_inlined" @@ -587,10 +562,7 @@ "x-etsi-mec-origin-type": "Uint32" } }, - "required": [ - "seconds", - "nanoSeconds" - ], + "required": ["seconds", "nanoSeconds"], "type": "object", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Structure (inlined)" @@ -654,4 +626,4 @@ } } } -} \ No newline at end of file +} diff --git a/TrafficSteeringApi.yaml b/TrafficSteeringApi.yaml index 0f5237c5fe551a0c10a0293992d68c85a2f73938..7d898fe3f3a269d32c93a74367b0681d14a5b7b7 100644 --- a/TrafficSteeringApi.yaml +++ b/TrafficSteeringApi.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.0 +openapi: 3.1.0 info: contact: url: https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api @@ -29,17 +29,17 @@ paths: operationId: "mtsCapabilityInfoGET" parameters: [] responses: - 200: + "200": description: "Upon success, a response body containing the MTS capability information is returned." content: application/json: schema: $ref: "#/components/schemas/MtsCapabilityInfo" - 400: + "400": $ref: "#/components/responses/400" - 403: + "403": $ref: '#/components/responses/403' - 404: + "404": $ref: '#/components/responses/404' /mts_sessions: get: @@ -53,7 +53,7 @@ paths: - $ref: '#/components/parameters/Query.app_name' - $ref: '#/components/parameters/Query.session_id' responses: - 200: + "200": description: "Upon success, a response body containing an array of the MTS sessions is returned." content: application/json: @@ -61,11 +61,11 @@ paths: type: array items: $ref: "#/components/schemas/MtsSessionInfo" - 400: + "400": $ref: "#/components/responses/400" - 403: + "403": $ref: '#/components/responses/403' - 404: + "404": $ref: '#/components/responses/404' post: tags: @@ -82,17 +82,17 @@ paths: schema: $ref: '#/components/schemas/MtsSessionInfo' responses: - 201: + "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: + "400": $ref: "#/components/responses/400" - 403: + "403": $ref: '#/components/responses/403' - 404: + "404": $ref: '#/components/responses/404' /mts_sessions/{sessionId}: get: @@ -104,17 +104,17 @@ paths: parameters: - $ref: '#/components/parameters/Path.sessionId' responses: - 200: + "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: + "400": $ref: "#/components/responses/400" - 403: + "403": $ref: '#/components/responses/403' - 404: + "404": $ref: '#/components/responses/404' put: tags: @@ -132,19 +132,19 @@ paths: schema: $ref: '#/components/schemas/MtsSessionInfo' responses: - 200: + "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: + "400": $ref: "#/components/responses/400" - 403: + "403": $ref: '#/components/responses/403' - 404: + "404": $ref: '#/components/responses/404' - 412: + "412": $ref: '#/components/responses/412' delete: tags: @@ -155,35 +155,35 @@ paths: parameters: - $ref: '#/components/parameters/Path.sessionId' responses: - 204: + "204": $ref: '#/components/responses/204' - 403: + "403": $ref: '#/components/responses/403' - 404: + "404": $ref: '#/components/responses/404' components: responses: - 204: + "204": description: "Upon success, a response 204 No Content without any response body is returned." - 400: + "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: + "403": description: 'Forbidden : operation is not allowed given the current status of the resource.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' - 404: + "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: + "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: