Initial commit, based on ContentHosting.

openapi: 3.0.0

info:

  title: Mas_Configuration_ContentPublishing

  version: 1.0.0

  description: |

    5GMS AS M3 Content Publishing Configuration API

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

    All rights reserved.

tags:

  - name: Mas_Configuration_ContentPublishing

    description: '5G Media Streaming: Application Server Configuration (M3) APIs: Content Publishing'

externalDocs:

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

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

servers:

  - url: '{apiRoot}/3gpp-mas-configuration/v3'

    variables:

      apiRoot:

        default: https://example.com

        description: See 3GPP TS 29.512 clause 6.1.

security:

  - {}

  - OAuth2ClientCredentials: [] 

paths:

  /content-publishing-configurations:

    summary: "Content Publishing Configuration collection"

    get:

      operationId: retrieveContentPublishingConfigurations

      summary: "Retrieve a list of Content Publishing Configuration resource identifiers currently registered with the 5GMS AS"

      responses:

        '200': # OK

          description: "Success"

          content:

            application/json:

              schema:

                type: array

                items:

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

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '413': # Payload Too Large: No request body allowed for this operation

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

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

  /content-publishing-configurations/{afResourceId}:

    summary: "Operations to manipulate a single Content Publishing Configuration resource"

    description: "Individual resources in the collection are addressed using an afResourceId nominated by the 5GMS AF which is unique in this collection at a given 5GMS AS instance."

    parameters:

      - name: afResourceId

        in: path

        required: true

        schema:

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

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

    post:

      operationId: createContentPublishingConfiguration

      summary: 'Create and upload the Content Publishing Configuration for the specified Provisioning Session'

      requestBody:

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

        required: true

        content:

          application/json:

            schema:

              $ref: 'TS26510_Maf_Provisioning_ContentPublishing.yaml#/components/schemas/ContentPublishingConfiguration'

      responses:

        '201': # Created

          description: 'Content Publishing Configuration Created'

          headers:

            Location:

              description: 'URL of the newly created Content Publishing Configuration (which may be redirected from the request URL).'

              required: true

              schema:

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

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '409': # Conflict: Resource already exists

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

        '410': # Gone: This resource has previously been destroyed

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

        '411': # Length Required

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

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

    # get (Retrieval of individual Content Publishing Configuration resources is not permitted at reference point M3.)

    put:

      operationId: updateContentPublishingConfiguration

      summary: 'Update (by replacement) an existing Content Publishing Configuration for the specified Provisioning Session'

      requestBody:

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

        required: true

        content:

          application/json:

            schema:

              $ref: 'TS26510_Maf_Provisioning_ContentPublishing.yaml#/components/schemas/ContentPublishingConfiguration'

      responses:

        '200': # OK

          description: 'Content Publishing Configuration Updated'

        '204': # No Content

          description: 'Content Publishing Configuration Unchanged'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '404': # Not Found

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

        '410': # Gone: This resource has previously been destroyed

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

        '411': # Length Required

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

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

    delete:

      operationId: destroyContentPublishingConfiguration

      summary: 'Destroy the specified Content Publishing Configuration'

      responses:

        '204': # No Content

          description: 'Content Publishing Configuration Destroyed'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '404': # Not Found

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

        '410': # Gone: This resource has previously been destroyed

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

        '413': # Payload Too Large: No request body allowed for this operation

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

        '414': # URI too long

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

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

  /content-publishing-configurations/{afResourceId}/active:

    parameters:

        - name: afResourceId

          in: path

          required: true

          schema:

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

          description: 'Individual resources in the collection are addressed using an afResourceId nominated by the 5GMS AF which is unique in this collection at a given 5GMS AS instance.'

    post:

      operationId: modifyContentPublishingConfigurationState

      summary: 'Activate or deactivate the specified Content Publishing Configuration'

      requestBody:

        description: 'The desired state of the target Content Publishing Configuration'

        required: true

        content:

          application/json:

            schema:

              description: 'The desired state of the target Content Publishing Configuration: true for active; false for inactive.'

              type: boolean

      responses:

        '204': # No Content

          description: 'No Content'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '404': # Not Found

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

        '410': # Gone: This resource has previously been destroyed

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

        '413': # Payload too large

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

        '415': # Unsupported Media Type

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

        '414': # URI too long

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

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

    get:

      operationId: interrogateContentPublishingConfigurationState

      summary: 'Interrogate the current state of the specified Content Publishing Configuration'

      responses:

        '200': # OK

          description: 'Success'

          content:

            application/json:

              schema:

                description: 'The current state of the target Content Publishing Configuration: true for active; false for inactive.'

                type: boolean     

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '404': # Not Found

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

        '410': # Gone: This resource has previously been destroyed

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

        '413': # Payload Too Large: No request body allowed for this operation

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

        '415': # Unsupported Media Type

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

        '414': # URI too long

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

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

  /content-publishing-configurations/{afResourceId}/purge:

    parameters:

        - name: afResourceId

          in: path

          required: true

          schema:

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

          description: 'Individual resources in the collection are addressed using an afResourceId nominated by the 5GMS AF which is unique in this collection at a given 5GMS AS instance.'

    post:

      operationId: purgeContentPublishingCache

      summary: 'Purge the content of the cache for the specified Content Publishing Configuration'

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

                  type: string

                value:

                  description: 'The regular expression'

                  type: string

      responses:

        '204': # No Content

          description: 'Content Purged'

        '400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors

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

        '401': # Unauthorized

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

        '404': # Not Found

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

        '410': # Gone: This resource has previously been destroyed

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

        '411': # Length Required

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

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

  securitySchemes:

    OAuth2ClientCredentials:

      type: oauth2

      flows:

        clientCredentials:

          tokenUrl: '{tokenUrl}'

          scopes: {}