Commit d29fe053 authored by bradburyr's avatar bradburyr
Browse files

Richard edits.

parent dd6435da

TS26510_Maf_Provisioning_ConsumptionReporting.yaml

+13 −13
Original line number Diff line number Diff line
@@ -40,7 +40,7 @@ paths: 
      summary: 'Activate the consumption reporting procedure for the specified Provisioning Session by providing the Consumption Reporting Configuration'

      security:

        - OAuth2:

          - consumption-reporting-create

          - consumption-reporting-configuration_create

      requestBody:

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

        required: true
@@ -84,7 +84,7 @@ paths: 
      summary: 'Retrieve the Consumption Reporting Configuration of the specified Provisioning Session'

      security:

        - OAuth2:

          - consumption-reporting-read

          - consumption-reporting-configuration_retrieve

      responses:

        '200': # OK

          description: 'Success'
@@ -111,11 +111,11 @@ paths: 
        default:

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

    put:

      operationId: updateConsumptionReportingConfiguration

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

      operationId: replaceConsumptionReportingConfiguration

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

      security:

        - OAuth2:

          - consumption-reporting-put

          - consumption-reporting-configuration_replace

      requestBody:

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

        required: true
@@ -125,7 +125,7 @@ paths: 
              $ref: '#/components/schemas/ConsumptionReportingConfiguration'

      responses:

        '200': # OK

          description: 'Consumption Reporting Configuration Updated'

          description: 'Consumption Reporting Configuration Replaced'

          content:

            application/json:

              schema:
@@ -161,7 +161,7 @@ paths: 
      summary: 'Patch the Consumption Reporting Configuration for the specified Provisioning Session'

      security:

        - OAuth2:

          - consumption-reporting-patch

          - consumption-reporting-configuration_patch

      requestBody:

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

        required: true
@@ -210,7 +210,7 @@ paths: 
      summary: 'Destroy the current Consumption Reporting Configuration of the specified Provisioning Session'

      security:

        - OAuth2:

          - consumption-reporting-delete

          - consumption-reporting-configuration_destroy

      responses:

        '204': # No Content

          description: 'Consumption Reporting Configuration Destroyed'
@@ -241,11 +241,11 @@ components: 
        clientCredentials:

          tokenUrl: '{tokenUrl}'

          scopes:

            consumption-reporting-create: Create consumption reporting

            consumption-reporting-read: Read consumption reporting

            consumption-reporting-put: Put consumption reporting

            consumption-reporting-patch: Patch consumption reporting

            consumption-reporting-delete: Delete consumption reporting

            consumption-reporting-configuration_create: Create the Consumption Reporting Configuration resource

            consumption-reporting-configuration_retrieve: Retrieve the Consumption Reporting Configuration resource

            consumption-reporting-configuration_replace: Replace the Consumption Reporting Configuration resource

            consumption-reporting-configuration_patch: Patch the Consumption Reporting Configuration resource

            consumption-reporting-configuration_destroy: Destroy the Consumption Reporting Configuration resource



  schemas:

    ConsumptionReportingConfiguration:

TS26510_Maf_Provisioning_ContentHosting.yaml

+16 −16
Original line number Diff line number Diff line
@@ -40,7 +40,7 @@ paths: 
      summary: 'Create and upload the Content Hosting Configuration for the specified Provisioning Session'

      security:

        - OAuth2:

          - content-hosting-configuration-create

          - content-hosting-configuration_create

      requestBody:

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

        required: true
@@ -86,7 +86,7 @@ paths: 
      summary: 'Retrieve the Content Hosting Configuration of the specified Provisioning Session'

      security:

        - OAuth2:

          - content-hosting-configuration-read

          - content-hosting-configuration_retrieve

      responses:

        '200': # OK

          description: 'Success'
@@ -113,11 +113,11 @@ paths: 
        default:

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

    put:

      operationId: updateContentHostingConfiguration

      summary: 'Update (by replacement) the Content Hosting Configuration for the specified Provisioning Session'

      operationId: replaceContentHostingConfiguration

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

      security:

        - OAuth2:

          - content-hosting-configuration-put

          - content-hosting-configuration_replace

      requestBody:

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

        required: true
@@ -127,7 +127,7 @@ paths: 
              $ref: '#/components/schemas/ContentHostingConfiguration'

      responses:

        '200': # OK

          description: 'Updated Content Hosting Configuration'

          description: 'Content Hosting Configuration Replaced'

          content:

            application/json:

              schema:
@@ -163,7 +163,7 @@ paths: 
      summary: 'Patch the Content Hosting Configuration for the specified Provisioning Session'

      security:

        - OAuth2:

          - content-hosting-configuration-patch

          - content-hosting-configuration_patch

      requestBody:

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

        required: true
@@ -212,7 +212,7 @@ paths: 
      summary: 'Destroy the current Content Hosting Configuration of the specified Provisioning Session'

      security:

        - OAuth2:

          - content-hosting-configuration-delete

          - content-hosting-configuration_destroy

      responses:

        '204': # No Content

          description: 'Destroyed Content Hosting Configuration'
@@ -248,7 +248,7 @@ paths: 
      summary: 'Purge the content of the cache for the Content Hosting Configuration of the specified Provisioning Session'

      security:

        - OAuth2:

          - content-hosting-configuration-purge

          - content-hosting-configuration_purge-cache

      requestBody:

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

        required: true
@@ -299,12 +299,12 @@ components: 
        clientCredentials:

          tokenUrl: '{tokenUrl}'

          scopes:

            content-hosting-configuration-create: Create a content hosting configuration

            content-hosting-configuration-read: Read a content hosting configuration

            content-hosting-configuration-put: Put a content hosting configuration

            content-hosting-configuration-patch: Patch a content hosting configuration

            content-hosting-configuration-delete: Delete a content hosting configuration

            content-hosting-configuration-purge: Purge a content hosting configuration

            content-hosting-configuration-create: Create the Content Hosting Configuration resource

            content-hosting-configuration_retrieve: Retrieve the Content Hosting Configuration resource

            content-hosting-configuration_replace: Replace the Content Hosting Configuration resource

            content-hosting-configuration_patch: Patch the Content Hosting Configuration resource

            content-hosting-configuration_destroy: Destroy the Content Hosting Configuration resource

            content-hosting-configuration_purge-cache: Purge the cache associated with the Content Hosting Configuration resource



  schemas:

    IngestConfiguration:

TS26510_Maf_Provisioning_ContentPreparationTemplates.yaml

+13 −14
Original line number Diff line number Diff line
@@ -40,7 +40,7 @@ paths: 
      summary: 'Create (and optionally upload) a new Content Preparation Template for the specified Provisioning Session'

      security:

        - OAuth2:

          - content-preparation-template-create

          - content-preparation-template_create

      requestBody:

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

        required: true
@@ -99,7 +99,7 @@ paths: 
      summary: 'Retrieve the specified Content Preparation Template of the specified Provisioning Session'

      security:

        - OAuth2:

          - content-preparation-template-read

          - content-preparation-template_retrieve

      responses:

        '200': # OK

          description: 'Success'
@@ -126,12 +126,11 @@ paths: 
        default:

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

    put:

      operationId: updateContentPreparationTemplate

      summary: 'Update (by replacement) the specified Content Preparation Template for the specified Provisioning Session'

      operationId: replaceContentPreparationTemplate

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

      security:

        - OAuth2:

          - content-preparation-template-put

      requestBody:

          - content-preparation-template_replace

        description: 'A Content Preparation Template of any type'

        required: true

        content:
@@ -140,7 +139,7 @@ paths: 
              type: string

      responses:

        '200': # OK

          description: 'Content Preparation Template Updated'

          description: 'Content Preparation Template Replaced'

          content:

            '*/*':

              schema:
@@ -176,7 +175,7 @@ paths: 
      summary: 'Patch the specified Content Preparation Template for the specified Provisioning Session'

      security:

        - OAuth2:

          - content-preparation-template-patch

          - content-preparation-template_patch

      requestBody:

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

        required: true
@@ -219,7 +218,7 @@ paths: 
      summary: 'Destroy the specified Content Preparation Template of the specified Provisioning Session'

      security:

        - OAuth2:

          - content-preparation-template-delete

          - content-preparation-template_destroy

      responses:

        '204': # No Content

          description: 'Content Preparation Template Destroyed'
@@ -252,8 +251,8 @@ components: 
        clientCredentials:

          tokenUrl: '{tokenUrl}'

          scopes:

            content-preparation-template-create: Create a content preparation template

            content-preparation-template-read: Read a content preparation template

            content-preparation-template-put: Put a content preparation template

            content-preparation-template-patch: Patch a content preparation template

            content-preparation-template-delete: Delete a content preparation template
 
            content-preparation-template_create: Create a Content Preparation Template resource

            content-preparation-template_retrieve: Read a Content Preparation Template resource

            content-preparation-template_replace: Replace a Content Preparation Template resource

            content-preparation-template_patch: Patch a Content Preparation Template resource

            content-preparation-template_destroy: Destroy a Content Preparation Template resource

TS26510_Maf_Provisioning_ContentProtocols.yaml

+3 −2
Original line number Diff line number Diff line
@@ -40,7 +40,7 @@ paths: 
      summary: 'Retrieve the set of Content Protocols supported by the specified Provisioning Session'

      security:

        - OAuth2:

          - content-protocols-read

          - content-protocols_retrieve

      responses:

        '200':

          description: 'Success'
@@ -75,7 +75,8 @@ components: 
        clientCredentials:

          tokenUrl: '{tokenUrl}'

          scopes:

            content-protocols-read: Read supported content protocols 

            content-protocols_retrieve: Retrieve the Content Protocols Descriptor resource



  schemas:

    ContentProtocolDescriptor:

      type: object

TS26510_Maf_Provisioning_ContentPublishing.yaml

+28 −4
Original line number Diff line number Diff line
@@ -38,6 +38,9 @@ paths: 
    post:

      operationId: createContentPublishingConfiguration

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

      security:

        - OAuth2:

          - content-publishing-configuration_create

      requestBody:

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

        required: true
@@ -81,6 +84,9 @@ paths: 
    get:

      operationId: retrieveContentPublishingConfiguration

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

      security:

        - OAuth2:

          - content-publishing-configuration_retrieve

      responses:

        '200': # OK

          description: 'Success'
@@ -107,8 +113,11 @@ paths: 
        default:

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

    put:

      operationId: updateContentPublishingConfiguration

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

      operationId: replaceContentPublishingConfiguration

      summary: 'Replace the Content Publishing Configuration for the specified Provisioning Session'

      security:

        - OAuth2:

          - content-publishing-configuration_replace

      requestBody:

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

        required: true
@@ -118,7 +127,7 @@ paths: 
              $ref: '#/components/schemas/ContentPublishingConfiguration'

      responses:

        '200': # OK

          description: 'Updated Content Publishing Configuration'

          description: 'Content Publishing Configuration Replaced'

          content:

            application/json:

              schema:
@@ -152,6 +161,9 @@ paths: 
    patch:

      operationId: patchContentPublishingConfiguration

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

      security:

        - OAuth2:

          - content-publishing-configuration_patch

      requestBody:

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

        required: true
@@ -198,6 +210,9 @@ paths: 
    delete:

      operationId: destroyContentPublishingConfiguration

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

      security:

        - OAuth2:

          - content-publishing-configuration_destroy

      responses:

        '204': # No Content

          description: 'Destroyed Content Publishing Configuration'
@@ -231,6 +246,9 @@ paths: 
    post:

      operationId: purgeContentPublishingCache

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

      security:

        - OAuth2:

          - content-publishing-configuration_purge-cache

      requestBody:

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

        required: true
@@ -280,7 +298,13 @@ components: 
      flows:

        clientCredentials:

          tokenUrl: '{tokenUrl}'

          scopes: {}

          scopes:

            content-publishing-configuration-create: Create the Content Publishing Configuration resource

            content-publishing-configuration_retrieve: Retrieve the Content Publishing Configuration resource

            content-publishing-configuration_replace: Replace the Content Publishing Configuration resource

            content-publishing-configuration_patch: Patch the Content Publishing Configuration resource

            content-publishing-configuration_destroy: Destroy the Content Publishing Configuration resource

            content-publishing-configuration_purge-cache: Purge the cache associated with the Content Publishing Configuration resource



  schemas:

    EgestConfiguration: