Commit 611c3a87 authored by Jesus de Gregorio's avatar Jesus de Gregorio
Browse files

CT#95

parent 7e6da86b

TS24558_Eecs_ServiceProvisioning.yaml

+115 −45
Original line number Diff line number Diff line
@@ -3,11 +3,11 @@ info: 
  title: Eecs_ServiceProvisioning

  description: |

    API for ECS Service Provisioning.

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

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

    All rights reserved.

  version: "1.0.0-alpha.1"

  version: "1.0.0-alpha.3"

externalDocs:

  description: 3GPP TS 24.558 V0.6.0 Enabling Edge Applications; Protocol specification.

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

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

security:

  - {}
@@ -19,48 +19,6 @@ servers: 
        default: https://example.com

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

paths:

  /provisioning-info/fetch:

    post:

      description: Provide the information required by the UE to access the edge services

      tags:

        - Provisioning  Information

      requestBody:

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '200':

          description: OK (The requested service provisioning information was returned successfully)

          content:

            application/json:

              schema:

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

        '204':

          description: No Content (the requested service provisioning information does not exist)

        '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'

  /subscriptions:

    post:

      description: Creates a new subscription in ECS in order to be notified of provisioning data changes of interest.
@@ -230,6 +188,97 @@ 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.

      tags:

        - Individual Service Provisioning Subscription

      parameters:

        - name: subscriptionId

          in: path

          description: Identifies an individual service provisioning subscription

          required: true

          schema:

            type: string

      requestBody:

        description: Parameters to replace the existing subscription

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '200':

          description: OK (The individual service provisioning subscription matching the subscriptionId was modified successfully)

          content:

            application/json:

              schema:

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

        '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'



  /request:

    post:

      summary: Request service provisioning information.

      operationId: RequestServProv

      tags:

        - Request Service Provisioning

      requestBody:

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '200':

          description: OK (The requested service provisioning information was returned successfully).

          content:

            application/json:

              schema:

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

        '204':

          description: No Content (the requested service provisioning information does not exist).

        '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:
@@ -405,3 +454,24 @@ components: 
      required:

        - eesId

        - eecRegConf

    ECSServProvSubscriptionPatch:

      description: Represents an individual service provisioning subscription resource.

      type: object

      properties:

        acProfs:

          type: array

          items:

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

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

        expTime:

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

        eecSvcContSupp:

          type: array

          items:

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

          description: Indicates if the EEC supports service continuity or not, also indicates which ACR scenarios are supported by the EEC.

        connInfo:

          type: array

          items:

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

          description: List of connectivity information for the UE.

TS24558_Eees_EASDiscovery.yaml

+108 −48
Original line number Diff line number Diff line
@@ -3,11 +3,11 @@ info: 
  title: Eees_EASDiscovery

  description: |

    API for EAS Discovery.

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

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

    All rights reserved.

  version: "1.0.0-alpha.1"

  version: "1.0.0-alpha.3"

externalDocs:

  description: 3GPP TS 24.558 V0.6.0 Enabling Edge Applications; Protocol specification.

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

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

security:

  - {}
@@ -188,16 +188,62 @@ paths: 
          $ref: 'TS29122_CommonData.yaml#/components/responses/503'

        default:

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

  /eas-profiles:

    get:

    patch:

      description: Partial update an existing EAS Discovery Subscription resource identified by a subscriptionId.

      tags:

        - Individual EAS Discovery Subscription

      parameters:

        - name: subscriptionId

          in: path

          description: Identifies an individual EAS discovery subscription resource 

          required: true

          schema:

            type: string

      requestBody:

        description: Parameters to replace the existing subscription

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '200':

          description: OK (An individual EAS discovery subscription resource updated successfully)

          content:

            application/json:

              schema:

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

        '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'

  /eas-profiles/request-discovery:

    post:

      description: Provides EAS information requested by the UE.

      tags:

        - EAS Profiles

      parameters:

        - name: disc-req

          in: query

          description: EAS discovery request information.

          required: false

      requestBody:

        required: true

        content:

          application/json:

            schema:

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

      responses:
@@ -230,7 +276,6 @@ paths: 
        default:

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





components:

  securitySchemes:

    oAuth2ClientCredentials:
@@ -251,21 +296,21 @@ components: 
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'

        easDiscoveryFilter:

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

        # eecSvcContinuity:

          # type: array

          # items:

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

          # description: Indicates if the EEC supports service continuity or not, also indicates which ACR scenarios are supported by the EEC.

        # eesSvcContinuity:

          # type: array

          # items:

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

          # description: Indicates if the EEC supports service continuity or not, also indicates which ACR scenarios are supported by the EEC.

        # easSvcContinuity:

          # type: array

          # items:

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

          # description: Indicates if the EEC supports service continuity or not, also indicates which ACR scenarios are supported by the EEC.

        eecSvcContinuity:

          type: array

          items:

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

          description: Indicates if the EEC supports service continuity or not, also indicates which ACR scenarios are supported by the EEC.

        eesSvcContinuity:

          type: array

          items:

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

          description: Indicates if the EEC supports service continuity or not, also indicates which ACR scenarios are supported by the EEC.

        easSvcContinuity:

          type: array

          items:

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

          description: Indicates if the EEC supports service continuity or not, also indicates which ACR scenarios are supported by the EEC.

        locInf:

          $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo'

        easTDnai:
@@ -298,11 +343,11 @@ components: 
          $ref: '#/components/schemas/EasDiscoveryFilter'

        easDynInfoFilter:

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

        # easSvcContinuity:

          # type: array

          # items:

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

          # description: Indicates if the EEC supports service continuity or not, also indicates which ACR scenarios are supported by the EEC.

        easSvcContinuity:

          type: array

          items:

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

          description: Indicates if the EEC supports service continuity or not, also indicates which ACR scenarios are supported by the EEC.

        expTime:

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

        notificationDestination:
@@ -369,11 +414,11 @@ components: 
          $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'

        svcArea:

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

        # easSvcContinuity:

          # type: array

          # items:

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

          # description: Indicates if the EEC supports service continuity or not, also indicates which ACR scenarios are supported by the EEC.

        easSvcContinuity:

          type: array

          items:

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

          description: Indicates if the EEC supports service continuity or not, also indicates which ACR scenarios are supported by the EEC.

        svcPermLevel:

          type: string

          description: Service permissions level.
@@ -387,16 +432,16 @@ components: 
      description: Represents an EAS discovery information.

      type: object

      properties:

        #eass:

          #type: array

          #items:

            #$ref: 'TS29558_CommonData.yaml#/components/schemas/EasProfile'

          #minItems: 1

          #description: Contains the list of EAS matching the discovery request filters

        eass:

          type: array

          items:

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

          minItems: 1

          description: Contains the list of EAS matching the discovery request filters

        lifeTime:

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

      #required:

        #- eass

      required:

        - eass

    EasDynamicInfoFilter:

      description: Represents EAS dynamic information changes filter.

      type: object
@@ -450,8 +495,8 @@ components: 
      type: object

      properties:

        acProf:

          description: Describes the AC Profile.

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

          # description: Describes the AC Profile.

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

      required:

        - acProf

    EASDiscEventIDs:
@@ -469,3 +514,18 @@ components: 
        Possible values are

        - EAS_AVAILABILITY_CHANGE: Represents the EAS availability change event.

        - EAS_DYNAMIC_INFO_CHANGE: Represents the EAS dynamic information change event.

    EasDiscoverySubscriptionPatch:

      description: Represents an Individual EAS Discovery Subscription resource.

      type: object

      properties:

        easDiscoveryFilter:

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

        easDynInfoFilter:

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

        easSvcContinuity:

          type: array

          items:

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

          description: Indicates if the EEC supports service continuity or not, also indicates which ACR scenarios are supported by the EEC.

        expTime:

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

TS24558_Eees_EECRegistration.yaml

+65 −3
Original line number Diff line number Diff line
@@ -3,11 +3,11 @@ info: 
  title: Eees_EECRegistration

  description: |

    API for EEC registration.

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

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

    All rights reserved.

  version: "1.0.0-alpha.1"

  version: "1.0.0-alpha.2"

externalDocs:

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

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

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

security:

  - {}
@@ -146,6 +146,57 @@ 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.

      parameters:

        - name: registrationId

          in: path

          description: Identifies an individual EEC registration

          required: true

          schema:

            type: string

      requestBody:

        description: Parameters to replace the existing registration

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '200':

          description: OK (An individual EEC registration resource updated successfully)

          content:

            application/json:

              schema:

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

        '204':

          description: No Content (An individual EEC registration resource updated successfully).

        '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:
@@ -256,3 +307,14 @@ components: 
        reqStrg:

          type: string

          description: The storage resources required by the AC.

    EECRegistrationPatch:

      description: Describes the parameters to perform EEC Registration update.

      type: object

      properties:

        acProfs:

          type: array

          items:

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

          description: Profiles of ACs for which the EEC provides edge enabling services.

        expTime:

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

TS29122_AsSessionWithQoS.yaml

+25 −11
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

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

  version: 1.2.0-alpha.3

  version: 1.2.0-alpha.4

  description: |

    API for setting us an AS session with required QoS.  

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

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

    All rights reserved.

externalDocs:

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

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

  description: 3GPP TS 29.122 V17.5.0 T8 reference point for Northbound APIs

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

security:

  - {}

  - oAuth2ClientCredentials: []
@@ -21,7 +21,7 @@ servers: 
paths:

  /{scsAsId}/subscriptions:

    get:

      summary: Read all of the active subscriptions for the SCS/AS.

      summary: Read all or queried active subscriptions for the SCS/AS.

      operationId: FetchAllASSessionWithQoSSubscriptions

      tags:

        - AS Session with Required QoS Subscriptions
@@ -36,6 +36,8 @@ paths: 
          in: query

          description: The IP address(es) of the requested UE(s).

          required: false

          content:

            application/json:

              schema:

                type: array

                items:
@@ -446,6 +448,12 @@ components: 
            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.

        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.

        disUeNotif:

          type: boolean

        ueIpv4Addr:
@@ -507,6 +515,12 @@ components: 
            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.

        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.

        disUeNotif:

          type: boolean

        usageThreshold:

TS29122_ChargeableParty.yaml

+13 −11
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: 3gpp-chargeable-party

  version: 1.2.0-alpha.5

  version: 1.2.0-alpha.6

  description: |

    API for Chargeable Party management.  

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

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

    All rights reserved.

externalDocs:

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

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

  description: 3GPP TS 29.122 V17.5.0 T8 reference point for Northbound APIs

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

security:

  - {}

  - oAuth2ClientCredentials: []
@@ -21,7 +21,7 @@ servers: 
paths:

  /{scsAsId}/transactions:

    get:

      summary: Read all chargeable party transaction resources for a given SCS/AS.

      summary: Read all or queried chargeable party transaction resources for a given SCS/AS.

      operationId: FetchAllChargeablePartyTransactions

      tags:

        - Chargeable Party Transaction Operation
@@ -36,6 +36,8 @@ paths: 
          in: query

          description: The IP address(es) of the requested UE(s).

          required: false

          content:

            application/json:

              schema:

                type: array

                items: