Content for TS 26.517 Word version: 18.4.0

A.2 JSON-based representation B.1 XML-based representation B.2 JSON-based representation C.1 General C.2 Controlled vocabulary of conformance profile identifiers
...

A (Normative) Syntax for Service Announcement p. 44

A.1 Void

A.2 JSON-based representation p. 44

A.2.1 MBS User Service Announcement schema p. 44

Below is the schema specifying the format of User Service Descriptions instance documents using a JSON-based representation. The schema filename is "TS26517_MBSUserServiceAnnouncement.yaml".

Documents following this schema shall be identified with the MIME media type application/3gpp-mbs-user-service-descriptions+json as registered in clause E.2.1 including the following parameters:

The profiles parameter (see clause E.2.2) shall include a fully-qualified term identifier from the controlled vocabulary specified in clause C.2.
The version parameter (see clause E.2.3) shall contain the value "Rel18" to indicate conformance with this version of the present document.

openapi: 3.0.0
info:
  title: 'MBS User Service Announcement'
  version: 2.1.0
  description: |
    MBS User Service Announcement Element units.
    © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
    All rights reserved.
externalDocs:
  description: 3GPP TS 26.517 V18.3.0; 5G Multicast-Broadcast User Services; Protocols and Formats
  url: http://www.3gpp.org/ftp/Specs/archive/26_series/26.517/
paths:
  /user-service-descriptions:
    get:
      operationId: discoverUserServiceDescriptions
      summary: 'Discover User Service Descriptions'
      description: 'Discover User Service Descriptions that match the supplied query filter(s). At least
      one filter query parameter must be included in the request URL.'
      parameters:
        - in: query
          name: service-class
          schema:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
          required: true
          description: 'Filter for User Service Descriptions tagged with the supplied service class term
            identifier expressed as a fully-qualified URI string from a controlled vocabulary'
      responses:
        '200':
          # OK
          description: "Success"
          content:
            multipart/related:
              schema:
                type: string
        '204':
          # No Content (no matching User Service Descriptions)
          description: "No Matches Found"
        '500':
          # Internal Server Error
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '503':
          # Service Unavailable
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'
  /user-service-descriptions/{externalServiceId}:
    get:
      operationId: retrieveUserServiceDescription
      summary: 'Retrieve User Service Description'
      description: 'Retrieve the User Service Description of a single service by supplying its external
        service identifier.'
      parameters:
        - name: externalServiceId
          in: path
          required: true
          schema:
            type: string
          description: 'The external service identifier of a User Service provisioned in the MBSF.'
      responses:
        '200':
          # OK
          description: "Success"
          content:
            multipart/related:
              schema:
                type: string
        '404':
          # Not Found
          $ref: 'TS29571_CommonData.yaml#/components/responses/404'
        '500':
          # Internal Server Error
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '503':
          # Service Unavailable
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'
components:
  schemas:
    UserServiceDescriptions:
      description: 'A document announcing one or more MBS User Services.'
      type: object
      properties:
        version:
          type: integer
          minimum: 1
        userServiceDescriptions:
          type: array
          items:
            $ref: '#/components/schemas/UserServiceDescription'
          minItems: 1
      required:
        - userServiceDescriptions
    UserServiceDescription:
      description: 'A description of a single MBS User Service.'
      type: object
      properties:
        serviceIds:
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
          minItems: 1
        class:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
        names:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              lang:
                type: string
                pattern: '^[a-zA-Z]{3}$'
                example: 'eng'
            required:
              - name
              - lang
          minItems: 1
        descriptions:
          type: array
          items:
            type: object
            properties:
              description:
                type: string
              lang:
                type: string
                pattern: '^[a-zA-Z]{3}$'
                example: 'eng'
            required:
              - description
              - lang
          minItems: 1
        serviceLanguage:
          type: string
          pattern: '^[a-zA-Z]{3}$'
          example: 'eng'
        distributionSessionDescriptions:
          type: array
          items:
            $ref: '#/components/schemas/DistributionSessionDescription'
          minItems: 1
        serviceScheduleDescriptions:
          type: array
          items:
            $ref: '#/components/schemas/ServiceScheduleDescription'
          minItems: 1
      required:
        - serviceIds
        - class
        - distributionSessionDescriptions
    DistributionSessionDescription:
      type: object
      properties:
        distributionMethod:
          $ref: '#/components/schemas/DistributionMethod'
        conformanceProfiles:
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
          minItems: 1
        sessionDescriptionLocator:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
        applicationServiceDescriptions:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationServiceDescription'
          minItems: 1
        postSessionObjectRepairParameters:
          $ref: '#/components/schemas/ObjectRepairParameters'
        availabilityInfos:
          type: array
          items:
            $ref: '#/components/schemas/AvailabilityInformation'
          minItems: 1
        securityDescription:
          $ref: '#/components/schemas/SecurityDescription'
      required:
        - distributionMethod
        - sessionDescriptionLocator
    DistributionMethod:
      anyOf:
        - type: string
          enum:
            - OBJECT
            - PACKET
        - type: string
          description: >
            This string provides forward-compatibility with future
            extensions to the enumeration but is not used to encode
            content defined in the present version of this API.
    ApplicationServiceDescription:
      type: object
      properties:
        entryPointLocator:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
        contentType:
          type: string
          pattern: '^[a-zA-Z]+\/[a-zA-Z]+$'
          example: 'application/dash+xml'
      required:
        - entryPointLocator
        - contentType
    AvailabilityInformation:
      type: object
      properties:
        mbsServiceAreas:
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceArea'
          minItems: 1
        mbsFSAId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsFsaId'
        nrParameters:
          type: array
          items:
            $ref: '#/components/schemas/NrParameterSet'
          minItems: 1
        nrRedCapUEInfo:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/NrRedCapUeInfo'
    NrParameterSet:
      type: object
      properties:
        freqBandIndicator:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
        aRFCNValue:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
      required:
        - freqBandIndicator
        - aRFCNValue
    ObjectRepairParameters:
      type: object
      properties:
        backOffParameters:
          $ref: '#/components/schemas/BackOffParameters'
        objectDistributionBaseLocator:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
        objectRepairBaseLocator:
          $ref: 'TS26510_CommonData.yaml#/components/schemas/AbsoluteUrl'
    BackOffParameters:
      type: object
      properties:
        offsetTime:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
        randomTimePeriod:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
      anyOf:
        - required: [offsetTime]
        - required: [randomTimePeriod]
    ServiceScheduleDescription:
      type: object
      properties:
         id:
           type: string
         version:
           type: integer
           minimum: 1
         start:
           $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
         stop:
           $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
         repetitionRule:
           $ref: '#/components/schemas/RepetitionRule'
      required:
        - id
        - version
      oneOf:
        - required: [start, stop]
        - required: [repetitionRule]
    RepetitionRule:
      type: object
      properties:
        startTime:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
        duration:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
        repetitionInterval:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
      required:
        - startTime
        - duration
        - repetitionInterval
    SecurityDescription:
      type: object
      properties:
        mBSSFAddresses:
          type: array
          items:
            $ref: 'TS26510_CommonData.yaml#/components/schemas/AbsoluteUrl'
          minItems: 1
        mBSServiceKeyInfo:
          type: object
          properties:
            mBSId:
              type: string
            mBSDomainId:
              type: string
          required:
            - mBSId
            - mBSDomainId
        uICCKeyManagement:
          type: boolean
        2GGBAallowed:
          type: boolean
        backOffParameters:
          $ref: '#/components/schemas/BackOffParameters'
      required:
        - mBSSFAddresses
        - mBSSessionKeyInfo

B Service Announcement examples p. 49

B.1 XML-based representation p. 49

Void

B.2 JSON-based representation p. 49

This example is for future study.

C (Normative) 3GPP Registered URIs p. 50

C.1 General p. 50

This Annex documents the registered URIs in the present document following the process in https://www.3gpp.org/3gpp-groups/core-network-terminals-ct/ct-wg1/uniform-resource-identifier-uri-list.

As required by this process, the tables in the following clauses list all registered URI values as well as:

a brief description of its functionality;
a reference to the specification or other publicly available document (if any) containing the definition;
the name and email address of the person making the application; and
any supplementary information considered necessary to support the application.

C.2 Controlled vocabulary of conformance profile identifiers p. 50

Table C.2-1: Controlled vocabulary of conformance profile identifiers

URI	Description	Reference	Contact	Remarks
urn:3GPP:26517:17:baseline	Baseline MBS Distribution Session Profile	clause 12.4 of TS 26.517	Thomas Stockhammer tsto@qti.qualcomm.com	None.