Go-Backend-Template/PROJECT_TITLE.openapi.yml at develop · CETEN-BDE/Go-Backend-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
openapi: "3.0.3"
info:
  title: OpenAPI - Log BDE
  version: "1.0.0"
  license:
    name: MIT
    url: https://opensource.org/license/mit/
servers:
  - url: http://localhost:8080
  - url: https://log.ceten.fr/api
paths:
  /health:
    get:
      responses:
        "200":
          description: "Health check"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Example"
        "500":
          description: "Error 500"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Message"
components:
  securitySchemes:
    Ceten:
      type: http
      scheme: bearer
      bearerFormat: JWT
    BDE:
      type: http
      scheme: bearer
      bearerFormat: JWT
    Admin:
      type: http
      scheme: bearer
      bearerFormat: JWT

  schemas:
    # base types
    Example:
      type: object
      required:
        - status
        - nb
      properties:
        status:
          type: string
          example: "ok"
        nb:
          type: integer
          example: 1
    Message:
      type: object
      required:
        - message
      properties:
        message:
          type: string
          example: "Error message"