Commit dd5be0f6 authored by Muhammad Hamza's avatar Muhammad Hamza
Browse files

update BWM API OAS and Json to v2.2.1

parent 5bda1a5d
Loading
Loading
Loading
Loading
+36 −12
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@
      "url": "https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api"
    },
    "title": "ETSI GS MEC 015 Bandwidth Management API",
    "version": "2.1.1",
    "version": "2.2.1",
    "description": "The ETSI MEC ISG Bandwidth Management API described using OpenAPI.",
    "license": {
      "name": "BSD-3-Clause",
@@ -13,8 +13,8 @@
    }
  },
  "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"
    "description": "ETSI GS MEC015 V2.2.1 Traffic Management APIs",
    "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/015/02.02.01_60/gs_MEC015v020201p.pdf"
  },
  "servers": [
    {
@@ -317,7 +317,7 @@
      "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.",
        "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. app_instance_id corresponds to appInsId defined in table 7.2.2-1. See note.",
        "required": false,
        "schema": {
          "type": "array",
@@ -329,7 +329,7 @@
      "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.",
        "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. app_name corresponds to appName defined in table 7.2.2-1. See note.",
        "required": false,
        "schema": {
          "type": "array",
@@ -341,7 +341,7 @@
      "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.",
        "description": "A MEC application instance may use session_id as an input parameter to query the bandwidth allocation of a list of sessions. session_id corresponds to allocationId defined in table 7.2.2-1. See note.",
        "required": false,
        "schema": {
          "type": "array",
@@ -353,7 +353,20 @@
    },
    "schemas": {
      "BwInfo": {
        "title": "BwInfo",
        "properties": {
          "allocationId": {
            "description": "Bandwidth allocation instance identifier",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "appName": {
            "description": "Name of the application",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-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",
@@ -387,12 +400,13 @@
            "x-etsi-mec-origin-type": "Enum_inlined"
          },
          "sessionFilter": {
            "title": "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)",
                  "description": "Destination address identity of session. The string for an  IPv4 address shall be formatted in the \"dotted decimal\" notation as defined in IETF RFC 1166 [10]. The string for an IPv6 address shall be formatted according to clause 4 of IETF RFC 5952 [11], with in CIDR notation [12] used to provide the routing prefix",
                  "type": "string",
                  "x-etsi-mec-cardinality": "0..1",
                  "x-etsi-mec-origin-type": "String"
@@ -414,7 +428,7 @@
                  "x-etsi-mec-origin-type": "String"
                },
                "sourceIp": {
                  "description": "Source address identity of session (including range)",
                  "description": "Source address identity of session. The string for an IPv4 address shall be formatted in the \"dotted decimal\" notation as defined in IETF RFC 1166 [10]. The string for an IPv6 address shall be formatted according to clause 4 of IETF RFC 5952 [11], with in CIDR notation [12] used to provide the routing prefix",
                  "type": "string",
                  "x-etsi-mec-cardinality": "0..1",
                  "x-etsi-mec-origin-type": "String"
@@ -437,6 +451,7 @@
            "x-etsi-mec-origin-type": "Structure (inlined)"
          },
          "timeStamp": {
            "title": "timeStamp",
            "description": "Time stamp to indicate when the corresponding information elements are sent",
            "properties": {
              "nanoSeconds": {
@@ -470,7 +485,14 @@
        "x-etsi-ref": "7.2.2"
      },
      "BwInfoDeltas": {
        "title": "BwInfoDeltas",
        "properties": {
          "allocationId": {
            "description": "Bandwidth allocation instance identifier",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-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",
@@ -504,12 +526,13 @@
            "x-etsi-mec-origin-type": "Enum_inlined"
          },
          "sessionFilter": {
            "title": "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)",
                  "description": "Destination address identity of session. The string for an IPv4 address shall be formatted in the \"dotted decimal\" notation as defined in IETF RFC 1166 [10]. The string for an IPv6 address shall be formatted according to clause 4 of IETF RFC 5952 [11], with in CIDR notation [12] used to provide the routing prefix",
                  "type": "string",
                  "x-etsi-mec-cardinality": "0..1",
                  "x-etsi-mec-origin-type": "String"
@@ -531,7 +554,7 @@
                  "x-etsi-mec-origin-type": "String"
                },
                "sourceIp": {
                  "description": "Source address identity of session (including range)",
                  "description": "Source address identity of session. The string for an IPv4 address shall be formatted in the \"dotted decimal\" notation as defined in IETF RFC 1166 [10]. The string for an IPv6 address shall be formatted according to clause 4 of IETF RFC 5952 [11], with in CIDR notation [12] used to provide the routing prefix",
                  "type": "string",
                  "x-etsi-mec-cardinality": "0..1",
                  "x-etsi-mec-origin-type": "String"
@@ -554,11 +577,12 @@
            "x-etsi-mec-origin-type": "Structure (inlined)"
          }
        },
        "required": ["appInsId", "requestType"],
        "required": ["allocationId", "appInsId", "requestType"],
        "type": "object",
        "x-etsi-ref": "7.2.3"
      },
      "ProblemDetails": {
        "title": "ProblemDetails",
        "properties": {
          "detail": {
            "description": "A human-readable explanation specific to this occurrence of the problem",
+45 −11
Original line number Diff line number Diff line
@@ -3,15 +3,15 @@ info:
  contact:
    url: https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api
  title: 'ETSI GS MEC 015 Bandwidth Management API'
  version: 2.1.1
  version: 2.2.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'
  description: ETSI GS MEC015 V2.2.1 Traffic Management APIs
  url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/015/02.02.01_60/gs_MEC015v020201p.pdf'

servers:
  - url: 'https://localhost/bwm/v1'
@@ -210,7 +210,7 @@ components:
    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."
      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. app_instance_id corresponds to appInsId defined in table 7.2.2-1. See note."
      required: false
      schema:
        type: array
@@ -219,7 +219,7 @@ components:
    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."
      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. app_name corresponds to appName defined in table 7.2.2-1. See note."
      required: false
      schema:
        type: array
@@ -228,7 +228,7 @@ components:
    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."
      description: "A MEC application instance may use session_id as an input parameter to query the bandwidth allocation of a list of sessions. session_id corresponds to allocationId defined in table 7.2.2-1. See note."
      required: false
      schema:
        type: array
@@ -236,7 +236,18 @@ components:
          type: string
  schemas:
    BwInfo:
      title: BwInfo
      properties:
        allocationId:
          description: Bandwidth allocation instance identifier
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        appName:
          description: Name of the application 
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        allocationDirection:
          description: 'The direction of the requested BW allocation:
            00 = Downlink (towards the UE)
@@ -273,12 +284,16 @@ components:
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Enum_inlined
        sessionFilter:
          title: 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)
                description: Destination address identity of session. The string for an  IPv4 address shall
                  be formatted in the "dotted decimal" notation as defined in IETF RFC 1166 [10]. The string
                  for an IPv6 address shall be formatted according to clause 4 of IETF RFC 5952 [11], with in
                  CIDR notation [12] used to provide the routing prefix 
                type: string
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: String
@@ -296,7 +311,10 @@ components:
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: String
              sourceIp:
                description: Source address identity of session (including range)
                description: Source address identity of session. The string for an IPv4 address shall be
                  formatted in the "dotted decimal" notation as defined in IETF RFC 1166 [10]. The string for 
                  an IPv6 address shall be formatted according to clause 4 of IETF RFC 5952 [11], with in CIDR
                  notation [12] used to provide the routing prefix
                type: string
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: String
@@ -313,6 +331,7 @@ components:
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Structure (inlined)
        timeStamp:
          title: timeStamp
          description: Time stamp to indicate when the corresponding information elements are sent
          properties:
            nanoSeconds:
@@ -341,7 +360,13 @@ components:
      type: object
      x-etsi-ref: 7.2.2
    BwInfoDeltas:
      title: BwInfoDeltas
      properties:
        allocationId:
          description: Bandwidth allocation instance identifier
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        allocationDirection:
          description: 'The direction of the requested BW allocation:
            00 = Downlink (towards the UE)
@@ -378,12 +403,16 @@ components:
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Enum_inlined
        sessionFilter:
          title: 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)
                description: Destination address identity of session. The string for an IPv4 address shall
                  be formatted in the "dotted decimal" notation as defined in IETF RFC 1166 [10]. The string
                  for an IPv6 address shall be formatted according to clause 4 of IETF RFC 5952 [11], with
                  in CIDR notation [12] used to provide the routing prefix
                type: string
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: String
@@ -401,7 +430,10 @@ components:
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: String
              sourceIp:
                description: Source address identity of session (including range)
                description: Source address identity of session. The string for an IPv4 address shall be
                  formatted in the "dotted decimal" notation as defined in IETF RFC 1166 [10]. The string
                  for an IPv6 address shall be formatted according to clause 4 of IETF RFC 5952 [11], with
                  in CIDR notation [12] used to provide the routing prefix
                type: string
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: String
@@ -418,11 +450,13 @@ components:
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Structure (inlined)
      required:
      - allocationId
      - appInsId
      - requestType
      type: object
      x-etsi-ref: 7.2.3
    ProblemDetails:
      title: ProblemDetails
      properties:
        detail:
          description: A human-readable explanation specific to this occurrence of the problem