go-template/server/openapi.yaml at main · heppu/go-template · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# yaml-language-server: $schema=https://raw.githubusercontent.com/OAI/OpenAPI-Specification/refs/heads/main/schemas/v3.1/schema.yaml
openapi: "3.1.0"
servers:
  - url: /api/v1
info:
  version: 1.0.0
  title: API schema
paths:
  /healthz:
    get:
      summary: Servers health check endpoint
      tags:
        - health
      operationId: healthz
      responses:
        "200":
          $ref: "#/components/responses/HealthyResp"
        default:
          $ref: "#/components/responses/ErrorResp"
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
    Healthy:
      type: object
      required:
        - message
      properties:
        message:
          type: string

  responses:
    ErrorResp:
      description: Error response
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"
          example:
            error: Unexpected server error
    HealthyResp:
      description: Response from healthy server
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Healthy"
          example:
            message: OK