Commit dbf311f3 authored by elmoatamida's avatar elmoatamida
Browse files

Upload1 CT3#146 New SDD_BroadcastMulticastDelivery API

parent eafb2c6a

TS29548_SDD_BroadcastMulticastDelivery.yaml

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



info:

  title: SEALDD Multicast/Broadcast Delivery Service

  version: 1.0.0-alpha.1

  description: |

    SEALDD Server Multicast/Broadcast Delivery Service.  

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

    All rights reserved.



externalDocs:

  description: >

    3GPP TS 29.548 V20.0.0; Service Enabler Architecture Layer for Verticals (SEAL);

    SEAL Data Delivery (SEALDD) Server Services; Stage 3.

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



servers:

  - url: '{apiRoot}/sdd-mbs/v1'

    variables:

      apiRoot:

        default: https://example.com

        description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549



security:

  - {}

  - oAuth2ClientCredentials: []



paths:

  /mbs-deliveries:

    post:

      summary: Request the creation of an MBS Delivery.

      operationId: CreateMBSDelivery

      tags:

        - MBS Deliveries (Collection)

      requestBody:

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '201':

          description: >

            Created. The MBS Delivery is successfully created and a representation of the

            created Individual MBS Delivery resource shall be returned.

          content:

            application/json:

              schema:

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

          headers:

            Location:

              description: >

                Contains the URI of the created Individual MBS Delivery resource.

              required: true

              schema:

                type: string

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



  /mbs-deliveries/{mbsDelId}:

    parameters:

      - name: mbsDelId

        in: path

        description: >

          Represents the identifier of the Individual MBS Delivery resource.

        required: true

        schema:

          type: string



    get:

      summary: Retrieve an existing Individual MBS Delivery resource.

      operationId: GetIndMBSDelivery

      tags:

        - Individual MBS Delivery (Document)

      responses:

        '200':

          description: >

            OK. The requested Individual MBS Delivery resource shall be returned.

          content:

            application/json:

              schema:

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

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

        '406':

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

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



    put:

      summary: Request the update of an existing Individual MBS Delivery resource.

      operationId: UpdateIndMBSDelivery

      tags:

        - Individual MBS Delivery (Document)

      requestBody:

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '200':

          description: >

            OK. The Individual MBS Delivery resource is successfully updated and a

            representation of the updated resource shall be returned in the response body.

          content:

            application/json:

              schema:

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

        '204':

          description: >

            No Content. The Individual MBS Delivery resource is successfully updated

            and no content is returned in the response body.

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



    patch:

      summary: Request the modification of an existing Individual MBS Delivery resource.

      operationId: ModifyIndMBSDelivery

      tags:

        - Individual MBS Delivery (Document)

      requestBody:

        required: true

        content:

          application/merge-patch+json:

            schema:

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

      responses:

        '200':

          description: >

            OK. The Individual MBS Delivery resource is successfully modified and a

            representation of the updated resource shall be returned in the response body.

          content:

            application/json:

              schema:

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

        '204':

          description: >

            No Content. The Individual MBS Delivery resource is successfully modified and

            no content is returned in the response body.

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

      summary: Request the deletion of an existing Individual MBS Delivery resource.

      operationId: DeleteIndMBSDelivery

      tags:

        - Individual MBS Delivery (Document)

      responses:

        '204':

          description: >

            No Content. The Individual MBS Delivery resource is successfully deleted.

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



#

# STRUCTURED DATA TYPES

#



    MBSDelivery:

      description: >

        Represents a SEALDD MBS Delivery.

      type: object

      properties:

        appTrafficIds:

          type: array

          items:

            type: string

          minItems: 1

        dataDelReqs:

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

        ingressAddr:

          $ref: 'TS29548_SDD_Transmission.yaml#/components/schemas/ConnInfo'

        sddServingAddr:

          $ref: 'TS29548_SDD_Transmission.yaml#/components/schemas/ConnInfo'

        suppFeat:

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

      required:

        - appTrafficIds

        - dataDelReqs



    MBSDeliveryPatch:

      description: >

        Represents the parameters to request the modification of an existing SEALDD MBS Delivery.

      type: object

      properties:

        dataDelReqs:

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

        ingressAddr:

          $ref: 'TS29548_SDD_Transmission.yaml#/components/schemas/ConnInfo'



    MBSDelReqs:

      description: >

        Represents the MBS data delivery requirements.

      type: object

      properties:

        servType:

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

        servArea:

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

        valGroupId:

          type: string

        valUeIdsList:

          type: array

          items:

            type: string

          minItems: 1

        valUserIdsList:

          type: array

          items:

            type: string

          minItems: 1

        delPeriods:

          type: array

          items:

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

          minItems: 1

        qosReqs:

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

      required:

        - servType



    MbsDelQoSReqs:

      description: >

        Represents the QoS requirments for MBS Data Delivery.

      type: object

      properties:

        minLatency:

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

        avgLatency:

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

        maxLatency:

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

        minBitRate:

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

        avgBitRate:

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

        maxBitRate:

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

        minPackLossRate:

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

        avgPackLossRate:

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

        maxPackLossRate:

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

        minPackErrRate:

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

        avgPackErrRate:

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

        maxPackErrRate:

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

        minJitter:

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

        avgJitter:

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

        maxJitter:

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

      anyOf:

        - required: [minLatency]

        - required: [avgLatency]

        - required: [maxLatency]

        - required: [minBitRate]

        - required: [avgBitRate]

        - required: [maxBitRate]

        - required: [minPackLossRate]

        - required: [avgPackLossRate]

        - required: [maxPackLossRate]

        - required: [minPackErrRate]

        - required: [avgPackErrRate]

        - required: [maxPackErrRate]

        - required: [minJitter]

        - required: [avgJitter]

        - required: [maxJitter]



#

# SIMPLE DATA TYPES

#



#

# ENUMERATIONS

#



# Data types describing alternative data types or combinations of data types:

#



#