Commit 2325ba3e authored by Jesus de Gregorio's avatar Jesus de Gregorio
Browse files

CT#93

parent 75bc81fa

TS24558_Eees_EECRegistration.yaml

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

info:

  title: Eees_EECRegistration

  description: |

    API for EEC registration.

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

    All rights reserved.

  version: "1.0.0-alpha.1"

externalDocs:

  description: 3GPP TS 24.558 V0.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-eecregistration/v1'

    variables:

      apiRoot:

        default: https://example.com

        description: apiRoot as defined in clause 6.1 of 3GPP TS 24.558

paths:

  /registrations:

    post:

      description: Create a new EEC registration at the EES.

      requestBody:

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '201':

          description: Created (EEC information is registered successfully at EES)

          content:

            application/json:

              schema:

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

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

  /registrations/{registrationId}:

    put:

      description: 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/EECRegistration'

      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'



    delete:

      description: Remove an existing ECC registration at EES.

      parameters:

        - name: registrationId

          in: path

          description: Identifies an individual EEC registration

          required: true

          schema:

            type: string

      responses:

        '204':

          description: No Content (An individual EEC registration resource deleted 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'

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

    EECRegistration:

      description: Describes the parameters to perform EEC Registration related operations.

      type: object

      properties:

        eecId:

          type: string

          description: Represents a unique identifier of the EEC.

        ueId:

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

        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'

        # eecSvcContSupp:

          # type: array

          # items:

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

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

        eecCntxId:

          type: string

          description: Identifier of the EEC context obtained from a previous registration.

        srcEesId:

          type: string

          description: Identifier of the EES that provided EEC context ID.

        # endPt:

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

      required:

        - eecId

    ACProfile:

      description: ECS service provisioning response information.

      type: object

      properties:

        acId:

          type: string

          description: Identity of the AC.

        acType:

          type: string

          description: The category or type of AC.

        prefEcsps:

          type: array

          items:

            type: string

          description: Indicates to the ECS which ECSPs are preferred for the AC.

        acSchedule:

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

        expAcGeoServArea:

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

        # acSvcContSupp:

          # type: array

          # items:

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

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

        eass:

          type: array

          items:

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

          minItems: 1

          description: List of EAS information.

      required:

        - acId

    EasDetail:    

      description: EAS details.

      type: object

      properties:  

        easId:

          type: string

          description: Identifier of the EAS.          

        expectedSvcKPIs:  

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

        minimumReqSvcKPIs:  

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

      required:

        - easId

    ACServiceKPIs:       

      description: EAS details.

      type: object

      properties:  

        connBand:

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

        reqRate:

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

        respTime:

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

        avail:

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

        reqComp:

          type: string

          description: The compute resources required by the AC.

        reqGrapComp:

          type: string

          description: The graphical compute resources required by the AC.

        reqMem:

          type: string

          description: The memory resources required by the AC.

        reqStrg:

          type: string

          description: The storage resources required by the AC.

TS29122_AsSessionWithQoS.yaml

+7 −3
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

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

  version: 1.2.0-alpha.1

  version: 1.2.0-alpha.2

  description: |

    API for setting us an AS session with required QoS.

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

    All rights reserved.

externalDocs:

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

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

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

security:

  - {}
@@ -609,6 +609,8 @@ components: 
          $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVol'

        req5Gsdelay:

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

        priority:

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

        tscaiTimeDom:

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

        tscaiInputDl:
@@ -631,8 +633,10 @@ components: 
          $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm'

        req5Gsdelay:

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

        priority:

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

        tscaiTimeDom:

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

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

        tscaiInputDl:

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

        tscaiInputUl:

TS29122_ChargeableParty.yaml

+8 −2
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: 3gpp-chargeable-party

  version: 1.2.0-alpha.3

  version: 1.2.0-alpha.4

  description: |

    API for Chargeable Party management.

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

    All rights reserved.

externalDocs:

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

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

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

security:

  - {}
@@ -374,6 +374,12 @@ components: 
          $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ServAuthInfo'

        usageThreshold:

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

        events:

          type: array

          items:

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

          minItems: 1

          description: Event list to which the SCS/AS may subscribe.

      required:

        - notificationDestination

        - sponsorInformation

TS29122_CommonData.yaml

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

info:

  title: TS 29.122 Common Data Types

  version: 1.2.0-alpha.3

  version: 1.2.0-alpha.4

  description: |

    Data types applicable to several APIs.

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

    All rights reserved.

externalDocs:

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

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

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

paths: {}

components:
@@ -409,6 +409,7 @@ components: 
          - RELEASE_OF_BEARER

          - USAGE_REPORT

          - FAILED_RESOURCES_ALLOCATION

          - SUCCESSFUL_RESOURCES_ALLOCATION

      - type: string

        description: >

          This string provides forward-compatibility with future
@@ -422,6 +423,7 @@ components: 
        - RELEASE_OF_BEARER: Indicates a release of a bearer.

        - USAGE_REPORT: Indicates the usage report event. 

        - FAILED_RESOURCES_ALLOCATION: Indicates the resource allocation is failed.

        - SUCCESSFUL_RESOURCES_ALLOCATION: Indicates the resource allocation is successful.

    ResultReason:

      anyOf:

      - type: string

TS29122_DeviceTriggering.yaml

+5 −3
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: 3gpp-device-triggering

  version: 1.2.0-alpha.1

  version: 1.2.0-alpha.2

  description: |

    API for device trigger.

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

    All rights reserved.

externalDocs:

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

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

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

security:

  - {}
@@ -238,6 +238,8 @@ paths: 
            application/json:

              schema:

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

        '204':

          description: No Content (Successful update of the device triggering)

        '307':

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

        '308':
@@ -345,7 +347,7 @@ components: 
          $ref: 'TS29122_CommonData.yaml#/components/schemas/Link'

        requestTestNotification:

          type: boolean

          description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in subclause 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 subclause 5.2.5.3. Set to false or omitted otherwise.

        websockNotifConfig:

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

        deliveryResult: