Commit 87a34e7e authored by Saurav Arora's avatar Saurav Arora
Browse files

CT#84

parent 00d8c089

TS29122_AsSessionWithQoS.yaml

+8 −4
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: 3gpp-as-session-with-qos

  version: "1.0.1"

  version: 1.0.2

  description: | 

    API for setting us an AS session with required QoS.

    © 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.

externalDocs:

  description: 3GPP TS 29.122 V15.3.0 T8 reference point for Northbound APIs

  description: 3GPP TS 29.122 V15.4.0 T8 reference point for Northbound APIs

  url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'

security:

  - {}
@@ -376,7 +380,7 @@ components: 
          $ref: 'TS29122_CommonData.yaml#/components/schemas/SponsorInformation'

        requestTestNotification:

          type: boolean

          description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in subclause 5.2.5.3. Set to false or omitted otherwise.

          description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in subclause 5.2.5.3. Set to false or omitted otherwise.

        websockNotifConfig:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'

      required:

TS29122_ChargeableParty.yaml

+8 −4
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: 3gpp-chargeable-party

  version: "1.0.1"

  version: 1.0.2

  description: | 

    API for Chargeable Party management.

    © 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.

externalDocs:

  description: 3GPP TS 29.122 V15.3.0 T8 reference point for Northbound APIs

  description: 3GPP TS 29.122 V15.4.0 T8 reference point for Northbound APIs

  url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'

security:

  - {}
@@ -300,7 +304,7 @@ components: 
          $ref: 'TS29122_CommonData.yaml#/components/schemas/Link'

        requestTestNotification:

          type: boolean

          description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in subclause 5.2.5.3. Set to false or omitted otherwise.

          description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in subclause 5.2.5.3. Set to false or omitted otherwise.

        websockNotifConfig:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'

        ipv4Addr:

TS29122_CommonData.yaml

+23 −19
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: TS 29.122 Common Data Types

  version: "1.0.0"

  version: 1.0.1

  description: | 

    Data types applicable to several APIs.

    © 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.

externalDocs:

  description: 3GPP TS 29.122 V15.3.0 T8 reference point for Northbound APIs

  description: 3GPP TS 29.122 V15.4.0 T8 reference point for Northbound APIs

  url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'

paths: {}

components:
@@ -111,7 +115,7 @@ components: 
          type: array

          items:

            type: string

          description: Indicates the packet filters of the IP flow. Refer to subclause 5.3.8 of 3GPP TS 29.214 for encoding. It shall contain UL and/or DL IP flow description.

          description: Indicates the packet filters of the IP flow. Refer to subclause 5.3.8 of 3GPP TS 29.214 for encoding. It shall contain UL and/or DL IP flow description.

          minItems: 1

          maxItems: 2

      required:
@@ -254,20 +258,20 @@ components: 
        - resultReason

      oneOf:

        - required: [externalIds]

        - required: [Msisdns]

        - required: [msisdns]

    Bandwidth:

      type: integer

      minimum: 0

      description: integer indicating a bandwidth in bits per second.

    BdtReferenceId:

      type: string

      description: string identifying a BDT Reference ID as defined in subclause 5.3.3 of 3GPP TS 29.154.

      description: string identifying a BDT Reference ID as defined in subclause 5.3.3 of 3GPP TS 29.154.

    Binary:

      type: string

      description: string with format "binary" as defined in OpenAPI Specification.

    Bytes:

      type: string

      description: String with format "byte" as defined in OpenAPI Specification, i.e, base64-encoded characters.

      description: String with format "byte" as defined in OpenAPI Specification, i.e, base64-encoded characters.

    DayOfWeek:

      type: integer

      minimum: 1
@@ -282,7 +286,7 @@ components: 
      nullable: true

    DateTimeRo:

      type: string

      description: string with format "date-time" as defined in OpenAPI with "readOnly=true" property.

      description: string with format "date-time" as defined in OpenAPI with "readOnly=true" property.

      readOnly: true

    DurationSec:

      type: integer
@@ -305,36 +309,36 @@ components: 
      description: Unsigned integer identifying a period of time in units of minutes.

    ExternalId:

      type: string

      description: string containing a local identifier followed by "@" and a domain identifier. Both the local identifier and the domain identifier shall be encoded as strings that do not contain any "@" characters. See Clause 4.6.2 of 3GPP TS 23.682 for more information.

      description: string containing a local identifier followed by "@" and a domain identifier. Both the local identifier and the domain identifier shall be encoded as strings that do not contain any "@" characters. See Clause 4.6.2 of 3GPP TS 23.682 for more information.

    ExternalGroupId:

      type: string

      description: string containing a local identifier followed by "@" and a domain identifier. Both the local identifier and the domain identifier shall be encoded as strings that do not contain any "@" characters. See Clauses 4.6.2 and 4.6.3 of 3GPP TS 23.682 for more information.

      description: string containing a local identifier followed by "@" and a domain identifier. Both the local identifier and the domain identifier shall be encoded as strings that do not contain any "@" characters. See Clauses 4.6.2 and 4.6.3 of 3GPP TS 23.682 for more information.

    Ipv4Addr:

      type: string

      description: string identifying a Ipv4 address formatted in the "dotted decimal" notation as defined in IETF RFC 1166.

      description: string identifying a Ipv4 address formatted in the "dotted decimal" notation as defined in IETF RFC 1166.

    Ipv6Addr:

      type: string

      description: string identifying a Ipv6 address formatted according to clause 4 in IETF RFC 5952. The mixed Ipv4 Ipv6 notation according to clause 5 of IETF RFC 5952 shall not be used.

      description: string identifying a Ipv6 address formatted according to clause 4 in IETF RFC 5952. The mixed Ipv4 Ipv6 notation according to clause 5 of IETF RFC 5952 shall not be used.

    Ipv4AddrRo:

      type: string

      description: string identifying a Ipv4 address formatted in the "dotted decimal" notation as defined in IETF RFC 1166, with "readOnly=true" property.

      description: string identifying a Ipv4 address formatted in the "dotted decimal" notation as defined in IETF RFC 1166, with "readOnly=true" property.

      readOnly: true

    Ipv6AddrRo:

      type: string

      description: string identifying a Ipv6 address formatted according to clause 4 in IETF RFC 5952, with "readOnly=true" property. The mixed Ipv4 Ipv6 notation according to clause 5 of IETF RFC 5952 shall not be used.

      description: string identifying a Ipv6 address formatted according to clause 4 in IETF RFC 5952, with "readOnly=true" property. The mixed Ipv4 Ipv6 notation according to clause 5 of IETF RFC 5952 shall not be used.

      readOnly: true

    Link:

      type: string

      description: string formatted according to IETF RFC 3986 identifying a referenced resource.

      description: string formatted according to IETF RFC 3986 identifying a referenced resource.

    Mcc:

      type: string

      description: String encoding a Mobile Country Code part of the PLMN, comprising 3 digits, as defined in 3GPP TS 38.413.

      description: String encoding a Mobile Country Code part of the PLMN, comprising 3 digits, as defined in 3GPP TS 38.413.

    Mnc:

      type: string

      description: String encoding a Mobile Network Code part of the PLMN, comprising 2 or 3 digits, as defined in 3GPP TS 38.413.

      description: String encoding a Mobile Network Code part of the PLMN, comprising 2 or 3 digits, as defined in 3GPP TS 38.413.

    Msisdn:

      type: string

      description: string formatted according to subclause 3.3 of 3GPP TS 23.003 that describes an MSISDN.

      description: string formatted according to subclause 3.3 of 3GPP TS 23.003 that describes an MSISDN.

    Port:

      type: integer

      description: Unsigned integer with valid values between 0 and 65535.
@@ -357,7 +361,7 @@ components: 
      description: String with format partial-time or full-time as defined in subclause 5.6 of IETF RFC 3339. Examples, 20:15:00, 20:15:00-08:00 (for 8 hours behind UTC).

    Uri:

      type: string

      description: string providing an URI formatted according to IETF RFC 3986. 

      description: string providing an URI formatted according to IETF RFC 3986. 

    Volume:

      type: integer

      format: int64

TS29122_CpProvisioning.yaml

+10 −3
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: 3gpp-cp-parameter-provisioning

  version: "1.0.0"

  version: 1.0.1

  description: | 

    API for provisioning communication pattern parameters.

    © 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.

externalDocs:

  description: 3GPP TS 29.122 V15.3.0 T8 reference point for Northbound APIs

  description: 3GPP TS 29.122 V15.4.0 T8 reference point for Northbound APIs

  url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'

security:

  - {}
@@ -418,6 +422,9 @@ components: 
          $ref: 'TS29122_CommonData.yaml#/components/schemas/Link'

        supportedFeatures:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

        mtcProviderId:

          type: string

          description: Identifies the MTC Service Provider and/or MTC Application.

        externalId:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId'

        msisdn:

TS29122_DeviceTriggering.yaml

+8 −4
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: 3gpp-device-triggering

  version: "1.0.0"

  version: 1.0.1

  description: | 

    API for device trigger.

    © 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.

externalDocs:

  description: 3GPP TS 29.122 V15.3.0 T8 reference point for Northbound APIs

  description: 3GPP TS 29.122 V15.4.0 T8 reference point for Northbound APIs

  url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'

security:

  - {}
@@ -318,7 +322,7 @@ components: 
          $ref: 'TS29122_CommonData.yaml#/components/schemas/Link'

        requestTestNotification:

          type: boolean

          description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in subclause 5.2.5.3. Set to false or omitted otherwise.

          description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in subclause 5.2.5.3. Set to false or omitted otherwise.

        websockNotifConfig:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'

        deliveryResult: