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

CT#103

parent 3219f6aa

TS24558_Eecs_ServiceProvisioning.yaml

+59 −5
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.4"

  version: "1.1.0-alpha.5"

  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.3.0 Enabling Edge Applications; Protocol specification.

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

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



security:
@@ -334,6 +334,8 @@ components: 
          items:

            $ref: 'TS24558_Eees_EECRegistration.yaml#/components/schemas/ACProfile'

          description: Information about services the EEC wants to connect to.

        appGroupProfile:

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

        eecSvcContSupp:

          type: array

          items:
@@ -369,6 +371,12 @@ components: 
            $ref: '#/components/schemas/EDNConfigInfo'

          minItems: 1

          description: List of EDN configuration information.

        redirectedECS:

          type: array

          items:

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

          minItems: 1

          description: List of redirected ECS information.

      required:

        - ednCnfgInfo
@@ -440,6 +448,12 @@ components: 
            $ref: '#/components/schemas/EDNConfigInfo'

          minItems: 1

          description: List of EDN configuration information.

        redirectedECS:

          type: array

          items:

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

          minItems: 1

          description: List of redirected ECS information.

      required:

        - subId

        - ednCnfgInfo
@@ -454,6 +468,23 @@ components: 
          type: string

          description: Identifies the SSID of the access point to which the UE is attached.



    AppGroupProfile:

      description: Represents the application group profile for common EAS.

      type: object

      properties:

        appGrpId:

          type: string

          description: Represents the application group that uniquely identifies

            the group of UEs using the same application.

        easId:

          type: string

          description: Represents the application identifier of the EAS.

        expectedSvcArea:

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

      required:

        - appGrpId

        - easId



    EDNConfigInfo:

      description: Represents the EDN configuration information.

      type: object
@@ -472,6 +503,21 @@ components: 
        - ednConInfo

        - eess



    ECSRedirectInfo:

      description: >

        Represents ECS information where the EEC shall redirect the ECS Service

        Provisioning request.

      type: object

      properties:

        ecsEndPt:

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

        dnn:

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

        snssai:

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

      required:

        - ecsEndPt



    EDNConInfo:

      description: Represents an EDN connection information.

      type: object
@@ -499,6 +545,11 @@ components: 
          description: >

            Application identities of the Edge Application Servers registered

            with the EES.

        appGroupIdList:

          type: array

          items:

            type: string

          description: List of Application Group IDs associated with EAS.

        ecspInfo:

          type: string

          description: Represents an ECSP Information.
@@ -536,8 +587,12 @@ components: 
          minItems: 1

          description: >

            Indicates the authentication methods supported by the EES.

        easBundleInfo:

        easBundleInfos:

          type: array

          items:

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

          minItems: 1

          description: List of EAS bundles to which the EAS belongs.

      required:

        - eesId

        - eecRegConf
@@ -587,4 +642,3 @@ components: 
          items:

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

          description: List of connectivity information for the UE.

TS24558_Eees_ACREvents.yaml

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


info:

  title: Eees_ACREvents

  version: "1.1.0-alpha.2"

  version: "1.1.0-alpha.3"

  description: |

    API for ACR events subscription and notification.  

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


externalDocs:

  description: >

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

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

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



security:
@@ -342,6 +342,17 @@ components: 
          $ref: '#/components/schemas/ACRCompleteEventInfo'

        eecCtxtReloc:

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

        acrScenarioList:

          type: array

          items:

            $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario'

        easBundleInfo:

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

        tEasEndPointBundleList:

          type: array

          items:

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

          minItems: 1

      required:

        - subId

        - easId
@@ -412,5 +423,3 @@ components: 
      required:

        - acrRes

        - tEasEndpoint

TS24558_Eees_AppContextRelocation.yaml

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

info:

  title: Eees Application Context Relocation Service

  version: "1.1.0-alpha.3"

  version: "1.1.0-alpha.4"

  description: |

    Eees Application Context Relocation Service.  

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


externalDocs:

  description: >

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

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

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



servers:
@@ -213,10 +213,19 @@ components: 
          default: false

        eecCtxtReloc:

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

        predictExpTime:

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

        expectedLocArea:

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

        acrParams:

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

        acrModificationParams:

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

        easBundleInfo:

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

        tEasEndPointBundleList:

          type: array

          items:

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

          minItems: 1

      required:

        - requestorId

        - tEasEndpoint
@@ -238,6 +247,13 @@ components: 
          $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint'

        expectedLocArea:

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

        easBundleInfo:

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

        tEasEndPointBundleList:

          type: array

          items:

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

          minItems: 1

      required:

        - ueId

        - tEasId
@@ -269,3 +285,23 @@ components: 
          $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo'

        svcArea:

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



    AcrParameters:

      description: >

        Represents ACR parameters specific to ACR request initiated for Service continuity planning.

      type: object

      properties:

        predictExpTime:

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



    AcrModificationParams:

      description: >

        Represents ACR parameters specific to ACR modification request.

      type: object

      properties:

        sEasEndpoint:

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

        tEasEndpoint:

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

        acrParams:

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

TS24558_Eees_EASDiscovery.yaml

+6 −3
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.4"

  version: "1.1.0-alpha.5"



externalDocs:

  description: >

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

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

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



security:
@@ -510,6 +510,8 @@ components: 
            $ref: '#/components/schemas/ACCharacteristics'

          minItems: 1

          description: AC description for which an EAS is needed.

        appGroupProfile:

            $ref: 'TS24558_Eecs_ServiceProvisioning.yaml#/components/schemas/AppGroupProfile'

        easChars:

          type: array

          items:
@@ -573,6 +575,8 @@ components: 
      properties:

        eas:

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

        eesEndPt:

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

        lifeTime:

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

      required:
@@ -732,4 +736,3 @@ components: 
      properties:

        numRecPerf:

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

TS24558_Eees_EASInformationProvisioning.yaml

0 → 100644
+216 −0
Original line number Diff line number Diff line 
openapi: 3.0.0



info:

  title: Eees_EASInformationProvisioning

  version: "1.1.0-alpha.0"

  description: |

    API for EAS Information Provisioning.  

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

    All rights reserved.



externalDocs:

  description: >

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

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



security:

  - {}

  - oAuth2ClientCredentials: []



servers:

  - url: '{apiRoot}/eees-easinfoprov/v1'

    variables:

      apiRoot:

        default: https://example.com

        description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558.



paths:



  /declare:

    post:

      operationId: declare

      tags:

        - EAS Information Provision

      description: Declare EAS information provisioning to the EES.

      requestBody:

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '200':

          description: Information about the successful EAS information provisioning response.

          content:

            application/json:

              schema:

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

        '204':

          description: No Content (EAS information request is processed and successful)

        '307':

          $ref: 'TS29122_CommonData.yaml#/components/responses/307'

        '308':

          $ref: 'TS29122_CommonData.yaml#/components/responses/308'

        '400':

          $ref: 'TS29122_CommonData.yaml#/components/responses/400'

        '401':

          $ref: 'TS29122_CommonData.yaml#/components/responses/401'

        '403':

          $ref: 'TS29122_CommonData.yaml#/components/responses/403'

        '404':

          $ref: 'TS29122_CommonData.yaml#/components/responses/404'

        '411':

          $ref: 'TS29122_CommonData.yaml#/components/responses/411'

        '413':

          $ref: 'TS29122_CommonData.yaml#/components/responses/413'

        '415':

          $ref: 'TS29122_CommonData.yaml#/components/responses/415'

        '429':

          $ref: 'TS29122_CommonData.yaml#/components/responses/429'

        '500':

          $ref: 'TS29122_CommonData.yaml#/components/responses/500'

        '503':

          $ref: 'TS29122_CommonData.yaml#/components/responses/503'

        default:

          $ref: 'TS29122_CommonData.yaml#/components/responses/default'





components:



  securitySchemes:

    oAuth2ClientCredentials:

      type: oauth2

      flows:

        clientCredentials:

          tokenUrl: '{tokenUrl}'

          scopes: {}



  schemas:



    EASInfoProvReq:

      description: Describes the parameters shared to perform EAS Information Provision related operations.

      type: object

      properties:

        eecId:

          type: string

          description: Represents a unique identifier of the EEC.

        acId:

          type: string

          description: Identity of the AC.

        selEasIds:

          type: array

          items:

            type: string

          minItems: 1

          description: Indicates the identifier(s) of the selected EAS(s) for EAS bundles, which is either instantiated or instantiable..

        appGrpId:

          type: string

          description: >

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

            application service.

        eesList:

          type: array

          items:

            $ref: 'TS24558_Eecs_ServiceProvisioning.yaml#/components/schemas/EESInfo'

          minItems: 1

          description: Contains the list of EES which supports the application group identifier.

        reqType:

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

        selAcrScenarios:

          type: array

          items:

            $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario'

          minItems: 1

          description: >

            Indicates if the list of ACR scenarios are selected by the EEC.

        selEasEndPoints:

          type: array

          items:

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

          minItems: 1

          description: >

            Indicates the endpoints of the selected EAS(s) for EAS bundles.

        dnais:

          type: array

          items:

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

          minItems: 1

          description: Represents list of Data network access identifiers for each selected EAS indetifier.

        svcArea:

          type: array

          items:

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

          minItems: 1

          description: Represents list of service are for each selected EAS indetifier.

        assEesEndPoints:

          type: array

          items:

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

          minItems: 1

          description: >

            Indicates the endpoints of the selected EES(s) of other EES which support the direct bundled EAS within the same EDN and associated with the EASID list for EAS bundles.

        casInfo:

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

        acProf:

          $ref: 'TS24558_Eees_EECRegistration.yaml#/components/schemas/ACProfile'

        eecSvcContSupp:

          type: array

          items:

            $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario'

          minItems: 1

          description: >

            Indicates which ACR scenarios are supported by the EEC, if this attribute is not present, then the EEC does not support service continuity. 

      required:

        - eecId

        - acId

        - selEasIds



    EASInfoProvResp:

      description: Information about the EAS information provisioning response.

      type: object

      properties:

        selAcrScenarioList:

          type: array

          items:

            $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario'

          minItems: 1

          description: >

            Indicates the list of ACR scenarios are selected by the EES.

        instEasInfo:

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

        comEasEndpoint:

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

        comEesEndpoint:

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



    InstantiatedEASInfo:

      description: EAS details.

      type: object

      properties:

        eas:

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

        lifeTime:

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

        eesEndpoint:

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

      required:

        - eas



    EasInfoProvReqType:

      anyOf:

      - type: string

        enum:

          - ACR_SCENARIO_SELECTION_ANNOUNCEMENT

          - ACR_SCENARIO_SELECTION_REQUEST

          - EAS_SELECTION

      - 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 type of EAS Information Provisioning Request.

        Possible values are:

        - ACR_SCENARIO_SELECTION_ANNOUNCEMENT: Indicates EAS information provisioning request type is ACR scenario selection announcement.

        - ACR_SCENARIO_SELECTION_REQUEST: Indicates EAS information provisioning request type is ACR scenario selection request.

        - EAS_SELECTION: Indicates EAS information provisioning request type is EAS selection.