Commit 8c55772c authored by bradburyr's avatar bradburyr
Browse files

Removed redundant Rel-17 files.

parent 9fc8f6a8

TS26512_M1_ConsumptionReportingProvisioning.yaml

deleted100644 → 0
+0 −120
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: M1_ConsumptionReportingProvisioning

  version: 2.1.0

  description: |

    5GMS AF M1 Consumption Reporting Provisioning API

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

    All rights reserved.

tags:

  - name: M1_ConsumptionReportingProvisioning

    description: '5G Media Streaming: Provisioning (M1) APIs: Consumption Reporting Provisioning'

externalDocs:

  description: 'TS 26.512 V17.7.0; 5G Media Streaming (5GMS); Protocols'

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

servers:

  - url: '{apiRoot}/3gpp-m1/v2'

    variables:

      apiRoot:

        default: https://example.com

        description: See 3GPP TS 29.512 clause 6.1.

paths:

  /provisioning-sessions/{provisioningSessionId}/consumption-reporting-configuration:

    parameters:

      - name: provisioningSessionId

        in: path

        required: true

        schema: 

          $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'

        description: 'The resource identifier of an existing Provisioning Session.'

    post:

      operationId: activateConsumptionReporting

      summary: 'Activate the consumption reporting procedure for the specified Provisioning Session by providing the Consumption Reporting Configuration'

      requestBody:

        description: 'A JSON representation of a Consumption Reporting Configuration'

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '201':

          description: 'Consumption Reporting Configuration Created'

          headers:

            Location:

              description: 'URL of the newly created Consumption Reporting Configuration (same as request URL).'

              required: true

              schema:

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

    get:

      operationId: retrieveConsumptionReportingConfiguration

      summary: 'Retrieve the Consumption Reporting Configuration of the specified Provisioning Session'

      responses:

        '200':

          description: 'Success'

          content:

            application/json:

              schema:

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

    put:

      operationId: updateConsumptionReportingConfiguration

      summary: 'Update the Consumption Reporting Configuration for the specified Provisioning Session'

      requestBody:

        description: 'A JSON representation of a Consumption Reporting Configuration'

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '204':

          description: 'Updated Consumption Reporting Configuration'

        '404':

          description: 'Not Found'

    patch:

      operationId: patchConsumptionReportingConfiguration

      summary: 'Patch the Consumption Reporting Configuration for the specified Provisioning Session'

      requestBody:

        description: 'A JSON representation of a Consumption Reporting Configuration'

        required: true

        content:

          application/merge-patch+json:

            schema:

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

          application/json-patch+json:

            schema:

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

      responses:

        '200':

          description: 'Patched Consumption Reporting Configuration'

          content:

            application/json:

              schema:

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

        '404':

          description: 'Not Found'

    delete:

      operationId: destroyConsumptionReportingConfiguration

      summary: 'Destroy the current Consumption Reporting Configuration of the specified Provisioning Session'

      responses:

        '204':

          description: 'Destroyed Consumption Reporting Configuration'

        '404':

          description: 'Not Found'

components:

  schemas:

    ConsumptionReportingConfiguration:

      type: object

      description: "A representation of a Consumption Reporting Configuration resource."

      properties:

        reportingInterval:

          minimum: 0

          exclusiveMinimum: true

          allOf:

            - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'

        samplePercentage:

          $ref: 'TS26512_CommonData.yaml#/components/schemas/Percentage'

        locationReporting:

          type: boolean

        accessReporting:

          type: boolean

TS26512_M1_ContentHostingProvisioning.yaml

deleted100644 → 0
+0 −347
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: M1_ContentHostingProvisioning

  version: 2.3.0

  description: |

    5GMS AF M1 Content Hosting Provisioning API

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

    All rights reserved.

tags:

  - name: M1_ContentHostingProvisioning

    description: '5G Media Streaming: Provisioning (M1) APIs: Content Hosting Provisioning'

externalDocs:

  description: 'TS 26.512 V17.7.0; 5G Media Streaming (5GMS); Protocols'

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

servers:

  - url: '{apiRoot}/3gpp-m1/v2'

    variables:

      apiRoot:

        default: https://example.com

        description: See 3GPP TS 29.512 clause 6.1.

paths:

  /provisioning-sessions/{provisioningSessionId}/content-hosting-configuration:

    parameters:

      - name: provisioningSessionId

        in: path

        required: true

        schema:

          $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'

        description: 'The resource identifier of an existing Provisioning Session.'

    post:

      operationId: createContentHostingConfiguration

      summary: 'Create (and optionally upload) the Content Hosting Configuration for the specified Provisioning Session'

      requestBody:

        description: 'A JSON representation of a Content Hosting Configuration'

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '201':

          description: 'Content Hosting Configuration Created'

          headers:

            Location:

              description: 'URL of the newly created Content Hosting Configuration (same as request URL).'

              required: true

              schema:

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

    get:

      operationId: retrieveContentHostingConfiguration

      summary: 'Retrieve the Content Hosting Configuration of the specified Provisioning Session'

      responses:

        '200':

          description: 'Success'

          content:

            application/json:

              schema:

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

        '404':

          description: 'Not Found'

    put:

      operationId: updateContentHostingConfiguration

      summary: 'Update the Content Hosting Configuration for the specified Provisioning Session'

      requestBody:

        description: 'A JSON representation of a Content Hosting Configuration'

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '204':

          description: 'Updated Content Hosting Configuration'

        '404':

          description: 'Not Found'

    patch:

      operationId: patchContentHostingConfiguration

      summary: 'Patch the Content Hosting Configuration for the specified Provisioning Session'

      requestBody:

        description: 'A JSON representation of a Content Hosting Configuration'

        required: true

        content:

          application/merge-patch+json:

            schema:

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

          application/json-patch+json:

            schema:

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

      responses:

        '200':

          description: 'Patched Content Hosting Configuration'

          content:

            application/json:

              schema:

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

        '404':

          description: 'Not Found'

    delete:

      operationId: destroyContentHostingConfiguration

      summary: 'Destroy the current Content Hosting Configuration of the specified Provisioning Session'

      responses:

        '204':

          description: 'Destroyed Content Hosting Configuration'

        '404':

          description: 'Not Found'

          

  /provisioning-sessions/{provisioningSessionId}/content-hosting-configuration/purge:

    parameters:

        - name: provisioningSessionId

          in: path

          required: true

          schema:

            $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'

          description: A unique identifier of the Provisioning

    post:

      operationId: purgeContentHostingCache

      summary: 'Purge the content of the cache for the Content Hosting Configuration of the specified Provisioning Session'

      requestBody:

        description: 'The regular expression pattern for resources to purge from the cache'

        required: true

        content:

          application/x-www-form-urlencoded:

            schema:

              properties:

                pattern: 

                  description: 'The regular expression'

                  type: string

      responses:

        '200':

          # OK

          description: 'Content Purged'

          content:

            application/json:

              schema:

                description: 'The aggregate number of cache entries purged in all 5GMSd AS instances distributing content for the requested Provisioning Session.'

                type: integer

                minimum: 1

        '204':

          # No Content

          description: 'No Content Purged'

        '400':

          # Bad Request (e.g. syntactically invalid regular expression in request body)

          $ref: 'TS29571_CommonData.yaml#/components/responses/400'

        '404':

          # Not Found

          $ref: 'TS29571_CommonData.yaml#/components/responses/404'

        '413':

          # Payload Too Large

          $ref: 'TS29571_CommonData.yaml#/components/responses/413'

        '414':

          # URI Too Long

          $ref: 'TS29571_CommonData.yaml#/components/responses/414'

        '415':

          # Unsupported Media Type

          $ref: 'TS29571_CommonData.yaml#/components/responses/415'

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

    IngestConfiguration:

      type: object

      description: 'A configuration for content ingest.'

      properties:

        pull:

          type: boolean

        protocol:

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

        baseURL:

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



    M1MediaEntryPoint:

      description: "A typed entry point for downlink or uplink media streaming."

      type: object

      required:

        - relativePath

        - contentType

      properties:

        relativePath:

          $ref: 'TS26512_CommonData.yaml#/components/schemas/RelativeUrl'

        contentType:

          type: string

        profiles:

          type: array

          items:

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

          minItems: 1



    PathRewriteRule:

      type: object

      description: 'A rule to manipulate URL paths.'

      required:

        - requestPathPattern

        - mappedPath

      properties:

        requestPathPattern:

          type: string

        mappedPath:

          type: string



    CachingConfiguration:

      type: object

      description: 'A content caching configuration.'

      required:

        - urlPatternFilter

      properties:

        urlPatternFilter:

          type: string

        cachingDirectives:

          type: object

          required:

            - noCache

          properties:

            statusCodeFilters:

              type: array

              items:

                type: integer

            noCache:

              type: boolean

            maxAge:

              type: integer

              format: int32



    DistributionConfiguration:

      type: object

      description: 'A content distribution configuration.'

      properties:

        entryPoint:

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

        contentPreparationTemplateId:

          $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'

        edgeResourcesConfigurationId:

          $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'

        domainNameAlias:

          type: string

        baseURL:

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

        pathRewriteRules:

          type: array

          items:

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

        cachingConfigurations:

          type: array

          items:

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

        geoFencing:

          type: object

          required:

            - locatorType

            - locators

          properties:

            locatorType:

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

            locators:

              type: array

              items: 

                type: string

                description: 'Format of individual locators depends on the locatorType.'

              minItems: 1

        urlSignature:

          type: object

          required:

            - urlPattern

            - tokenName

            - passphraseName

            - passphrase

            - tokenExpiryName

            - useIPAddress

          properties:

            urlPattern:

              type: string

            tokenName:

              type: string

            passphraseName:

              type: string

            passphrase:

              type: string

            tokenExpiryName:

              type: string

            useIPAddress:

              type: boolean

            ipAddressName:

              type: string

        certificateId:

          $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'

        supplementaryDistributionNetworks:

          type: array

          items:

            type: object

            description: "A duple tying a type of supplementary distribution network to its distribution mode."

            required:

              - distributionNetworkType

              - distributionMode

            properties:

              distributionNetworkType:

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

              distributionMode:

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



    # Schema for the resource itself

    ContentHostingConfiguration:

      type: object

      description: "A representation of a Content Hosting Configuration resource."

      required:

        - name

        - ingestConfiguration

        - distributionCanonicalDomainName

        - distributionConfigurations

      properties:

        name:

          type: string

        ingestConfiguration:

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

        distributionCanonicalDomainName:

          type: string

        distributionConfigurations:

          type: array

          items:

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



    DistributionNetworkType:

      description: "Type of distribution network."

      anyOf:

        - type: string

          enum: [NETWORK_EMBMS]

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



    DistributionMode:

      description: "Mode of content distribution."

      anyOf:

        - type: string

          enum: [MODE_EXCLUSIVE, MODE_HYBRID, MODE_DYNAMIC]

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

TS26512_M1_ContentPreparationTemplatesProvisioning.yaml

deleted100644 → 0
+0 −150
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: M1_ContentPreparationTemplatesProvisioning

  version: 2.1.1

  description: |

    5GMS AF M1 Content Preparation Templates Provisioning API

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

    All rights reserved.

tags:

  - name: M1_ContentPreparationTemplatesProvisioning

    description: '5G Media Streaming: Provisioning (M1) APIs: Content Preparation Templates Provisioning'

externalDocs:

  description: 'TS 26.512 V17.7.0; 5G Media Streaming (5GMS); Protocols'

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

servers:

  - url: '{apiRoot}/3gpp-m1/v2'

    variables:

      apiRoot:

        default: https://example.com

        description: See 3GPP TS 29.512 clause 6.1.

paths:

  /provisioning-sessions/{provisioningSessionId}/content-preparation-templates:

    parameters:

      - name: provisioningSessionId

        in: path

        required: true

        schema: 

          $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'

        description: 'The resource identifier of an existing Provisioning Session.'

    post:

      operationId: createContentPreparationTemplate

      summary: 'Create (and optionally upload) a new Content Preparation Template for the specified Provisioning Session'

      requestBody:

        description: 'A Content Preparation Template of any supported type'

        required: true

        content:

          '*/*':

            schema:

              type: string

      responses:

        '201':

          description: 'Content Preparation Template Created'

          headers:

            Location:

              description: 'URL of the newly created Content Preparation Template.'

              required: true

              schema:

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

        '415':

          # Unsupported Media Type

          $ref: 'TS29571_CommonData.yaml#/components/responses/415'

        '503':

          # Service Unavailable

          $ref: 'TS29571_CommonData.yaml#/components/responses/503'

  /provisioning-sessions/{provisioningSessionId}/content-preparation-templates/{contentPreparationTemplateId}:

    parameters:

      - name: provisioningSessionId

        in: path

        required: true

        schema: 

          $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'

        description: 'The resource identifier of an existing Provisioning Session.'

      - name: contentPreparationTemplateId

        in: path

        required: true

        schema: 

          $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'

        description: 'The resource identifier of an existing Content Preparation Template.'

    get:

      operationId: retrieveContentPreparationTemplate

      summary: 'Retrieve the specified Content Preparation Template of the specified Provisioning Session'

      responses:

        '200':

          description: 'Success'

          content:

            '*/*':

              schema:

                type: string

    put:

      operationId: updateContentPreparationTemplate

      summary: 'Update the specified Content Preparation Template for the specified Provisioning Session'

      requestBody:

        description: 'A Content Preparation Template of any type'

        required: true

        content:

          '*/*':

            schema:

              type: string

      responses:

        '204':

          description: 'Updated Content Preparation Template'

        '404':

          description: 'Not Found'

        '415':

          # Unsupported Media Type

          $ref: 'TS29571_CommonData.yaml#/components/responses/415'

        '503':

          # Service Unavailable

          $ref: 'TS29571_CommonData.yaml#/components/responses/503'

    patch:

      operationId: patchContentPreparationTemplate

      summary: 'Patch the specified Content Preparation Template for the specified Provisioning Session'

      requestBody:

        description: 'A Content Preparation Template patch of any type'

        required: true

        content:

          application/merge-patch+json:

            schema:

              type: string

          application/json-patch+json:

            schema:

              type: string

      responses:

        '200':

          description: 'Patched Content Preparation Templates'

          content:

            '*/*':

              schema:

                type: string

        '404':

          description: 'Not Found'

        '415':

          # Unsupported Media Type

          $ref: 'TS29571_CommonData.yaml#/components/responses/415'

        '503':

          # Service Unavailable

          $ref: 'TS29571_CommonData.yaml#/components/responses/503'

    delete:

      operationId: destroyContentPreparationTemplate

      summary: 'Destroy the specified Content Preparation Template of the specified Provisioning Session'

      responses:

        '200':

          # OK

          description: 'Content Preparation Template Destroyed'

          content:

            '*/*':

              schema:

                type: string

        '204':

          # No Content

          description: 'Content Preparation Template Destroyed'

        '404':

          # Not Found

          $ref: 'TS29571_CommonData.yaml#/components/responses/404'

        '409':

          # Conflict

          $ref: 'TS29571_CommonData.yaml#/components/responses/409'

        '410':

          # Gone

          $ref: 'TS29571_CommonData.yaml#/components/responses/410'

TS26512_M1_ContentProtocolsDiscovery.yaml

deleted100644 → 0
+0 −70
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: M1_ContentProtocolsDiscovery

  version: 2.0.0

  description: |

    5GMS AF M1 Content Protocols Discovery API

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

    All rights reserved.

tags:

  - name: M1_ContentDiscovery

    description: '5G Media Streaming: Provisioning (M1) APIs: Content Protocols Discovery'

externalDocs:

  description: 'TS 26.512 V17.2.0; 5G Media Streaming (5GMS); Protocols'

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

servers:

  - url: '{apiRoot}/3gpp-m1/v2'

    variables:

      apiRoot:

        default: https://example.com

        description: See 3GPP TS 29.512 clause 6.1.

paths:

  /provisioning-sessions/{provisioningSessionId}/protocols:

    parameters:

      - name: provisioningSessionId

        in: path

        required: true

        schema: 

          $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'

        description: 'The resource identifier of an existing Provisioning Session.'

    get:

      operationId: retrieveContentProtocols

      summary: 'Retrieve the set of Content Protocols supported by the specified Provisioning Session'

      responses:

        '200':

          description: 'Success'

          content:

            application/json:

              schema:

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

components:

  schemas:

    ContentProtocolDescriptor:

      type: object

      description: "A descriptor describing a content protocol."

      required:

        - termIdentifier

      properties:

        termIdentifier:

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

        descriptionLocator:

          $ref: 'TS26512_CommonData.yaml#/components/schemas/Url'

    ContentProtocols:

      type: object

      description: "A representation of the Content Protocols resource."

      properties:

        downlinkIngestProtocols:

          type: array

          items:

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

          minItems: 1

        uplinkEgestProtocols:

          type: array

          items:

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

          minItems: 1

        geoFencingLocatorTypes:

          type: array

          items:

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

          minItems: 1

TS26512_M1_EdgeResourcesProvisioning.yaml

deleted100644 → 0
+0 −199

File deleted.

Preview size limit exceeded, changes collapsed.