Commit ea98356f authored by Jesus de Gregorio's avatar Jesus de Gregorio
Browse files

CT#101

parent 8b69cb09

TS24558_Eecs_ServiceProvisioning.yaml

+7 −2
Original line number Diff line number Diff line
@@ -2,14 +2,14 @@ openapi: 3.0.0 


info:

  title: Eecs_ServiceProvisioning

  version: "1.1.0-alpha.2"

  version: "1.1.0-alpha.3"

  description: |

    API for ECS Service Provisioning.  

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

    All rights reserved.



externalDocs:

  description: 3GPP TS 24.558 V18.1.0 Enabling Edge Applications; Protocol specification.

  description: 3GPP TS 24.558 V18.2.0 Enabling Edge Applications; Protocol specification.

  url: https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/



security:
@@ -415,6 +415,11 @@ components: 
            type: string

          minItems: 1

          description: Indicates to the ECS which EES providers are preferred by the EEC.

        eecTriggerRequest:

          type: boolean

          description: >

            Indicates to the ECS, whether the application triggering is required by the EEC.

            Default value false indicates the application triggering is not required.

        suppFeat:

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

      required:

TS24558_Eees_EASDiscovery.yaml

+82 −2
Original line number Diff line number Diff line
@@ -6,11 +6,11 @@ info: 
    API for EAS Discovery.  

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

    All rights reserved.

  version: "1.1.0-alpha.2"

  version: "1.1.0-alpha.3"



externalDocs:

  description: >

    3GPP TS 24.558 V18.1.0 Enabling Edge Applications; Protocol specification.

    3GPP TS 24.558 V18.2.0 Enabling Edge Applications; Protocol specification.

  url: https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/



security:
@@ -367,6 +367,8 @@ components: 
            the current request. The default value false indicates the EAS instantiation triggering

            should not be performed. The true value indicate the EAS instantiation triggering should

            be performed.

        predictExpTime:

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

      required:

        - requestorId
@@ -387,6 +389,15 @@ components: 
          description: >

            Contains the EAS instantiation information for each discovered EAS returned within

            the discoveredEas attribute.

        edgeLoadAnalytics:

          type: object

          additionalProperties:

            $ref: '#/components/schemas/EdgeLoadAnalytic'

          minProperties: 1

          description: >

            Contains the statistical analytics data and predictive analytics data for each

            discovered application server. The key of the map shall be the EAS ID to which

            the provided analytics data within the map value relates.

      required:

        - discoveredEas
@@ -432,9 +443,15 @@ components: 
            the current request. The default value false indicates the EAS instantiation triggering

            should not be performed. The true value indicate the EAS instantiation triggering should

            be performed.

        eecTriggerRequest:

          type: boolean

          description: >

            Indicates to the EES whether the application triggering is required by the EEC.

            Default value false indicates the application triggering is not required.

      required:

        - eecId

        - easEventType



    EasDiscoveryNotification:

      description: Notification of EAS discovery information.

      type: object
@@ -460,6 +477,15 @@ components: 
          description: >

            Contains the EAS instantiation information for each discovered EAS returned within

            the "discoveredEas" attribute.

        edgeLoadAnalytics:

          type: object

          additionalProperties:

            $ref: '#/components/schemas/EdgeLoadAnalytic'

          minProperties: 1

          description: >

            Contains the statistical analytics data and predictive analytics data for each

            discovered application server. The key of the map shall be the EAS ID to which

            the provided analytics data within the map value relates.

      required:

        - subId

        - eventType
@@ -489,6 +515,16 @@ components: 
        easId:

          type: string

          description: EAS application identifier.

        appGrpId:

          type: string

          description: >

            Application group identifier, identifying a group of UEs using the same

            application service.

        easSyncInd:

          type: boolean

          description: >

            Indicates whether the synchronization between the EASs is required. The

            default value false indicates the EAS synchronization is not required.

        easProvId:

          type: string

          description: EAS provider identifier.
@@ -530,6 +566,7 @@ components: 
          $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'

      required:

        - eas



    EasDynamicInfoFilter:

      description: Represents EAS dynamic information changes filter.

      type: object
@@ -542,6 +579,7 @@ components: 
          description: List of EAS dynamic information required by the EEC per EAS.

      required:

        - dynInfoFilter



    EasDynamicInfoFilterData:

      description: Represents an EAS dynamic information.

      type: object
@@ -561,6 +599,8 @@ components: 
        easPt:

          type: boolean

          description: Notify if EAS endpoint changed.

        easEndPoint:

          $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint'

        easFeature:

          type: boolean

          description: Notify if EAS feature changed.
@@ -641,3 +681,43 @@ components: 
        - required: [eesId]

        - required: [easId]

        - required: [eecId]



    EdgeLoadAnalytic:

      description: >

        Contains the statistical analytics data and predictive analytics data for each

        discovered application server.

      type: object

      properties:

        easId:

          type: string

          description: The application identifier of the EAS, e.g. FQDN, URI.

        predictData:

          $ref: '#/components/schemas/PredictiveData'

        statisticData:

          $ref: '#/components/schemas/StatisticalData'

      required:

        - easId



    PredictiveData:

      description: >

        Contains the predictive analytics data for each discovered EAS service status

         (e.g. EAS schedule, EAS status) change.

      type: object

      properties:

        scheds:

          type: array

          items:

            $ref: 'TS29122_CpProvisioning.yaml#/components/schemas/ScheduledCommunicationTime'

          minItems: 1

        status:

          type: string

          description: Indicates the EAS status (e.g. Enabled, Disabled etc.).



    StatisticalData:

      description: >

        Contains the statistical analytics data (e.g. number of times the client received

        expected performance from the EAS).

      type: object

      properties:

        numRecPerf:

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

TS24558_Eees_EECRegistration.yaml

+23 −2
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ openapi: 3.0.0 


info:

  title: Eees_EECRegistration

  version: "1.1.0-alpha.2"

  version: "1.1.0-alpha.3"

  description: |

    API for EEC registration.  

    © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
@@ -10,7 +10,7 @@ info: 


externalDocs:

  description: >

    3GPP TS 24.558 V18.1.0 Enabling Edge Applications; Protocol specification.

    3GPP TS 24.558 V18.2.0 Enabling Edge Applications; Protocol specification.

  url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/'



security:
@@ -269,6 +269,8 @@ components: 
            Set to true to indicate that UE Mobility support is required.

            Set to false to indicate that UE mobility support is not required.

            The default value when omitted is false.

        ueType:

          $ref: '#/components/schemas/DeviceType'

        unfulfillAcProfs:

          type: array

          items:
@@ -374,6 +376,8 @@ components: 
        ueMobilityReq:

          type: boolean

          description: Indicates whether UE requires mobility support or not.

        ueType:

          $ref: '#/components/schemas/DeviceType'



    UnfulfilledAcProfile:

      description: Describes AC Profile ID and reason sent by EES in EEC Register response.
@@ -401,3 +405,20 @@ components: 
        Possible values are:

        - EAS_NOT_AVAILABLE: EAS is not available.

        - REQ_UNFULFILLED: Requirements cannot be fulfilled.



    DeviceType:

      anyOf:

      - type: string

        enum:

          - CONSTRAINED_UE

          - NORMAL_UE

      - type: string

        description: >

          This string provides forward-compatibility with future

          extensions to the enumeration and is not used to encode

          content defined in the present version of this API.

      description: >

        Represents the UE type.

        Possible values are:

        - CONSTRAINED_UE: Indicates UE is constrained with resources like power, processor etc.

        - NORMAL_UE: Indicates UE is not constrained with resources.

TS29122_AsSessionWithQoS.yaml

+99 −14
Original line number Diff line number Diff line
@@ -2,14 +2,14 @@ openapi: 3.0.0 


info:

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

  version: 1.3.0-alpha.2

  version: 1.3.0-alpha.3

  description: |

    API for setting us an AS session with required QoS.  

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

    All rights reserved.



externalDocs:

  description: 3GPP TS 29.122 V18.2.0 T8 reference point for Northbound APIs

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

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



security:
@@ -475,6 +475,10 @@ components: 
        exterAppId:

          type: string

          description: Identifies the external Application Identifier.

        extGroupId:

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

        gpsi:

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

        flowInfo:

          type: array

          items:
@@ -495,6 +499,13 @@ components: 
          description: >

            Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow

            idenifer and the corresponding UL and/or DL flows.

        listUeAddrs:

          type: array

          items:

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

          minItems: 1

          description: >

            Identifies the list of UE address

        multiModalId:

          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MultiModalId'

        pduSetProtDesc:
@@ -540,14 +551,12 @@ components: 
          $ref: 'TS29122_CommonData.yaml#/components/schemas/SponsorInformation'

        qosMonInfo:

          $ref: '#/components/schemas/QosMonitoringInformation'

        pdvReqMonParams:

          type: array

          items:

            $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter'

          minItems: 1

          description: Contains the Packet Delay Variation to be monitored

        pdvMon:

          $ref: '#/components/schemas/QosMonitoringInformation'

        qosDuration:

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

        qosInactInt:

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

        directNotifInd:

          type: boolean

          description: >
@@ -588,6 +597,16 @@ components: 
            the service, when it is included and set to "true".

            The default value is "false" if omitted.        periodInfo:

          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/PeriodicityInfo'

        rttMon:

          $ref: '#/components/schemas/QosMonitoringInformation'

        qosMonDatRate:

          $ref: '#/components/schemas/QosMonitoringInformation'

        avrgWndw:

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

        servAuthInfo:

          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ServAuthInfo'

        qosMonConReq:

          $ref: '#/components/schemas/QosMonitoringInformation'

      required:

        - notificationDestination
@@ -618,6 +637,13 @@ components: 
          description: >

            Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow

            idenifer and the corresponding UL and/or DL flows.

        listUeAddrs:

          type: array

          items:

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

          minItems: 1

          description: >

            Identifies the list of UE address.

        multiModalId:

          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MultiModalId'

        qosReference:
@@ -651,12 +677,6 @@ components: 
          $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm'

        qosMonInfo:

          $ref: '#/components/schemas/QosMonitoringInformationRm'

        pdvReqMonParams:

          type: array

          items:

            $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter'

          minItems: 1

          description: Contains the Packet Delay Variation to be monitored

        pdvMon:

          $ref: '#/components/schemas/QosMonitoringInformationRm'

        directNotifInd:
@@ -697,6 +717,18 @@ components: 
          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ProtoDesc'

        periodInfo:

          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/PeriodicityInfo'

        qosDuration:

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

        qosInactInt:

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

        rttMon:

          $ref: '#/components/schemas/QosMonitoringInformationRm'

        qosMonDatRate:

          $ref: '#/components/schemas/QosMonitoringInformationRm'

        avrgWndw:

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

        qosMonConReq:

          $ref: '#/components/schemas/QosMonitoringInformationRm'



    QosMonitoringInformation:

      description: Represents QoS monitoring information.
@@ -718,10 +750,18 @@ components: 
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'

        repThreshRp:

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

        conThreshDl:

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

        conThreshUl:

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

        waitTime:

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

        repPeriod:

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

        repThreshDatRateDl:

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

        repThreshDatRateUl:

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

      required:

        - reqQosMonParams

        - repFreqs
@@ -748,10 +788,18 @@ components: 
          $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm'

        repThreshRp:

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

        conThreshDl:

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

        conThreshUl:

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

        waitTime:

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

        repPeriod:

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

        repThreshDatRateDl:

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

        repThreshDatRateUl:

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



    QosMonitoringReport:

      description: Represents a QoS monitoring report.
@@ -775,6 +823,20 @@ components: 
        pdmf:

          type: boolean

          description: Represents the packet delay measurement failure indicator.

        ulDataRate:

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

        dlDataRate:

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

        ulConInfo:

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

        dlConInfo:

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

        cimf:

          type: boolean

          description: >

            Represents the congestion information measurement failure indicator. When set to "true",

            it indicates that a congestion information failure has occurred. Default value is false

            if omitted.



    UserPlaneNotificationData:

      description: Represents the parameters to be conveyed in a user plane event(s) notification.
@@ -846,6 +908,25 @@ components: 
          $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'

        batOffsetInfo:

          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/BatOffsetInfo'

        rttMonReports:

          type: array

          items:

            $ref: '#/components/schemas/QosMonitoringReport'

          minItems: 1

          description: Contains the round trip delay over two SDFs reporting information

        qosMonDatRateReps:

          type: array

          items:

            $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/QosMonitoringReport'

          minItems: 1

        qosMonConInfoReps:

          type: array

          items:

            $ref: '#/components/schemas/QosMonitoringReport'

          minItems: 1

          description: >

            Contains QoS Monitoring for congestion information. It shall be present when the

            notified event is "QOS_MONITORING" and congestion measurements are available.

      required:

        - event
@@ -1093,6 +1174,8 @@ components: 
          - L4S_NOT_AVAILABLE

          - L4S_AVAILABLE

          - BAT_OFFSET_INFO

          - RT_DELAY_TWO_QOS_FLOWS

          - PACK_DELAY_VAR

      - type: string

        description: >

          This string provides forward-compatibility with future
@@ -1116,3 +1199,5 @@ components: 
        - L4S_NOT_AVAILABLE: The ECN marking for L4S of one or more SDFs is not available.

        - L4S_AVAILABLE: The ECN marking for L4S of one or more SDFs is available again.

        - BAT_OFFSET_INFO: Indicates the network provided BAT offset and the optionally adjusted periodicity.

        - RT_DELAY_TWO_QOS_FLOWS: Indicates round-trip delay on UL and DL flows over two QoS flows.

        - PACK_DELAY_VAR: Indicates Packet Delay Variation is enabled for the SDF.

TS29122_CommonData.yaml

+2 −8
Original line number Diff line number Diff line
@@ -2,14 +2,14 @@ openapi: 3.0.0 


info:

  title: TS 29.122 Common Data Types

  version: 1.3.0-alpha.2

  version: 1.3.0-alpha.3

  description: |

    Data types applicable to several APIs.  

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

    All rights reserved.



externalDocs:

  description: 3GPP TS 29.122 V18.1.0 T8 reference point for Northbound APIs

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

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



paths: {}
@@ -328,12 +328,6 @@ components: 
    BdtReferenceId:

      type: string

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

    BdtReferenceIdRm:

      type: string

      description: >

        This data type is defined in the same way as the BdtReferenceId data type, but with the

        nullable property set to true.

      nullable: true



    Binary:

      type: string