Commit a76b3eb2 authored by bradburyr's avatar bradburyr
Browse files

Improved specification of HTTP error responses (third batch).

parent bbcc1cdd

TS26510_Maf_Provisioning_EventDataProcessing.yaml

+112 −15
Original line number Diff line number Diff line
@@ -46,7 +46,7 @@ paths: 
            schema:

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

      responses:

        '201':

        '201': # OK

          description: 'Event Data Processing Configuration Created'

          headers:

            Location:
@@ -54,6 +54,27 @@ paths: 
              required: true

              schema:

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

          content:

            application/json:

              schema:

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

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

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



  /provisioning-sessions/{provisioningSessionId}/event-data-processing-configurations/{eventDataProcessingConfigurationId}:

    parameters:

      - name: provisioningSessionId
@@ -72,12 +93,28 @@ paths: 
      operationId: retrieveEventDataProcessingConfiguration

      summary: 'Retrieve the specified Event Data Processing Configuration of the specified Provisioning Session'

      responses:

        '200':

        '200': # OK

          description: 'Success'

          content:

            application/json:

              schema:

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

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

        '404': # Not Found

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

        '410': # Gone: Resource no longer exists

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

    put:

      operationId: updateEventDataProcessingConfiguration

      summary: 'Update the specified Event Data Processing Configuration for the specified Provisioning Session'
@@ -89,10 +126,34 @@ paths: 
            schema:

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

      responses:

        '204':

          description: 'Updated Event Data Processing Configuration'

        '404':

          description: 'Not Found'

        '200': # OK

          description: 'Event Data Processing Configuration Updated'

          content:

            application/json:

              schema:

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

        '204': # No Content

          description: 'Event Data Processing Configuration Unchanged'

        '403': # Forbidden

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

        '404': # Not Found

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

        '410': # Gone: Resource no longer exists

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

    patch:

      operationId: patchEventDataProcessingConfiguration

      summary: 'Patch the specified Event Data Processing Configuration for the specified Provisioning Session'
@@ -107,22 +168,58 @@ paths: 
            schema:

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

      responses:

        '200':

          description: 'Patched Event Data Processing Configuration'

        '200': # OK

          description: 'Event Data Processing Configuration Patched'

          content:

            application/json:

              schema:

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

        '404':

          description: 'Not Found'

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

        '204': # No Content

          description: 'Event Data Processing Configuration Unchanged'

        '403': # Forbidden

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

        '404': # Not Found

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

        '410': # Gone: Resource no longer exists

          $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: destroyEventDataProcessingConfiguration

      summary: 'Destroy the specified Event Data Processing Configuration of the specified Provisioning Session'

      responses:

        '204':

          description: 'Destroyed Event Data Processing Configuration'

        '404':

          description: 'Not Found'

        '204': # No Content

          description: 'Event Data Processing 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'

        '404': # Not Found

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

        '409': # Conflict: Resource still referenced by another

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

        '410': # Gone: Resource no longer exists

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



components:

  securitySchemes:

TS26510_Maf_Provisioning_MetricsReporting.yaml

+113 −15
Original line number Diff line number Diff line
@@ -46,7 +46,7 @@ paths: 
            schema:

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

      responses:

        '201':

        '201': # OK

          description: 'Metrics Reporting Configuration Created'

          headers:

            Location:
@@ -54,6 +54,27 @@ paths: 
              required: true

              schema:

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

          content:

            application/json:

              schema:

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

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

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



  /provisioning-sessions/{provisioningSessionId}/metrics-reporting-configurations/{metricsReportingConfigurationId}:

    parameters:

      - name: provisioningSessionId
@@ -72,12 +93,28 @@ paths: 
      operationId: retrieveMetricsReportingConfiguration

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

      responses:

        '200':

        '200': # OK

          description: 'Success'

          content:

            application/json:

              schema:

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

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

        '404': # Not Found

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

        '410': # Gone: Resource no longer exists

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

    put:

      operationId: updateMetricsReportingConfiguration

      summary: 'Update the specified Metrics Reporting Configuration for the specified Provisioning Session'
@@ -89,10 +126,34 @@ paths: 
            schema:

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

      responses:

        '204':

          description: 'Updated Metrics Reporting Configuration'

        '404':

          description: 'Not Found'

        '200': # OK

          description: 'Metrics Reporting Configuration Updated'

          content:

            application/json:

              schema:

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

        '204': # No Content

          description: 'Metrics Reporting Configuration Unchanged'

        '403': # Forbidden

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

        '404': # Not Found

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

        '410': # Gone: Resource no longer exists

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

    patch:

      operationId: patchMetricsReportingConfiguration

      summary: 'Patch the specified Metrics Reporting Configuration for the specified Provisioning Session'
@@ -107,22 +168,59 @@ paths: 
            schema:

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

      responses:

        '200':

          description: 'Patched Metrics Reporting Configuration'

        '200': # OK

          description: 'Metrics Reporting Configuration Patched'

          content:

            application/json:

              schema:

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

        '404':

          description: 'Not Found'

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

        '204': # No Content

          description: 'Metrics Reporting Configuration Unchanged'

        '403': # Forbidden

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

        '404': # Not Found

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

        '410': # Gone: Resource no longer exists

          $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: destroyMetricsReportingConfiguration

      summary: 'Destroy the specified Metrics Reporting Configuration of the specified Provisioning Session'

      responses:

        '204':

          description: 'Destroyed Metrics Reporting Configuration'

        '404':

          description: 'Not Found'    

      responses:

        '204': # No Content

          description: 'Metrics Reporting 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'

        '404': # Not Found

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

        '409': # Conflict: Resource still referenced by another

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

        '410': # Gone: Resource no longer exists

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



components:

  securitySchemes:

TS26510_Maf_Provisioning_PolicyTemplates.yaml

+2 −2
Original line number Diff line number Diff line
@@ -37,7 +37,7 @@ paths: 
        description: 'The resource identifier of an existing Provisioning Session.'

    post:

      operationId: createPolicyTemplate

      summary: 'Create (and optionally upload) a new Policy Template'

      summary: 'Create and upload a new Policy Template for the specified Provisioning Session'

      requestBody:

        description: 'A JSON representation of a Policy Template'

        required: true