SOL005_endpoints.yaml 3.26 KB
Newer Older
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
endpoints:
  api-versions:
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: false
        type: string
    get:
      summary: Retrieve API version information
      description: >
        The GET method reads API version information. This method shall follow the provisions specified in
        table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
        supported.
      responses:
        200:
          description: >
            API version information was read successfully.
            The response body shall contain 4.4 API version
            information, as defined in clause 4.4.1.13.
          schema:
            $ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
        400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' }
        401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' }
        403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' }
        404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' }
        406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' }
        413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
        414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
        416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
        422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
        429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
        500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
        503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
Giacomo Bernini's avatar
Giacomo Bernini committed
        504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
    post:
      description: >
        This method is not supported. When this method is requested on this resource, the API producer shall
        return a "405 Method Not Allowed" response
      responses:
        405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }
    put:
      description: >
        This method is not supported. When this method is requested on this resource, the API producer shall
        return a "405 Method Not Allowed" response
      responses:
        405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }
    patch:
      description: >
        This method is not supported. When this method is requested on this resource, the API producer shall
        return a "405 Method Not Allowed" response
      responses:
        405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }
    delete:
      description: >
        This method is not supported. When this method is requested on this resource, the API producer shall
        return a "405 Method Not Allowed" response
      responses:
        405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }