Commit 8b59548b authored by Peter Schmitt's avatar Peter Schmitt
Browse files

changes after CT4#134

parent 177cb891
Loading
Loading
Loading
Loading
Loading
+88 −27
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  version: '1.6.1'
  version: '1.7.0-alpha.1'


  title: 'Common Data Types'
@@ -11,7 +11,7 @@ info:
    All rights reserved.

externalDocs:
  description: 3GPP TS 29.571 Common Data Types for Service Based Interfaces, version 19.6.0
  description: 3GPP TS 29.571 Common Data Types for Service Based Interfaces, version 20.0.0
  url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.571/'

paths: {}
@@ -82,14 +82,14 @@ components:
    Double:
      format: double
      type: number
      description: string with format 'double' as defined in OpenAPI
      description: Number with format 'double' as defined in OpenAPI

    DoubleRm:
      format: double
      type: number
      nullable: true
      description: >
        string with format 'double' as defined in OpenAPI with 'nullable: true' property.
        Number with format 'double' as defined in OpenAPI with 'nullable: true' property.

    DurationSec:
      type: integer
@@ -103,40 +103,40 @@ components:
    Float:
      format: float
      type: number
      description: string with format 'float' as defined in OpenAPI.
      description: Number with format 'float' as defined in OpenAPI.

    FloatRm:
      format: float
      type: number
      nullable: true
      description: >
        string with format 'float' as defined in OpenAPI with the OpenAPI defined
        Number with format 'float' as defined in OpenAPI with 
        'nullable: true' property.

    Int32:
      format: int32
      type: integer
      description: string with format 'int32' as defined in OpenAPI.
      description: Number with format 'int32' as defined in OpenAPI.

    Int32Rm:
      format: int32
      type: integer
      nullable: true
      description: >
        string with format 'int32' as defined in OpenAPI with the OpenAPI defined
        Number with format 'int32' as defined in OpenAPI with the OpenAPI defined
        'nullable: true' property.

    Int64:
      type: integer
      format: int64
      description: string with format 'int64' as defined in OpenAPI.
      description: Number with format 'int64' as defined in OpenAPI.

    Int64Rm:
      format: int64
      type: integer
      nullable: true
      description: >
        string with format 'int64' as defined in OpenAPI with the OpenAPI defined
        Number with format 'int64' as defined in OpenAPI with the OpenAPI defined
        'nullable: true' property.

    Ipv4Addr:
@@ -239,7 +239,7 @@ components:
        6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in 
        hexadecimal representation Each character in the string shall take a value of "0" to "9", 
        "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in 
        table 5.2.2-3. The most significant character representing the highest-numbered features
        table 5.2.2-3. The most significant character representing the highest-numbered features
        shall  appear first in the string, and the character representing features 1 to 4
        shall appear last  in the string. The list of features and their numbering (starting with 1)
        are defined  separately for each API. If the string contains a lower number of characters
@@ -339,7 +339,7 @@ components:
      description: |
        String with format "time-numoffset" optionally appended by "daylightSavingTime", where 
        - "time-numoffset" shall represent the time zone adjusted for daylight saving time and be
           encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339; 
           encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339; 
        - "daylightSavingTime" shall represent the adjustment that has been made and shall be
           encoded as "+1" or "+2" for a +1 or +2 hours adjustment. 

@@ -1278,7 +1278,7 @@ components:
          $ref: '#/components/schemas/Mnc'
        mcc:
          $ref: '#/components/schemas/Mcc'
      description: contains PLMN and Network identity.
      description: contains PLMN and identifier.


#
@@ -1507,7 +1507,7 @@ components:
        <MNC> encoding the Mobile Network Code part of the PLMN, comprising 3 digits. 
          If there are only 2 significant digits in the MNC, one "0" digit shall be inserted 
          at the left side to fill the 3 digits coding of MNC.  Pattern: '^[0-9]{3}$'
        <NID> encoded as defined in clause 5.4.2 ("Nid" data type definition) 
        <NID> encoded as defined in clause 5.4.2 ("Nid" data type definition) 
        <NFInstanceId> encoded as defined in clause 5.3.2 
        <ServiceName> encoded as defined in 3GPP TS 29.510 
        <Set ID> encoded as a string of characters consisting of alphabetic 
@@ -2896,7 +2896,7 @@ components:
          default: false
          description: >
            Indicates the support of Access Traffic Steering, Switching and Splitting procedures
            using the MPTCP steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501
            using the MPTCP steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501
            true: Supported
            false (default): Not Supported
        mpquic:
@@ -2904,7 +2904,7 @@ components:
          default: false
          description: >
            Indicates the support of Access Traffic Steering, Switching and Splitting procedures 
            using the MPQUIC-UDP steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501)
            using the MPQUIC-UDP steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501)
            true: Supported
            false (default): Not Supported
        rttWithoutPmf:
@@ -2912,7 +2912,7 @@ components:
          default: false
          description: >
            This IE is only used by the UPF to indicate whether the UPF supports RTT measurement
            without PMF (see clauses 5.32.2, 6.3.3.3 of 3GPP TS 23.501
            without PMF (see clauses 5.32.2, 6.3.3.3 of 3GPP TS 23.501
            true: Supported
            false (default): Not Supported
        mpquicIp:
@@ -2920,7 +2920,7 @@ components:
          default: false
          description: >
            Indicates the support of Access Traffic Steering, Switching and Splitting procedures 
            using the MPQUIC-IP steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501)
            using the MPQUIC-IP steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501)
            true: Supported
            false (default): Not Supported
        mpquicE:
@@ -2928,7 +2928,7 @@ components:
          default: false
          description: >
            Indicates the support of Access Traffic Steering, Switching and Splitting procedures 
            using the MPQUIC-E steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501)
            using the MPQUIC-E steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501)
            true: Supported
            false (default): Not Supported
    PlmnIdNid:
@@ -3138,7 +3138,7 @@ components:
        with the OpenAPI 'nullable: true' property.

    AcsInfo:
      description: The ACS information for the 5G-RG is defined in BBF TR-069 [42] or in BBF TR-369
      description: The ACS information for the 5G-RG is defined in BBF TR-069 [42] or in BBF TR-369
      type: object
      properties:
        acsUrl:
@@ -3253,7 +3253,7 @@ components:
          type: string
          pattern: '^[0-9A-F]{20}$'
          description: >
            Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause
            Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause
            3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed
            to be used.

@@ -4077,6 +4077,62 @@ components:
        plmnId:
          $ref: '#/components/schemas/PlmnIdNid'


    NetworkIdInfo:
      description: Indicates the network identity information.
      type: object
      properties:
        dynamicNwId:
          $ref: '#/components/schemas/NetworkId'
        applicableTime:
          type: array
          items:
            $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
          minItems: 1
        applicableAreas:
          type: array
          items:
            $ref: '#/components/schemas/ApplicableArea'
          minItems: 1
      required:
        - dynamicNwId


    NetworkId:
      description: Indicates the network identity.
      type: object
      properties:
        fullName:
          type: string
          description: >
            Represents the full and readable Network Identity. 
        shortName:
          type: string
          description: >
            Represents the short Network Identity to be provided to the UE. 
        countryInd:
          type: boolean
          description: Contains country indicator flag
      required:
        - shortName


    ApplicableArea:
      description: Contains a list of tracking area code.
      type: object
      properties:
        plmnId:
          $ref: '#/components/schemas/PlmnId'
        tacs:
          type: array
          items:
            $ref: '#/components/schemas/Tac'
          minItems: 1
      required:
        - tacs
        - plmnId


#
# Data types describing alternative data types or combinations of data types
#
@@ -4090,6 +4146,7 @@ components:
        Differentiator value within the range of SD  (if the sdRanges attribute is present) or with
        any value (if the wildcardSd attribute is present).


    SnssaiReplaceInfo:
      description: Indicates the status of an S-NSSAI and an alternative S-NSSAI optionally.
      type: object
@@ -4367,7 +4424,7 @@ components:
      type: integer
      minimum: 1
      description: >
        Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP
        Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP
        TS 23.501 [8])), expressed in 0.01 milliseconds.

    ExtPacketDelBudgetRm:
@@ -4501,7 +4558,7 @@ components:
        - $ref: '#/components/schemas/NullValue'
      description: >
        The enumeration AdditionalQosFlowInfo provides additional QoS flow information (see clause 
        9.3.1.12 3GPP TS 38.413 [11]). It shall comply with the provisions defined in table
        9.3.1.12 3GPP TS 38.413 [11]). It shall comply with the provisions defined in table
        5.5.3.12-1.

    PartitioningCriteria:
@@ -5056,7 +5113,7 @@ components:
      description: >
        The enumeration MeasurementNrForMdt defines Measurements used for MDT in NR in the trace.
        See 3GPP TS 32.422 for further description of the values. It shall comply with the
        provisions defined in table 5.6.3.6-1.
        provisions defined in table 5.6.3.6-1.

    SensorMeasurement:
      anyOf:
@@ -5313,7 +5370,7 @@ components:
      description: >
        The enumeration AvailableRanVisibleQoeMetric indicates different available
        RAN-visible QoE metrics to the gNB. It shall comply with the provisions defined
        in TS 29.571, table 5.6.3.22-1.
        in TS 29.571, table 5.6.3.22-1.
      anyOf:
        - type: string
          enum:
@@ -5719,7 +5776,7 @@ components:
          minItems: 1

    CellIdNid:
      description: contains a NR Cell Identity and Network Identity.
      description: contains a NR Cell Identity and Network Identifier.
      type: object
      required:
        - cellId
@@ -5743,7 +5800,7 @@ components:
          minItems: 1

    TacNid:
      description: contains a tracking area code and Network Identity.
      description: contains a tracking area code and Network Identifier.
      type: object
      required:
        - tac
@@ -7155,6 +7212,9 @@ components:
      properties:
        adcStatus:
          $ref: '#/components/schemas/AdcStatus'
        callingId:
          type: string
          pattern: '^(sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|tel\:\+[0-9]{5,15})$'

    BdcReport:
      description: Bootstrap data channel report.
@@ -7617,3 +7677,4 @@ components:
            $ref: '#/components/schemas/ProblemDetails'
    default:
      description: Generic Error