fastify-openapi-template/api-docs.yaml at dynamodb-firebase · fraternie/fastify-openapi-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.2
info:
  description: Basic API Template
  version: 1.0.0
  title: Base API
  contact:
    email: tech@fraternie.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: http://localhost:3000
security:
  - firebaseAuth: [ ]
tags:
  - name: Docs
  - name: Base
paths:
  /api:
    get:
      operationId: api
      tags:
        - Docs
      description: Gets the Api docs when in dev mode
      responses:
        200:
          description: Gets the Api docs when in dev mode
          content:
            application/yaml: { }
        400:
          $ref: "#/components/responses/ErrorResponse"
        500:
          $ref: "#/components/responses/ErrorResponse"
  /base:
    get:
      operationId: base
      tags:
        - Base
      description: Base service dummy response
      security: [ ]
      parameters:
        - $ref: "#/components/parameters/CountParam"
      responses:
        200:
          description: Base service dummy response
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: string
        400:
          $ref: "#/components/responses/ErrorResponse"
        500:
          $ref: "#/components/responses/ErrorResponse"
components:
  parameters:
    CountParam:
      in: query
      name: count
      schema:
        nullable: false
        maximum: 40
        minimum: 1
        default: 20
        type: integer

  responses:
    ErrorResponse:
      description: Error response
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorSchema"

  securitySchemes:
    firebaseAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Uses firebase idToken for auth

  schemas:
    ErrorSchema:
      type: object
      required:
        - message
        - error
        - statusCode
        - data
      properties:
        message:
          type: string
        error:
          type: string
        statusCode:
          type: number
        data:
          type: object
          nullable: true
    UserType:
      type: string
      enum:
        - A
        - B
        - C