Commit a7edb01b authored by bradburyr's avatar bradburyr
Browse files

Improved specification of HTTP error responses (fourth batch).

parent 461f67c7

TS26510_Maf_Provisioning_ConsumptionReporting.yaml

+122 −14
Original line number Diff line number Diff line
@@ -46,7 +46,7 @@ paths: 
            schema:

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

      responses:

        '201':

        '201': # OK

          description: 'Consumption Reporting Configuration Created'

          headers:

            Location:
@@ -54,16 +54,56 @@ paths: 
              required: true

              schema:

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

          content:

            application/json:

              schema:

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

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

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

      operationId: retrieveConsumptionReportingConfiguration

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

      responses:

        '200':

        '200': # OK

          description: 'Success'

          content:

            application/json:

              schema:

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

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

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

      summary: 'Update the Consumption Reporting Configuration for the specified Provisioning Session'
@@ -75,10 +115,38 @@ paths: 
            schema:

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

      responses:

        '204':

          description: 'Updated Consumption Reporting Configuration'

        '404':

          description: 'Not Found'

        '200': # OK

          description: 'Consumption Reporting Configuration Updated'

          content:

            application/json:

              schema:

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

        '204': # No Content

          description: 'Consumption Reporting 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/411'

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

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

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

      responses:

        '200':

          description: 'Patched Consumption Reporting Configuration'

        '200': # OK

          description: 'Consumption Reporting Configuration Updated'

          content:

            application/json:

              schema:

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

        '404':

          description: 'Not Found'

        '204': # No Content

          description: 'Consumption Reporting 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/411'

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

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

      responses:

        '204':

          description: 'Destroyed Consumption Reporting Configuration'

        '404':

          description: 'Not Found'

        '204': # No Content

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

        '401': # Unauthorized

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

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



components:

  securitySchemes:

TS26510_Maf_SessionHandling_DynamicPolicy.yaml

+124 −42
Original line number Diff line number Diff line
@@ -39,22 +39,36 @@ paths: 
            schema:

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

      responses:

        '201':

          description: 'Created Dynamic Policy Resource'

          content:

            application/json:

              schema:

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

        '201': # OK

          description: 'Dynamic Policy Resource Created'

          headers:

            Location:

              description: 'The URL of the newly created Dynamic Policy resource'

              required: true

              schema:

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

        '400':

          description: 'Bad Request'

        '401':

          description: 'Unauthorized'

          content:

            application/json:

              schema:

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

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

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

 

  /dynamic-policies/{dynamicPolicyId}:

    parameters:
@@ -68,18 +82,30 @@ paths: 
      operationId: retrieveDynamicPolicy

      summary: 'Retrieve an existing Dynamic Policy resource'

      responses:

        '200':

        '200': # OK

          description: 'Success'

          content:

            application/json:

              schema:

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

        '400':

          description: 'Bad Request'

        '401':

          description: 'Unauthorized'

        '404':

          description: 'Not Found'

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

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

      summary: 'Update an existing Dynamic Policy resource'
@@ -91,12 +117,38 @@ paths: 
            schema:

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

      responses:

        '400':

          description: 'Bad Request'

        '401':

          description: 'Unauthorized'

        '404':

          description: 'Not found'

        '200': # OK

          description: 'Dynamic Policy Updated'

          content:

            application/json:

              schema:

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

        '204': # No Content

          description: 'Dynamic Policy 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/411'

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

      summary: 'Patch an existing Dynamic Policy resource'
@@ -111,32 +163,62 @@ paths: 
            schema:

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

      responses:

        '200':

          description: 'Patched Dynamic Policy'

        '200': # OK

          description: 'Dynamic Policy Patched'

          content:

            application/json:

              schema:

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

        '204':

          description: 'Patched Dynamic Policy'

        '400':

          description: 'Bad Request'

        '401':

          description: 'Unauthorized'

        '404':

          description: 'Not found'

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

        '204': # No Content

          description: 'Dynamic Policy 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/411'

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

      summary: 'Destroy an existing Dynamic Policy resource'

      responses:

        '204':

          description: 'Destroyed Dynamic Policy'

        '400':

          description: 'Bad Request'

        '401':

          description: 'Unauthorized'

        '404':

          description: 'Not Found'

        '204': # No Content

          description: 'Dynamic Policy 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/411'

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



components:

  securitySchemes:

TS26510_Maf_SessionHandling_NetworkAssistance.yaml

+125 −40

File changed.

Preview size limit exceeded, changes collapsed.

TS26510_Maf_SessionHandling_ServiceAccessInformation.yaml

+20 −4
Original line number Diff line number Diff line
@@ -40,14 +40,30 @@ paths: 
      operationId: retrieveServiceAccessInformation

      summary: 'Retrieve the Service Access Information resource'

      responses:

        '200':

        '200': # OK

          description: 'Success'

          content:

            application/json:

              schema:

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

        '404':

          description: 'Not Found'

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

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

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



components:

  securitySchemes: