sample-app/openapi.yaml at main · hatchan/sample-app · 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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
---
openapi: "3.0.3"
info:
  title: User service
  version: "1.0"
servers:
  - url: http://localhost:3000/
    description: Local development
components:
  schemas:
    user:
      type: object
      required:
        - username
        - name
      properties:
        username:
          type: string
        name:
          type: string
    new_user:
      type: object
      required:
        - username
        - name
      properties:
        username:
          type: string
        name:
          type: string
    get_user_error:
      oneOf:
        - $ref: "#/components/schemas/get_user_error_not_found"
        - $ref: "#/components/schemas/unauthorized"
        - $ref: "#/components/schemas/unauthenticated"
      discriminator:
        propertyName: error
        mapping:
          not_found: "#/components/schemas/get_user_error_not_found"
          unauthorized: "#/components/schemas/unauthorized"
          unauthenticated: "#/components/schemas/unauthenticated"
    get_user_error_type:
      type: string
      enum:
        - not_found
        - unauthorized
        - unauthenticated
    get_user_error_not_found:
      type: object
      required:
        - error
        - details
      properties:
        error:
          $ref: "#/components/schemas/get_user_error_type"
        details:
          type: object
          required:
            - username
          properties:
            username:
              type: string

    create_user_error:
      oneOf:
        - $ref: "#/components/schemas/create_user_error_username_already_exists"
        - $ref: "#/components/schemas/create_user_error_invalid_username"
        - $ref: "#/components/schemas/create_user_error_invalid_name"
      discriminator:
        propertyName: error
        mapping:
          UsernameAlreadyExists: "#/components/schemas/create_user_error_username_already_exists"
          InvalidUsername: "#/components/schemas/create_user_error_invalid_username"
          InvalidName: "#/components/schemas/create_user_error_invalid_name"
    create_user_error_type:
      type: string
      enum:
        - not_found
    create_user_error_username_already_exists:
      type: object
      required:
        - error
      properties:
        error:
          $ref: "#/components/schemas/create_user_error_type"
    create_user_error_invalid_username:
      type: object
      required:
        - error
        - details
      properties:
        error:
          $ref: "#/components/schemas/create_user_error_type"
        details:
          type: string
          enum:
            - TooShort
            - TooLong
            - InvalidCharacters
    create_user_error_invalid_name:
      type: object
      required:
        - error
        - details
      properties:
        error:
          $ref: "#/components/schemas/create_user_error_type"
        details:
          type: string
          enum:
            - TooShort
            - TooLong
            - InvalidCharacters

    unauthenticated:
      type: object
      required:
        - error
      properties:
        error:
          $ref: "#/components/schemas/get_user_error_type"
    unauthorized:
      type: object
      required:
        - error
        - details
      properties:
        error:
          $ref: "#/components/schemas/get_user_error_type"
        details:
          type: object
          properties:
            action:
              type: string
  responses:
    Unauthenticated:
      description: Unauthenticated
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/get_user_error"
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/get_user_error"
paths:
  /users:
    post:
      operationId: create_user
      summary: "Create a new user"
      description: "Create a new user"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/new_user"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/user"
        default:
          description: Create user error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/create_user_error"
  /users/{username}:
    parameters:
      - name: username
        required: true
        schema:
          type: string
        in: path
    get:
      operationId: get_user
      summary: "Get a single user"
      description: "Get a single user"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/user"
        default:
          description: Get user error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/get_user_error"