Commit 1da6bacf authored by bradburyr's avatar bradburyr
Browse files

Improved specification of HTTP error responses (second batch).

parent 3c5cf9e5

TS26510_Maf_Provisioning_EdgeResources.yaml

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

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

      responses:

        '201':

        '201': # Created

          description: 'Edge Resources Configuration Created'

          headers:

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

              schema:

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

          content:

            application/json:

              schema:

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

        '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}/edge-resources-configurations/{edgeResourcesConfigurationId}:

    parameters:

      - name: provisioningSessionId
@@ -72,12 +92,28 @@ paths: 
      operationId: retrieveEdgeResourcesConfiguration

      summary: 'Retrieve the Edge Resources Configuration of the specified Provisioning Session'

      responses:

        '200':

        '200': # OK

          description: 'Success'

          content:

            application/json:

              schema:

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

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

      summary: 'Update an Edge Resources Configuration for the specified Provisioning Session'
@@ -89,10 +125,34 @@ paths: 
            schema:

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

      responses:

        '204':

          description: 'Updated Edge Resources Configuration'

        '404':

          description: 'Not Found'

        '200': # OK

          description: 'Edge Resources Configuration Updated'

          content:

            application/json:

              schema:

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

        '204': # No Content

          description: 'Edge Resources 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: patchEdgeResourcesConfiguration

      summary: 'Patch the Edge Resources Configuration for the specified Provisioning Session'
@@ -107,21 +167,58 @@ paths: 
            schema:

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

      responses:

        '200':

          description: 'Patched Edge Resources Configuration'

        '200': # OK

          description: 'Edge Resources Configuration Patched'

          content:

            application/json:

              schema:

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

        '404':

          description: 'Not Found'

        '204': # No Content

          description: 'Edge Resources 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: destroyEdgeResourcesConfiguration

      summary: 'Destroy the specified Edge Resources Configuration of the specified Provisioning Session'

      responses:

        '204':

          description: 'Destroyed Edge Resources Configuration'

        '404':

          description: 'Not Found'

        '204': # No Content

          description: 'Edge Resources 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

+111 −17
Original line number Diff line number Diff line
@@ -46,7 +46,7 @@ paths: 
            schema:

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

      responses:

        '201':

        '201': # OK

          description: 'Policy Template Created'

          headers:

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

              schema:

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

          content:

            application/json:

              schema:

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

        '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}/policy-templates/{policyTemplateId}:

    parameters:
@@ -73,14 +93,28 @@ paths: 
      operationId: retrievePolicyTemplate

      summary: 'Retrieve a representation of an existing Policy Template in the specified Provisioning Session'

      responses:

        '200':

        '200': # OK

          description: 'Success'

          content:

            application/json:

              schema:

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

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

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

      summary: 'Update a Policy Template for the specified Provisioning Session'
@@ -92,10 +126,34 @@ paths: 
            schema:

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

      responses:

        '204':

          description: 'Updated Policy Template'

        '404':

          description: 'Not Found'

        '200': # OK

          description: 'Policy Template Updated'

          content:

            application/json:

              schema:

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

        '204': # No Content

          description: 'Policy Template 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: patchPolicyTemplate

      summary: 'Patch the Policy Template for the specified Provisioning Session'
@@ -110,21 +168,57 @@ paths: 
            schema:

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

      responses:

        '200':

          description: 'Patched Content Hosting Configuration'

        '200': # OK

          description: 'Policy Template Patched'

          content:

            application/json:

              schema:

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

        '404':

          description: 'Not Found'

        '204': # No Content

          description: 'Policy Template 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: destroyPolicyTemplate

      responses:

        '204':

          description: 'Destroyed Policy Template'

        '404':

          description: 'Not Found'

        '204': # No Content

          description: 'Policy Template 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: