Commit d09f8db7 authored by bradburyr's avatar bradburyr
Browse files

26512-CR0103 [SP-251313]: Update of info an externalDocs fields 

Version bump arising from 26510-CR0037.
parent 56d93e12

TS26512_ClientData.yaml.bak

0 → 100755
+285 −0
Original line number Diff line number Diff line 
<<<<<<< HEAD

openapi: 3.0.0

info:

  title: '5G Media Streaming: Client data syntax for QoE metrics reporting'

  version: 1.0.0

  description: |

    5GMS client data syntax for QoE metrics reporting

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

    All rights reserved.



tags:

  - name: '5GMS client data syntax for QoE metrics reporting'

    description: '5G Media Streaming: Client data syntax for use in QoE metrics reporting envelope'



externalDocs:

  description: 'TS 26.512 V19.0.0; 5G Media Streaming (5GMS); Protocols'

  url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'



paths: {}



components:

  schemas:

    MediaStreamingClientData:

      description: 'Envelope for client data pertaining to the 5G Media Streaming System.'

      type: object

      required:

        - requestUrl

      anyOf:

        - required: [cmcdSessionInfo]

        - required: [cmcdObjectInfo]

        - required: [cmcdRequestInfo]

        - required: [cmcdStatusInfo]

      properties:

        requestUrl:

          $ref: 'TS26510_CommonData.yaml#/components/schemas/AbsoluteUrl'

        cmcdSessionInfo:

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

        cmcdObjectInfo:

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

        cmcdRequestInfo:

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

        cmcdStatusInfo:

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



    ##########################################

    # Common Media Client Data per CTA-5004 V1

    ##########################################

    CmcdSessionInfo:

      description: 'An object containing session-scope CMCD keys'

      type: object

      required:

        - sid

      properties:

        v:

          description: 'CMCD version'

          type: integer

          minimum: 1

        sid:

          description: 'Session identifier'

          type: string

        cid:

          description: 'Content identifier'

          type: string

        st:

          allOf:

            - description: 'Stream type'

            - $ref: '#/components/schemas/CmcdStreamType'

        sf:

          allOf:

            - description: 'Streaming format'

            - $ref: '#/components/schemas/CmcdStreamingFormat'

        pr:

          description: 'Playback rate'

          type: number



    CmcdObjectInfo:

      description: 'An object containing object-scope CMCD keys'

      type: object

      properties:

        ot:

          allOf:

            - description: 'Object type'

            - $ref: '#/components/schemas/CmcdObjectType'

        d:

          description: 'Object duration (milliseconds)'

          type: integer

        br:

          description: 'Encoded bit rate (kilobits per second)'

          type: integer

        tb:

          description: 'Top bit rate (kilobits per second)'

          type: integer



    CmcdRequestInfo:

      description: 'An object containing request-scope CMCD keys'

      type: object

      properties:

        su:

          description: 'Start-up'

          type: boolean

        mtp:

          description: 'Measured throughput (kilobits per second)'

          type: integer

        dl:

          description: 'Deadline (milliseconds)'

          type: integer

        bl:

          description: 'Buffer length (milliseconds)'

          type: integer

        nor:

          allOf:

            - description: 'Next object request'

            - $ref: 'TS26510_CommonData.yaml#/components/schemas/RelativeUrl'

        nrr:

          description: 'Next range request'

          type: string

        

    CmcdStatusInfo:

      description: 'An object containing status-scope CMCD keys'

      type: object

      properties:

        rtp:

          description: 'Requested maximum throughput (kilobits per second)'

          type: integer

        bs:

          description: 'Buffer starvation'

          type: boolean



    CmcdStreamType:

      description: 'Stream type'

      type: string

      enum: [v, l]



    CmcdStreamingFormat:

      description: 'Streaming format'

      type: string

      enum: [d, h, s, o]



    CmcdObjectType:

      description: 'Media type of object'

      type: string

      enum: [m, a, v, av, i, c, tt, k, o]

=======

openapi: 3.0.0

info:

  title: '5G Media Streaming: Client data syntax for QoE metrics reporting'

  version: 1.0.0

  description: |

    5GMS client data syntax for QoE metrics reporting

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

    All rights reserved.



tags:

  - name: '5GMS client data syntax for QoE metrics reporting'

    description: '5G Media Streaming: Client data syntax for use in QoE metrics reporting envelope'



externalDocs:

  description: 'TS 26.512 V19.0.0; 5G Media Streaming (5GMS); Protocols'

  url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'



paths: {}



components:

  schemas:

    MediaStreamingClientData:

      description: 'Envelope for client data pertaining to the 5G Media Streaming System.'

      type: object

      required:

        - requestUrl

      anyOf:

        - required: [cmcdSessionInfo]

        - required: [cmcdObjectInfo]

        - required: [cmcdRequestInfo]

        - required: [cmcdStatusInfo]

      properties:

        requestUrl:

          $ref: 'TS26510_CommonData.yaml#/components/schemas/AbsoluteUrl'

        cmcdSessionInfo:

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

        cmcdObjectInfo:

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

        cmcdRequestInfo:

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

        cmcdStatusInfo:

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



    ##########################################

    # Common Media Client Data per CTA-5004 V1

    ##########################################

    CmcdSessionInfo:

      description: 'An object containing session-scope CMCD keys'

      type: object

      required:

        - sid

      properties:

        v:

          description: 'CMCD version'

          type: integer

          minimum: 1

        sid:

          description: 'Session identifier'

          type: string

        cid:

          description: 'Content identifier'

          type: string

        st:

          allOf:

            - description: 'Stream type'

            - $ref: '#/components/schemas/CmcdStreamType'

        sf:

          allOf:

            - description: 'Streaming format'

            - $ref: '#/components/schemas/CmcdStreamingFormat'

        pr:

          description: 'Playback rate'

          type: number



    CmcdObjectInfo:

      description: 'An object containing object-scope CMCD keys'

      type: object

      properties:

        ot:

          allOf:

            - description: 'Object type'

            - $ref: '#/components/schemas/CmcdObjectType'

        d:

          description: 'Object duration (milliseconds)'

          type: integer

        br:

          description: 'Encoded bit rate (kilobits per second)'

          type: integer

        tb:

          description: 'Top bit rate (kilobits per second)'

          type: integer



    CmcdRequestInfo:

      description: 'An object containing request-scope CMCD keys'

      type: object

      properties:

        su:

          description: 'Start-up'

          type: boolean

        mtp:

          description: 'Measured throughput (kilobits per second)'

          type: integer

        dl:

          description: 'Deadline (milliseconds)'

          type: integer

        bl:

          description: 'Buffer length (milliseconds)'

          type: integer

        nor:

          allOf:

            - description: 'Next object request'

            - $ref: 'TS26510_CommonData.yaml#/components/schemas/RelativeUrl'

        nrr:

          description: 'Next range request'

          type: string

        

    CmcdStatusInfo:

      description: 'An object containing status-scope CMCD keys'

      type: object

      properties:

        rtp:

          description: 'Requested maximum throughput (kilobits per second)'

          type: integer

        bs:

          description: 'Buffer starvation'

          type: boolean



    CmcdStreamType:

      description: 'Stream type'

      type: string

      enum: [v, l]



    CmcdStreamingFormat:

      description: 'Streaming format'

      type: string

      enum: [d, h, s, o]



    CmcdObjectType:

      description: 'Media type of object'

      type: string

      enum: [m, a, v, av, i, c, tt, k, o]

>>>>>>> 5G_APIs/REL-19

TS26512_Maf_Provisioning.yaml

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

info:

  title: Maf_Provisioning (5G Media Streaming)

  version: 1.1.0

  version: 1.1.1

  description: |

    5GMS AF Provisioning API

    © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
@@ -12,7 +12,7 @@ tags: 
    description: '5G Media Streaming: AF Provisioning APIs'



externalDocs:

  description: 'TS 26.512 V19.0.0; 5G Media Streaming (5GMS); Protocols'

  description: 'TS 26.512 V19.1.0; 5G Media Streaming (5GMS); Protocols'

  url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'



servers:

TS26512_Maf_Provisioning.yaml.bak

0 → 100755
+86 −0
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: Maf_Provisioning (5G Media Streaming)

  version: 1.1.0

  description: |

    5GMS AF Provisioning API

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

    All rights reserved.



tags:

  - name: Maf_Provisioning

    description: '5G Media Streaming: AF Provisioning APIs'



externalDocs:

  description: 'TS 26.512 V19.0.0; 5G Media Streaming (5GMS); Protocols'

  url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'



servers:

  - url: '{apiRoot}/3gpp-maf-provisioning/v1'

    variables:

      apiRoot:

        default: https://example.com

        description: See 3GPP TS 26.512 clause 6.1.2.



paths:

  # Provisioning Sessions API

  /provisioning-sessions:

    $ref: 'TS26510_Maf_Provisioning_ProvisioningSessions.yaml#/paths/~1provisioning-sessions'

  /provisioning-sessions/%7bprovisioningSessionId%7d:

    $ref: 'TS26510_Maf_Provisioning_ProvisioningSessions.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d'



  # Content Protocols Discovery API

  /provisioning-sessions/%7bprovisioningSessionId%7d/content-protocols:

    $ref: 'TS26510_Maf_Provisioning_ContentProtocols.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1content-protocols'



  # Server Certificates Provisioning API

  /provisioning-sessions/%7bprovisioningSessionId%7d/certificates:

    $ref: 'TS26510_Maf_Provisioning_ServerCertificates.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1certificates'

  /provisioning-sessions/%7bprovisioningSessionId%7d/certificates/%7bcertificateId%7d:

    $ref: 'TS26510_Maf_Provisioning_ServerCertificates.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1certificates~1%7bcertificateId%7d'



  # Policy Templates Provisioning API

  /provisioning-sessions/%7bprovisioningSessionId%7d/policy-templates:

    $ref: 'TS26510_Maf_Provisioning_PolicyTemplates.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1policy-templates'

  /provisioning-sessions/%7bprovisioningSessionId%7d/policy-templates/%7bpolicyTemplateId%7d:

    $ref: 'TS26510_Maf_Provisioning_PolicyTemplates.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1policy-templates~1%7bpolicyTemplateId%7d'



  # Content Preparation Templates Provisioning API

  /provisioning-sessions/%7bprovisioningSessionId%7d/content-preparation-templates:

    $ref: 'TS26510_Maf_Provisioning_ContentPreparationTemplates.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1content-preparation-templates'

  /provisioning-sessions/%7bprovisioningSessionId%7d/content-preparation-templates/%7bcontentPreparationTemplateId%7d:

    $ref: 'TS26510_Maf_Provisioning_ContentPreparationTemplates.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1content-preparation-templates~1%7bcontentPreparationTemplateId%7d'



  # Edge Resources Provisioning API

  /provisioning-sessions/%7bprovisioningSessionId%7d/edge-resources-configurations:

    $ref: 'TS26510_Maf_Provisioning_EdgeResources.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1edge-resources-configurations'

  /provisioning-sessions/%7bprovisioningSessionId%7d/edge-resources-configurations/%7bedgeResourcesConfigurationId%7d:

    $ref: 'TS26510_Maf_Provisioning_EdgeResources.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1edge-resources-configurations~1%7bedgeResourcesConfigurationId%7d'



  # Content Hosting Provisioning API

  /provisioning-sessions/%7bprovisioningSessionId%7d/content-hosting-configuration:

    $ref: 'TS26510_Maf_Provisioning_ContentHosting.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1content-hosting-configuration'

  /provisioning-sessions/%7bprovisioningSessionId%7d/content-hosting-configuration/purge:

    $ref: 'TS26510_Maf_Provisioning_ContentHosting.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1content-hosting-configuration~1purge'



  # Content Publishing Provisioning API

  /provisioning-sessions/%7bprovisioningSessionId%7d/content-publishing-configuration:

    $ref: 'TS26510_Maf_Provisioning_ContentPublishing.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1content-publishing-configuration'

  /provisioning-sessions/%7bprovisioningSessionId%7d/content-publishng-configuration/purge:

    $ref: 'TS26510_Maf_Provisioning_ContentPublishing.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1content-publishing-configuration~1purge'



  # Metrics Reporting Provisioning API

  /provisioning-sessions/%7bprovisioningSessionId%7d/metrics-reporting-configurations:

    $ref: 'TS26510_Maf_Provisioning_MetricsReporting.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1metrics-reporting-configurations'

  /provisioning-sessions/%7bprovisioningSessionId%7d/metrics-reporting-configurations/%7bmetricsReportingConfigurationId%7d:

    $ref: 'TS26510_Maf_Provisioning_MetricsReporting.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1metrics-reporting-configurations~1%7bmetricsReportingConfigurationId%7d'



  # Consumption Reporting Provisioning API

  /provisioning-sessions/%7bprovisioningSessionId%7d/consumption-reporting-configuration:

    $ref: 'TS26510_Maf_Provisioning_ConsumptionReporting.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1consumption-reporting-configuration'



  # Event Data Processing Provisioning API

  /provisioning-sessions/%7bprovisioningSessionId%7d/event-data-processing-configurations:

    $ref: 'TS26510_Maf_Provisioning_EventDataProcessing.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1event-data-processing-configurations'

  /provisioning-sessions/%7bprovisioningSessionId%7d/event-data-processing-configurations/%7beventDataProcessingConfigurationId%7d:

    $ref: 'TS26510_Maf_Provisioning_EventDataProcessing.yaml#/paths/~1provisioning-sessions~1%7bprovisioningSessionId%7d~1event-data-processing-configurations~1%7beventDataProcessingConfigurationId%7d'