Commit b9742f2c authored by Ikram Haq's avatar Ikram Haq
Browse files

Latest Generated OAS for MEC document

parent ccfa902d
Loading
Loading
Loading
Loading
Loading
+49 −94
Original line number Diff line number Diff line
@@ -14,7 +14,7 @@ paths:
    get:
      summary: Retrieve the MTS capability information.
      description: The GET method is used to query information about the MTS information. This method is typically used in the "Get MTS service Info from the MTS Service" procedure as described in clause 6.2.6.
      operationId: mtscapabilityinfoGET
      operationId: MtscapabilityinfoGET
      tags:
      - mts
      responses:
@@ -33,11 +33,12 @@ paths:
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
      parameters: []
  /mts_sessions/{sessionId}:
    get:
      summary: Retrieve information about specific MTS session.
      description: This method retrieves information about an individual MTS session. This method is typically used in the "Get configured MTS Session Info from the MTS Service" procedure as described in clause 6.2.10.
      operationId: mtssessionsByIdGET
      operationId: MtssessionsGETSessionid
      tags:
      - mts
      responses:
@@ -56,10 +57,17 @@ paths:
          $ref: '#/components/responses/404'
        '403':
          $ref: '#/components/responses/403'
      parameters:
      - name: sessionId
        in: path
        required: true
        description: The unique identifier of the sessionId.
        schema:
          type: string
    put:
      summary: Update the information about specific MTS session.
      description: 'This method updates the information about an individual MTS session. As specified in ETSI GS MEC 009 [6], the PUT HTTP method has "replace" semantics. '
      operationId: mtssessionsByIdPUT
      operationId: MtssessionsPUTSessionid
      tags:
      - mts
      requestBody:
@@ -90,10 +98,17 @@ paths:
          $ref: '#/components/responses/403'
        '412':
          $ref: '#/components/responses/412'
      parameters:
      - name: sessionId
        in: path
        required: true
        description: The unique identifier of the sessionId.
        schema:
          type: string
    delete:
      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: mtssessionsByIdDELETE
      operationId: MtssessionsDELETESessionid
      tags:
      - mts
      responses:
@@ -103,11 +118,18 @@ paths:
          $ref: '#/components/responses/404'
        '403':
          $ref: '#/components/responses/403'
      parameters:
      - name: sessionId
        in: path
        required: true
        description: The unique identifier of the sessionId.
        schema:
          type: string
  /mts_sessions:
    get:
      summary: Retrieve information about a list of MTS sessions.
      description: This method retrieves information about a list of MTS sessions. This method is typically used in the "Get configured MTS Session Info from the MTS Service" procedure as described in clause 6.2.10.
      operationId: mtssessionsGET
      operationId: MtssessionsGET
      tags:
      - mts
      parameters:
@@ -120,9 +142,6 @@ paths:
          content:
            application/json:
              schema:
                type: object
                properties:
                  MtsSessionInfo:
                type: array
                items:
                  $ref: '#/components/schemas/MtsSessionInfo'
@@ -135,7 +154,7 @@ paths:
    post:
      summary: Create a MTS session.
      description: This method is 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: mtssessionsPOST
      operationId: MtssessionsPOST
      tags:
      - mts
      requestBody:
@@ -164,6 +183,7 @@ paths:
          $ref: '#/components/responses/404'
        '403':
          $ref: '#/components/responses/403'
      parameters: []
components:
  schemas:
    ProblemDetails:
@@ -173,33 +193,28 @@ components:
          type: string
          format: uri
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
        title:
          type: string
          description: A short, human-readable summary of the problem type
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        status:
          type: integer
          format: uint32
          description: The HTTP status code for this occurrence of the problem
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        instance:
          type: string
          format: uri
          description: A URI reference that identifies the specific occurrence of the problem
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
    Uint32:
      type: integer
      format: uint32
    Unit32:
      type: integer
      format: int32
      minimum: 0
      maximum: 2147483647
    MtsCapabilityInfo:
      x-etsi-ref: 7.2.4
      type: object
@@ -222,8 +237,6 @@ components:
            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'
          x-etsi-mec-origin-type: Uint32
          x-etsi-mec-cardinality: 1..N
          type: array
          format: uint32
          minItems: 1
@@ -232,27 +245,21 @@ components:
      required:
      - mtsAccessInfo
      - mtsMode
      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."
      description: "|-\n  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."
    MtsSessionInfo:
      x-etsi-ref: 7.2.5
      type: object
      properties:
        sessionId:
          description: MTS session instance identifier
          x-etsi-mec-origin-type: String
          x-etsi-mec-cardinality: 0..1
          type: string
        timeStamp:
          $ref: '#/components/schemas/TimeStamp1'
        appInsId:
          description: Application instance identifier
          x-etsi-mec-origin-type: String
          x-etsi-mec-cardinality: '1'
          type: string
        appName:
          description: Name of the application
          x-etsi-mec-origin-type: String
          x-etsi-mec-cardinality: 0..1
          type: string
        requestType:
          type: integer
@@ -263,8 +270,6 @@ components:
            1 = FLOW_SPECIFIC_MTS_SESSION'
          enum:
          - SEE_DESCRIPTION
          x-etsi-mec-origin-type: Enum_inlined
          x-etsi-mec-cardinality: '1'
        flowFilter:
          type: array
          items:
@@ -283,8 +288,6 @@ components:
            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-origin-type: Uint32
          x-etsi-mec-cardinality: '1'
          type: integer
          format: uint32
        trafficDirection:
@@ -295,8 +298,6 @@ components:
            01 = Uplink (towards the application/session)

            10 = Symmetrical (see note)'
          x-etsi-mec-origin-type: String
          x-etsi-mec-cardinality: '1'
          type: string
      required:
      - appInsId
@@ -305,23 +306,17 @@ components:
      - qosD
      - mtsMode
      - trafficDirection
      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."
      description: "|-\n  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."
    TimeStamp:
      description: Time stamp to indicate when the corresponding information elements are sent
      x-etsi-mec-origin-type: Structure (inlined)
      x-etsi-mec-cardinality: 0..1
      type: object
      properties:
        seconds:
          description: Time in seconds in Unix-time since January 1, 1970, 00:00:00 UTC
          x-etsi-mec-origin-type: Uint32
          x-etsi-mec-cardinality: '1'
          type: integer
          format: uint32
        nanoSeconds:
          description: Time in nanoseconds in Unix-time since January 1, 1970, 00:00:00 UTC
          x-etsi-mec-origin-type: Uint32
          x-etsi-mec-cardinality: '1'
          type: integer
          format: uint32
      required:
@@ -329,15 +324,11 @@ components:
      - nanoSeconds
    MtsAccessInfo:
      description: The information on access network connection as defined below
      x-etsi-mec-origin-type: Structure (inlined)
      x-etsi-mec-cardinality: 1..N
      type: object
      minItems: 1
      properties:
        accessId:
          description: Unique identifier for the access network connection
          x-etsi-mec-origin-type: Uint32
          x-etsi-mec-cardinality: '1'
          type: integer
          format: uint32
        accessType:
@@ -366,8 +357,6 @@ components:
            32 = 3GPP E-UTRA (4G/LTE)

            33 = 3GPP NR (5G) '
          x-etsi-mec-origin-type: Uint32
          x-etsi-mec-cardinality: '1'
          type: integer
          format: uint32
        metered:
@@ -378,8 +367,6 @@ components:
            1: the connection is metered

            2: unknown '
          x-etsi-mec-origin-type: Uint32
          x-etsi-mec-cardinality: '1'
          type: integer
          format: uint32
      required:
@@ -388,20 +375,14 @@ components:
      - metered
    TimeStamp1:
      description: 'Time stamp to indicate when the corresponding information elements are sent '
      x-etsi-mec-origin-type: Structure (inlined)
      x-etsi-mec-cardinality: 0..1
      type: object
      properties:
        seconds:
          description: The seconds part of the Time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC
          x-etsi-mec-origin-type: Uint32
          x-etsi-mec-cardinality: '1'
          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
          x-etsi-mec-origin-type: Uint32
          x-etsi-mec-cardinality: '1'
          type: integer
          format: uint32
      required:
@@ -409,82 +390,59 @@ components:
      - nanoSeconds
    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
      x-etsi-mec-origin-type: Structure (inlined)
      x-etsi-mec-cardinality: 1..N
      type: object
      minItems: 1
      properties:
        sourceIp:
          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"
          x-etsi-mec-origin-type: String
          x-etsi-mec-cardinality: 0..1
          type: string
        sourcePort:
          description: 'Source port identity of session '
          x-etsi-mec-origin-type: Uint32
          x-etsi-mec-cardinality: 0..1
          type: integer
          format: uint32
        dstIp:
          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"
          x-etsi-mec-origin-type: String
          x-etsi-mec-cardinality: 0..1
          type: string
        dstPort:
          description: Destination port identity of session
          x-etsi-mec-origin-type: Uint32
          x-etsi-mec-cardinality: 0..1
          type: integer
          format: uint32
        protocol:
          description: Protocol number
          x-etsi-mec-origin-type: Uint32
          x-etsi-mec-cardinality: 0..1
          type: integer
          format: uint32
        dscp:
          description: DSCP in the IPv4 header or Traffic Class in the IPv6 header
          x-etsi-mec-origin-type: Uint32
          x-etsi-mec-cardinality: 0..1
          type: integer
          format: uint32
        flowlabel:
          description: Flow Label in the IPv6 header, applicable only if the flow is IPv6
          x-etsi-mec-origin-type: Uint32
          x-etsi-mec-cardinality: 0..1
          type: integer
          format: 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)
      x-etsi-mec-origin-type: Structure
      x-etsi-mec-cardinality: '1'
      type: object
      properties:
        minTpt:
          # description': minimal throughput in [kbps]
          description: minimal throughput in [kbps]
          $ref: '#/components/schemas/Unit32'
          # x-etsi-mec-origin-type': Unit32
          # x-etsi-mec-cardinality': 0..1
          type: object
        maxLatency:
          # description': tolerable (one-way) delay in [10 nanoseconds]
          description: tolerable (one-way) delay in [10 nanoseconds]
          $ref: '#/components/schemas/Unit32'
          # x-etsi-mec-origin-type': Unit32
          # x-etsi-mec-cardinality': 0..1
          type: object
        maxLoss:
          # description': tolerable packet loss rate in [1/10^x]
          description: tolerable packet loss rate in [1/10^x]
          $ref: '#/components/schemas/Unit32'
          # x-etsi-mec-origin-type': Unit32
          # x-etsi-mec-cardinality': 0..1
          type: object
        maxJitter:
          # description': tolerable jitter in [10 nanoseconds]
          description: tolerable jitter in [10 nanoseconds]
          $ref: '#/components/schemas/Unit32'
          # x-etsi-mec-origin-type': Unit32
          # x-etsi-mec-cardinality': 0..1
          type: object
        priority:
          # description': 'numeric value (0 - 255) corresponding to the traffic priority: 0: low; 1: medium; 2: high; 3: critical'
          description: 'numeric value (0 - 255) corresponding to the traffic priority: 0: low; 1: medium; 2: high; 3: critical'
          $ref: '#/components/schemas/Unit32'
          # x-etsi-mec-origin-type': Unit32
          # x-etsi-mec-cardinality': 0..1
          type: object
  responses:
    '200':
      description: OK
@@ -520,7 +478,6 @@ components:

        See note.'
      name: app_instance_id
      cardinality: 0..N
      in: query
      required: false
      x-exportParamName: Query.App_instance_id
@@ -533,7 +490,6 @@ components:

        See note.'
      name: app_name
      cardinality: 0..N
      in: query
      required: false
      x-exportParamName: Query.App_name
@@ -546,7 +502,6 @@ components:

        See note.'
      name: session_id
      cardinality: 0..N
      in: query
      required: false
      x-exportParamName: Query.Session_id