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

CT#99

parent f2ce26fa
Loading
Loading
Loading
Loading
+5 −3
Original line number Diff line number Diff line
openapi: 3.0.0
info:
  title: Eecs_ServiceProvisioning
  version: "1.0.1"
  version: "1.1.0-alpha.1"
  description: |
    API for ECS Service Provisioning.
    © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
    © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
    All rights reserved.

externalDocs:
  description: 3GPP TS 24.558 V17.1.0 Enabling Edge Applications; Protocol specification.
  description: 3GPP TS 24.558 V18.0.0 Enabling Edge Applications; Protocol specification.
  url: https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/

security:
@@ -338,6 +338,8 @@ components:
          description: List of connectivity information for the UE.
        locInf:
          $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo'
        suppFeat:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
      required:
        - eecId
    ECSServProvResp:
+5 −3
Original line number Diff line number Diff line
openapi: 3.0.0
info:
  title: Eees Application Context Relocation Service
  version: "1.0.0"
  version: "1.1.0-alpha.1"
  description: |
    Eees Application Context Relocation Service.  
    © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
    © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    All rights reserved.

externalDocs:
  description: >
    3GPP TS 24.558 V17.0.0; Enabling Edge Applications; Protocol specification; Stage 3.
    3GPP TS 24.558 V18.0.0; Enabling Edge Applications; Protocol specification; Stage 3.
  url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/24.558/'

servers:
@@ -201,6 +201,8 @@ components:
          $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint'
        routeReq:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation'
        simInactTime:
          $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'
        easNotifInd:
          type: boolean
          default: false
+19 −6
Original line number Diff line number Diff line
@@ -3,12 +3,12 @@ info:
  title: Eees_EASDiscovery
  description: |
    API for EAS Discovery.  
    © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
    © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    All rights reserved.
  version: "1.0.1"
  version: "1.1.0-alpha.1"
externalDocs:
  description: >
    3GPP TS 24.558 V17.1.0 Enabling Edge Applications; Protocol specification.
    3GPP TS 24.558 V18.0.0 Enabling Edge Applications; Protocol specification.
  url: https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/

security:
@@ -306,7 +306,7 @@ components:
          scopes: {}
  schemas:
    EasDiscoveryReq:
      description: ECS service provisioning request information.
      description: EAS discovery request information.
      type: object
      properties:
        requestorId:
@@ -334,6 +334,14 @@ components:
          $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo'
        easTDnai:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai'
        easSelSupInd:
          type: boolean
          description: >
            Indicates if the EEC requires the EAS selection support from the EES (e.g., for
            constrained device). The default value false indicates the EAS selection is not
            required from the EES.
        suppFeat:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
      required:
        - requestorId
    EasDiscoveryResp:
@@ -426,9 +434,11 @@ components:
        easProvId:
          type: string
          description: EAS provider identifier.
        stdEasType:
          $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EASCategory'
        easType:
          type: string
          description: EAS type.
          description: EAS type with the flexible value set.
        easSched:
          $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
        svcArea:
@@ -447,6 +457,9 @@ components:
            type: string
          minItems: 1
          description: Service features.
      not:
        required: [stdEasType, easType]

    DiscoveredEas:
      description: Represents an EAS discovery information.
      type: object
+6 −4
Original line number Diff line number Diff line
openapi: 3.0.0
info:
  title: Eees_EECRegistration
  version: "1.0.1"
  version: "1.1.0-alpha.1"
  description: |
    API for EEC registration.  
    © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
    © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    All rights reserved.
externalDocs:
  description: >
    3GPP TS 24.558 V17.1.0 Enabling Edge Applications; Protocol specification.
    3GPP TS 24.558 V18.0.0 Enabling Edge Applications; Protocol specification.
  url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/'

security:
@@ -272,6 +272,8 @@ components:
          items:
            $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario' 
          description: Profiles of ACs for which the EEC provides edge enabling services.
        simInactTime:
          $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'
        eass:
          type: array
          items:
+136 −19
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  title: 3gpp-as-session-with-qos
  version: 1.2.2
  version: 1.3.0-alpha.1
  description: |
    API for setting us an AS session with required QoS.  
    © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    All rights reserved.

externalDocs:
  description: 3GPP TS 29.122 V17.8.0 T8 reference point for Northbound APIs
  description: 3GPP TS 29.122 V18.1.0 T8 reference point for Northbound APIs
  url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'

security:
  - {}
  - oAuth2ClientCredentials: []

servers:
  - url: '{apiRoot}/3gpp-as-session-with-qos/v1'
    variables:
      apiRoot:
        default: https://example.com
        description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.

paths:
  /{scsAsId}/subscriptions:
    get:
@@ -45,7 +50,9 @@ paths:
                minItems: 1
        - name: ip-domain
          in: query
          description: The IPv4 address domain identifier. The attribute may only be provided if IPv4 address is included in the ip-addrs query parameter.
          description: >
            The IPv4 address domain identifier. The attribute may only be provided if IPv4 address
            is included in the ip-addrs query parameter.
          required: false
          schema:
            type: string
@@ -166,7 +173,20 @@ paths:
        '401':
          $ref: 'TS29122_CommonData.yaml#/components/responses/401'
        '403':
          $ref: 'TS29122_CommonData.yaml#/components/responses/403'
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailsAsSessionWithQos'
          headers:
            Retry-After:
              description: >
                Indicates the time the AF has to wait before making a new request. It can be a
                non-negative integer (decimal number) indicating the number of seconds the AF
                has to wait before making a new request or an HTTP-date after which the AF can
                retry a new request.
              schema:
                type: string
        '404':
          $ref: 'TS29122_CommonData.yaml#/components/responses/404'
        '411':
@@ -276,7 +296,20 @@ paths:
        '401':
          $ref: 'TS29122_CommonData.yaml#/components/responses/401'
        '403':
          $ref: 'TS29122_CommonData.yaml#/components/responses/403'
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailsAsSessionWithQos'
          headers:
            Retry-After:
              description: >
                Indicates the time the AF has to wait before making a new request. It can be a
                non-negative integer (decimal number) indicating the number of seconds the AF
                has to wait before making a new request or an HTTP-date after which the AF can
                retry a new request.
              schema:
                type: string
        '404':
          $ref: 'TS29122_CommonData.yaml#/components/responses/404'
        '411':
@@ -336,7 +369,20 @@ paths:
        '401':
          $ref: 'TS29122_CommonData.yaml#/components/responses/401'
        '403':
          $ref: 'TS29122_CommonData.yaml#/components/responses/403'
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailsAsSessionWithQos'
          headers:
            Retry-After:
              description: >
                Indicates the time the AF has to wait before making a new request. It can be a
                non-negative integer (decimal number) indicating the number of seconds the AF
                has to wait before making a new request or an HTTP-date after which the AF can
                retry a new request.
              schema:
                type: string
        '404':
          $ref: 'TS29122_CommonData.yaml#/components/responses/404'
        '411':
@@ -401,6 +447,7 @@ paths:
          $ref: 'TS29122_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29122_CommonData.yaml#/components/responses/default'

components:
  securitySchemes:
    oAuth2ClientCredentials:
@@ -409,6 +456,7 @@ components:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}

  schemas:
    AsSessionWithQoSSubscription:
      description: Represents an individual AS session with required QoS subscription resource.
@@ -447,6 +495,8 @@ 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.
        multiModalId:
          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MultiModalId'
        qosReference:
          type: string
          description: Identifies a pre-defined QoS information
@@ -455,13 +505,18 @@ components:
          items:
            type: string
          minItems: 1
          description: Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority.
          description: >
            Identifies an ordered list of pre-defined QoS information. The lower the index of the
            array for a given entry, the higher the priority.
        altQosReqs:
          type: array
          items:
            $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData'
          minItems: 1
          description: Identifies an ordered list of alternative service requirements that include individual QoS parameter sets. The lower the index of the array for a given entry, the higher the priority.
          description: >
            Identifies an ordered list of alternative service requirements that include individual
            QoS parameter sets. The lower the index of the array for a given entry, the higher the
            priority.
        disUeNotif:
          description: >
            Indicates whether the QoS flow parameters signalling to the UE when the SMF is notified
@@ -492,17 +547,21 @@ components:
          $ref: '#/components/schemas/TscQosRequirement'
        requestTestNotification:
          type: boolean
          description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 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 clause 5.2.5.3. Set to false or omitted otherwise.
        websockNotifConfig:
          $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'
        events:
          description: Represents the list of user plane event(s) to which the SCS/AS requests to subscribe to.
          description: >
            Represents the list of user plane event(s) to which the SCS/AS requests to subscribe to.
          type: array
          items:
            $ref: '#/components/schemas/UserPlaneEvent'
          minItems: 1
      required:
        - notificationDestination

    AsSessionWithQoSSubscriptionPatch:
      description: Represents parameters to modify an AS session with specific QoS subscription.
      type: object
@@ -530,6 +589,8 @@ 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.
        multiModalId:
          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MultiModalId'
        qosReference:
          type: string
          description: Pre-defined QoS reference
@@ -538,13 +599,18 @@ components:
          items:
            type: string
          minItems: 1
          description: Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority.
          description: >
            Identifies an ordered list of pre-defined QoS information. The lower the index of the
            array for a given entry, the higher the priority.
        altQosReqs:
          type: array
          items:
            $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData'
          minItems: 1
          description: Identifies an ordered list of alternative service requirements that include individual QoS parameter sets. The lower the index of the array for a given entry, the higher the priority.
          description: >
            Identifies an ordered list of alternative service requirements that include individual
            QoS parameter sets. The lower the index of the array for a given entry, the higher the
            priority.
        disUeNotif:
          type: boolean
          description: >
@@ -565,11 +631,14 @@ components:
        tscQosReq:
          $ref: '#/components/schemas/TscQosRequirementRm'
        events:
          description: Represents the updated list of user plane event(s) to which the SCS/AS requests to subscribe to.
          description: >
            Represents the updated list of user plane event(s) to which the SCS/AS requests to
            subscribe to.
          type: array
          items:
            $ref: '#/components/schemas/UserPlaneEvent'
          minItems: 1

    QosMonitoringInformation:
      description: Represents QoS monitoring information.
      type: object
@@ -597,8 +666,11 @@ components:
      required:
        - reqQosMonParams
        - repFreqs

    QosMonitoringInformationRm:
      description: Represents the same as the QosMonitoringInformation data type but with the nullable:true property.
      description: >
        Represents the same as the QosMonitoringInformation data type but with
        the nullable:true property.
      type: object
      properties:
        reqQosMonParams:
@@ -621,6 +693,7 @@ components:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm'
        repPeriod:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm'

    QosMonitoringReport:
      description: Represents a QoS monitoring report.
      type: object
@@ -640,6 +713,10 @@ components:
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
          minItems: 1
        pdmf:
          type: boolean
          description: Represents the packet delay measurement failure indicator.

    UserPlaneNotificationData:
      description: Represents the parameters to be conveyed in a user plane event(s) notification.
      type: object
@@ -655,6 +732,7 @@ components:
      required:
        - transaction
        - eventReports

    UserPlaneEventReport:
      description: Represents an event report for user plane.
      type: object
@@ -673,7 +751,14 @@ components:
            omitted when the reported event applies to all the flows sent during the subscription.
        appliedQosRef:
          type: string
          description: The currently applied QoS reference. Applicable for event QOS_NOT_GUARANTEED or SUCCESSFUL_RESOURCES_ALLOCATION.
          description: >
            The currently applied QoS reference. Applicable for event QOS_NOT_GUARANTEED or
            SUCCESSFUL_RESOURCES_ALLOCATION.
        altQosNotSuppInd:
          type: boolean
          description: >
            When present and set to true it indicates that the Alternative QoS profiles are not
            supported by the access network. Applicable for event QOS_NOT_GUARANTEED.
        plmnId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid'
        qosMonReports:
@@ -686,6 +771,7 @@ components:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
      required:
        - event

    TscQosRequirement:
      description: Represents QoS requirements for time sensitive communication.
      type: object
@@ -702,6 +788,8 @@ components:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVol'
        req5Gsdelay:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget'
        reqPer:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate'
        priority:
          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscPriorityLevel'
        tscaiTimeDom:
@@ -710,8 +798,14 @@ components:
          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer'
        tscaiInputUl:
          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer'
        capBatAdaptation:
          type: boolean
          description: >
            Indicates the capability for AF to adjust the burst sending time, when it is supported
            and set to "true". The default value is "false" if omitted.
    TscQosRequirementRm:
      description: Represents the same as the TscQosRequirement data type but with the nullable:true property.
      description: >
        Represents the same as the TscQosRequirement data type but with the nullable:true property.
      type: object
      properties:
        reqGbrDl:
@@ -726,6 +820,8 @@ components:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm'
        req5Gsdelay:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudgetRm'
        reqPer:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRateRm'
        priority:
          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscPriorityLevelRm'
        tscaiTimeDom:
@@ -734,6 +830,26 @@ components:
          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer'
        tscaiInputUl:
          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer'
        capBatAdaptation:
          type: boolean
          description: >
            Indicates the capability for AF to adjust the burst sending time, when it is supported
            and set to "true". The default value is "false" if omitted.
          nullable: true

    AdditionInfoAsSessionWithQos:
      description: Describes additional error information specific for this API.
      type: object
      properties:
        acceptableServInfo:
          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AcceptableServiceInfo'

    ProblemDetailsAsSessionWithQos:
      description: Extends ProblemDetails to also include the acceptable service info.
      allOf:
      - $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
      - $ref: '#/components/schemas/AdditionInfoAsSessionWithQos'

    UserPlaneEvent:
      anyOf:
      - type: string
@@ -755,8 +871,9 @@ components:
          This string provides forward-compatibility with future
          extensions to the enumeration but is not used to encode
          content defined in the present version of this API.
      description: >
        Possible values are
      description: |
        Represents the user plane event.  
        Possible values are:
        - SESSION_TERMINATION: Indicates that Rx session is terminated.
        - LOSS_OF_BEARER : Indicates a loss of a bearer.
        - RECOVERY_OF_BEARER: Indicates a recovery of a bearer.
Loading