SOL002SOL003_endpoints.yaml 2.51 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
# 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: >
21 22
            200 OK
            
23 24 25 26
            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:
27
            $ref: '../definitions/SOL002SOL003_def.yaml#/definitions/ApiVersionInformation'
28 29 30 31 32 33 34 35 36 37 38
          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
f.moscatelli's avatar
f.moscatelli committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52
        400: { $ref: '../responses/SOL002SOL003_resp.yaml#/components/responses/400' }
        401: { $ref: '../responses/SOL002SOL003_resp.yaml#/components/responses/401' }
        403: { $ref: '../responses/SOL002SOL003_resp.yaml#/components/responses/403' }
        404: { $ref: '../responses/SOL002SOL003_resp.yaml#/components/responses/404' }
        405: { $ref: '../responses/SOL002SOL003_resp.yaml#/components/responses/405' }
        406: { $ref: '../responses/SOL002SOL003_resp.yaml#/components/responses/406' }
        413: { $ref: '../responses/SOL002SOL003_resp.yaml#/components/responses/413' }
        414: { $ref: '../responses/SOL002SOL003_resp.yaml#/components/responses/414' }
        416: { $ref: '../responses/SOL002SOL003_resp.yaml#/components/responses/416' }
        422: { $ref: '../responses/SOL002SOL003_resp.yaml#/components/responses/422' }
        429: { $ref: '../responses/SOL002SOL003_resp.yaml#/components/responses/429' }
        500: { $ref: '../responses/SOL002SOL003_resp.yaml#/components/responses/500' }
        503: { $ref: '../responses/SOL002SOL003_resp.yaml#/components/responses/503' }
        504: { $ref: '../responses/SOL002SOL003_resp.yaml#/components/responses/504' }