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

CT#100

parent 5c820cd9
Loading
Loading
Loading
Loading
+67 −26
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  title: Eecs_ServiceProvisioning
  version: "1.1.0-alpha.1"
  version: "1.1.0-alpha.2"
  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.0.0 Enabling Edge Applications; Protocol specification.
  description: 3GPP TS 24.558 V18.1.0 Enabling Edge Applications; Protocol specification.
  url: https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/

security:
@@ -23,13 +24,15 @@ servers:
        description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558

paths:

  /subscriptions:
    post:
      description: >
        Creates a new subscription in ECS in order to be notified of provisioning data
        changes of interest.
      operationId: CreateServProvSub
      tags:
        - Service Provisioning Subscriptions
        - Service Provisioning Subscriptions (Collection)
      requestBody:
        required: true
        content:
@@ -117,17 +120,18 @@ paths:
      description: >
        Updates an existing individual service provisioning subscription identified
        by the subscriptionId.
      operationId: UpdateIndServProvSub
      tags:
        - Individual Service Provisioning Subscription
        - Individual Service Provisioning Subscription (Document)
      parameters:
        - name: subscriptionId
          in: path
          description: Identifies an individual service provisioning subscription
          description: Identifies an individual service provisioning subscription.
          required: true
          schema:
            type: string
      requestBody:
        description: Parameters to replace the existing subscription
        description: Parameters to replace the existing subscription.
        required: true
        content:
          application/json:
@@ -169,12 +173,13 @@ paths:
      description: >
        Deletes an existing individual service provisioning subscription identified by
        the subscriptionId.
      operationId: DeleteIndServProvSub
      tags:
        - Individual Service Provisioning Subscription
        - Individual Service Provisioning Subscription (Document)
      parameters:
        - name: subscriptionId
          in: path
          description: Identifies an individual service provisioning subscription
          description: Identifies an individual service provisioning subscription.
          required: true
          schema:
            type: string
@@ -203,31 +208,33 @@ paths:
          $ref: 'TS29122_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29122_CommonData.yaml#/components/responses/default'

    patch:
      description: >
        Partially updates an existing individual service provisioning subscription identified
        by the subscriptionId.
      operationId: ModifyIndServProvSub
      tags:
        - Individual Service Provisioning Subscription
        - Individual Service Provisioning Subscription (Document)
      parameters:
        - name: subscriptionId
          in: path
          description: Identifies an individual service provisioning subscription
          description: Identifies an individual service provisioning subscription.
          required: true
          schema:
            type: string
      requestBody:
        description: Parameters to replace the existing subscription
        description: Parameters to replace the existing subscription.
        required: true
        content:
          application/json:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/ECSServProvSubscriptionPatch'
      responses:
        '200':
          description: >
            OK (The individual service provisioning subscription matching the subscriptionId
            was modified successfully)
            was modified successfully).
          content:
            application/json:
              schema:
@@ -277,7 +284,7 @@ paths:
                $ref: '#/components/schemas/ECSServProvResp'
        '204':
          description: >
            No Content (the requested service provisioning information does not exist).
            No Content (The requested service provisioning information does not exist).
        '400':
          $ref: 'TS29122_CommonData.yaml#/components/responses/400'
        '401':
@@ -302,6 +309,7 @@ paths:
          $ref: 'TS29122_CommonData.yaml#/components/responses/default'

components:

  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
@@ -309,7 +317,9 @@ components:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}

  schemas:

    ECSServProvReq:
      description: ECS service provisioning request information.
      type: object
@@ -338,10 +348,17 @@ components:
          description: List of connectivity information for the UE.
        locInf:
          $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo'
        ecspIds:
          type: array
          items:
            type: string
          minItems: 1
          description: Indicates to the ECS which EES providers are preferred by the EEC.
        suppFeat:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
      required:
        - eecId

    ECSServProvResp:
      description: ECS service provisioning response information.
      type: object
@@ -354,6 +371,7 @@ components:
          description: List of EDN configuration information.
      required:
        - ednCnfgInfo

    ECSServProvSubscription:
      description: Represents an individual service provisioning subscription resource.
      type: object
@@ -391,10 +409,17 @@ components:
            false or omitted otherwise.
        websockNotifConfig:
          $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'
        ecspIds:
          type: array
          items:
            type: string
          minItems: 1
          description: Indicates to the ECS which EES providers are preferred by the EEC.
        suppFeat:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
      required:
        - eecId

    ServProvNotification:
      description: Represents notification information of a service provisioning Event.
      type: object
@@ -413,17 +438,19 @@ components:
      required:
        - subId
        - ednCnfgInfo

    ConnectivityInfo:
      description: Represents the connectivity information for the UE.
      type: object
      properties:
        plmnId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
          $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid'
        ssId:
          type: string
          description: Identifies the SSID of the access point to which the UE is attached.

    EDNConfigInfo:
      description: Represents the EDN information.
      description: Represents the EDN configuration information.
      type: object
      properties:
        ednConInfo:
@@ -439,6 +466,7 @@ components:
      required:
        - ednConInfo
        - eess

    EDNConInfo:
      description: Represents an EDN connection information.
      type: object
@@ -449,20 +477,23 @@ components:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
        ednTopoSrvArea:
          $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'

    EESInfo:
      description: Represents EES information.
      type: object
      properties:
        eesId:
          type: string
          description: Identity of the EES
          description: Identity of the EES.
        endPt:
          $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint'
        easIds:
          type: array
          items:
            type: string
          description: Application identities of the Edge Application Servers registered with the EES.
          description: >
            Application identities of the Edge Application Servers registered
            with the EES.
        ecspInfo:
          type: string
          description: Represents an ECSP Information.
@@ -472,7 +503,7 @@ components:
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai'
          description: Represents list of Data network access identifier.
          description: Represents list of Data network access identifiers.
        eesSvcContSupp:
          type: array
          items:
@@ -485,11 +516,21 @@ components:
          description: >
            Indicates whether the EEC is required to register on the EES to use edge services
            or not.
        easInstInfos:
          type: array
          items:
            $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/EASInstantiationInfo'
          minItems: 1
          description: >
            The EAS instantiation status per EASID (e.g. instantiated, instantiable but not be
            instantiated yet).
      required:
        - eesId
        - eecRegConf

    ECSServProvSubscriptionPatch:
      description: Represents an individual service provisioning subscription resource.
      description: >
            Represents modifications to an individual service provisioning subscription resource.
      type: object
      properties:
        acProfs:
+30 −16
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  title: Eees_ACREvents
  version: "1.0.2"
  version: "1.1.0-alpha.1"
  description: |
    API for ACR events subscription and notification.  
    © 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.2.0 Enabling Edge Applications; Protocol specification.
    3GPP TS 24.558 V18.1.0 Enabling Edge Applications; Protocol specification.
  url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/'

security:
@@ -23,6 +25,7 @@ servers:
        description: apiRoot as defined in clause 6.1 of 3GPP TS 24.558

paths:

  /subscriptions:
    post:
      description: Creates a new individual ACR events subscription.
@@ -44,7 +47,7 @@ paths:
                $ref: '#/components/schemas/ACREventsSubscription'
          headers:
            Location:
              description: Contains the URI of the newly created resource
              description: Contains the URI of the newly created resource.
              required: true
              schema:
                type: string
@@ -74,7 +77,7 @@ paths:
        notificationDestination:
          '{request.body#/notificationDestination}':
            post:
              requestBody:  # contents of the callback message
              requestBody:  # Contents of the callback message.
                required: true
                content:
                  application/json:
@@ -120,12 +123,12 @@ paths:
      parameters:
        - name: subscriptionId
          in: path
          description: Identifies an individual ACR Events subscription resource 
          description: Identifies an individual ACR Events subscription resource.
          required: true
          schema:
            type: string
      requestBody:
        description: Parameters to replace the existing subscription
        description: Parameters to replace the existing subscription.
        required: true
        content:
          application/json:
@@ -204,9 +207,11 @@ paths:
          $ref: 'TS29122_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29122_CommonData.yaml#/components/responses/default'

    patch:
      description: >
        Partially modifyan existing individual ACR events subscription identified by the subscriptionId.
        Partially modifies an existing individual ACR events subscription identified by
        the subscriptionId.
      operationId: ModifyACREventsSubscription
      tags:
        - Individual ACR Events Subscription
@@ -218,7 +223,7 @@ paths:
          schema:
            type: string
      requestBody:
        description: Parameters to replace the existing subscription
        description: Parameters to replace the existing subscription.
        required: true
        content:
          application/merge-patch+json:
@@ -262,6 +267,7 @@ paths:
          $ref: 'TS29122_CommonData.yaml#/components/responses/default'

components:

  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
@@ -269,7 +275,9 @@ components:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}

  schemas:

    ACREventsSubscription:
      description: ACE Events subscription request.
      type: object
@@ -291,7 +299,7 @@ components:
          type: array
          items:
            type: string
          description: List of AC identities
          description: List of AC identities.
        eventIds:
          $ref: '#/components/schemas/ACREventIDs'
        notificationDestination:
@@ -310,6 +318,7 @@ components:
        - easIds
        - eventIds
        - notificationDestination

    ACRInfoNotification:
      description: Notification of ACR events information.
      type: object
@@ -333,11 +342,11 @@ components:
          $ref: '#/components/schemas/ACRCompleteEventInfo'
        eecCtxtReloc:
          $ref: '#/components/schemas/EecCtxtRelocStatus'

      required:
        - subId
        - easId
        - eventId

    TargetInfo:
      description: Details of the selected T-EAS and the T-EES.
      type: object
@@ -346,6 +355,7 @@ components:
          $ref: 'TS24558_Eees_EASDiscovery.yaml#/components/schemas/DiscoveredEas'
        trgetEESInfo:
          $ref: 'TS24558_Eecs_ServiceProvisioning.yaml#/components/schemas/EDNConfigInfo'

    ACREventsSubscriptionPatch:
      description: An individual ACR events subscription resource to be updated.
      type: object
@@ -362,6 +372,7 @@ components:
          $ref: '#/components/schemas/ACREventIDs'
        notificationDestination:
          $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'

    ACREventIDs:
      anyOf:
      - type: string
@@ -371,18 +382,21 @@ components:
      - type: string
        description: >
          This string provides forward-compatibility with future
          extensions to the enumeration but is not used to encode
          extensions to the enumeration and is not used to encode
          content defined in the present version of this API.
      description: >
        Possible values are
      description: |
        Represents the ACR events.  
        Possible values are:
        - TARGET_INFORMATION: Represents the target information event.
        - ACR_COMPLETE: Represents the ACR complete event.

    EecCtxtRelocStatus:
      description: Indicates the registration id and expiry time of the registration.
      type: object
      properties:
        implReg:
          $ref: 'TS29558_Eees_EECContextRelocation.yaml#/components/schemas/ImplicitRegDetails'

    ACRCompleteEventInfo:
      description: Indicates the completed ACR result and target EAS endpoint info.
      type: object
+4 −2
Original line number Diff line number Diff line
openapi: 3.0.0
info:
  title: Eees Application Context Relocation Service
  version: "1.1.0-alpha.1"
  version: "1.1.0-alpha.2"
  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.0.0; Enabling Edge Applications; Protocol specification; Stage 3.
    3GPP TS 24.558 V18.1.0; Enabling Edge Applications; Protocol specification; Stage 3.
  url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/24.558/'

servers:
@@ -211,6 +211,8 @@ components:
          default: false
        eecCtxtReloc:
          $ref: '#/components/schemas/EecCtxtReloc'
        predictExpTime:
          $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
      required:
        - requestorId
        - tEasEndpoint
+99 −28

File changed.

Preview size limit exceeded, changes collapsed.

+80 −27
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  title: Eees_EECRegistration
  version: "1.1.0-alpha.1"
  version: "1.1.0-alpha.2"
  description: |
    API for EEC registration.  
    © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    All rights reserved.

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

security:
@@ -23,8 +25,12 @@ servers:
        description: apiRoot as defined in clause 6.1 of 3GPP TS 24.558

paths:

  /registrations:
    post:
      operationId: CreateEECReg
      tags:
        - EEC Registrations (Collection)
      description: Create a new EEC registration at the EES.
      requestBody:
        required: true
@@ -65,18 +71,22 @@ paths:
          $ref: 'TS29122_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29122_CommonData.yaml#/components/responses/default'

  /registrations/{registrationId}:
    put:
      operationId: UpdateIndEECReg
      tags:
        - Individual EEC registration (Document)
      description: Update an existing EEC registration a the EES.
      parameters:
        - name: registrationId
          in: path
          description: Identifies an individual EEC registration
          description: Identifies an individual EEC registration.
          required: true
          schema:
            type: string
      requestBody:
        description: Parameters to replace the existing registration
        description: Parameters to replace the existing registration.
        required: true
        content:
          application/json:
@@ -120,11 +130,14 @@ paths:
          $ref: 'TS29122_CommonData.yaml#/components/responses/default'

    delete:
      description: Remove an existing ECC registration at EES.
      operationId: DeleteIndEECReg
      tags:
        - Individual EEC registration (Document)
      description: Remove an existing EEC registration at EES.
      parameters:
        - name: registrationId
          in: path
          description: Identifies an individual EEC registration
          description: Identifies an individual EEC registration.
          required: true
          schema:
            type: string
@@ -152,20 +165,24 @@ paths:
          $ref: 'TS29122_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29122_CommonData.yaml#/components/responses/default'

    patch:
      description: partially update an existing EEC registration a the EES.
      operationId: ModifyIndEECReg
      tags:
        - Individual EEC registration (Document)
      description: Partially update an existing EEC registration a the EES.
      parameters:
        - name: registrationId
          in: path
          description: Identifies an individual EEC registration
          description: Identifies an individual EEC registration.
          required: true
          schema:
            type: string
      requestBody:
        description: Parameters to replace the existing registration
        description: Parameters to replace the existing registration.
        required: true
        content:
          application/json:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/EECRegistrationPatch'
      responses:
@@ -206,6 +223,7 @@ paths:
          $ref: 'TS29122_CommonData.yaml#/components/responses/default'

components:

  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
@@ -215,6 +233,7 @@ components:
          scopes: {}

  schemas:

    EECRegistration:
      description: Describes the parameters to perform EEC Registration related operations.
      type: object
@@ -244,12 +263,29 @@ components:
          description: Identifier of the EES that provided EEC context ID.
        endPt:
          $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint'
        ueMobilityReq:
          type: boolean
          description: >
            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.
        unfulfillAcProfs:
          type: array
          items:
            $ref: '#/components/schemas/UnfulfilledAcProfile'
          minItems: 1
          description: >
            A list of ACIDs of the AC Profile(s) sent from EES, for which the requirements
            indicated in the AC profile(s) cannot be fulfilled.
        unfulfilledAcProfs:
          $ref: '#/components/schemas/UnfulfilledAcProfile'
      not:
        required: [ unfulfilledAcProfs, unfulfillAcProfs ]
      required:
        - eecId

    ACProfile:
      description: ECS service provisioning response information.
      description: AC information indicating required services and service characteristics.
      type: object
      properties:
        acId:
@@ -271,7 +307,7 @@ components:
          type: array
          items:
            $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario'
          description: Profiles of ACs for which the EEC provides edge enabling services.
          description: The ACR scenarios supported by the AC for service continuity.
        simInactTime:
          $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'
        eass:
@@ -280,8 +316,11 @@ components:
            $ref: '#/components/schemas/EasDetail'
          minItems: 1
          description: List of EAS information.
        easBundleInfo:
          $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EASBundleInfo'
      required:
        - acId

    EasDetail:
      description: EAS details.
      type: object
@@ -295,8 +334,9 @@ components:
          $ref: '#/components/schemas/ACServiceKPIs'
      required:
        - easId

    ACServiceKPIs:
      description: EAS details.
      description: Describes the KPIs required by the AC in order to receive required services.
      type: object
      properties:
        connBand:
@@ -319,6 +359,7 @@ components:
        reqStrg:
          type: string
          description: The storage resources required by the AC.

    EECRegistrationPatch:
      description: Describes the parameters to perform EEC Registration update.
      type: object
@@ -330,10 +371,12 @@ components:
          description: Profiles of ACs for which the EEC provides edge enabling services.
        expTime:
          $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
        unfulfilledAcProfs:
          $ref: '#/components/schemas/UnfulfilledAcProfile'
        ueMobilityReq:
          type: boolean
          description: Indicates whether UE requires mobility support or not.

    UnfulfilledAcProfile:
      description: Desrcibes AC Profile ID and reason sent by EES in EEC Register response.
      description: Describes AC Profile ID and reason sent by EES in EEC Register response.
      type: object
      properties:
        acId:
@@ -341,10 +384,20 @@ components:
          description: The AC ID of a AC profile.
        reason:
          $ref: '#/components/schemas/UnfulfillACProfRsn'

    UnfulfillACProfRsn:
      anyOf:
        - type: string
          enum:
            - EAS_NOT_AVAILABLE
            - REQ_UNFULFILLED
      description: represents reason for unfulfilled AC profile requirements.
        - 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 reason for unfulfilled AC profile requirements.
        Possible values are:
        - EAS_NOT_AVAILABLE: EAS is not available.
        - REQ_UNFULFILLED: Requirements cannot be fulfilled.
Loading