fastapi-template/openapi.yaml at main · hsanslavillepro/fastapi-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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
openapi: 3.0.3
info:
  title: FastAPI Template API
  version: 0.1.0
  description: Starter OpenAPI contract for the FastAPI template.
servers:
  - url: http://localhost:8000
    description: Local development server
tags:
  - name: default
    description: Default API endpoints
  - name: probes
    description: Kubernetes probe endpoints
paths:
  /hello:
    get:
      operationId: getHello
      summary: Say hello
      tags:
        - default
      responses:
        "200":
          description: Hello response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HelloResponse"
  /health:
    get:
      operationId: getHealth
      summary: Health check
      tags:
        - probes
      responses:
        "200":
          description: Service health status
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProbeResponse"
  /ready:
    get:
      operationId: getReady
      summary: Readiness check
      tags:
        - probes
      responses:
        "200":
          description: Service readiness status
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProbeResponse"
        "503":
          description: Service is not ready
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProbeResponse"
  /live:
    get:
      operationId: getLive
      summary: Liveness check
      tags:
        - probes
      responses:
        "200":
          description: Service liveness status
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProbeResponse"
  /startup:
    get:
      operationId: getStartup
      summary: Startup check
      tags:
        - probes
      responses:
        "200":
          description: Service startup status
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProbeResponse"
        "503":
          description: Service has not completed startup
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProbeResponse"
components:
  schemas:
    HelloResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
          example: Hello from FastAPI template
    ProbeResponse:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          example: ok