dev-davidchang-api/swaggerspec.yaml at main · davidianstyle/dev-davidchang-api · 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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
swagger: "2.0"
host: api.davidchang.dev
info:
  title: David Chang API
  version: 0.0.3
x-google-backend:
  address: https://dev-davidchang-api-go-app-oo452quldq-uc.a.run.app
  pathTranslation: APPEND_PATH_TO_ADDRESS

paths:
  '/':
    get:
      summary: Redirect to https://docs.davidchang.dev
      operationId: redirectToDocs
      responses:
        '301':
          description: Permanent Redirect
          headers:
            Location:
              type: string
              format: uri
              description: Redirect URL
  "/webhook":
    get:
      summary: GET request for Node.js service
      operationId: getNodeJSData
      x-google-backend:
        address: https://dev-davidchang-api-nodejs-app-oo452quldq-uc.a.run.app
        pathTranslation: APPEND_PATH_TO_ADDRESS
      responses:
        "200":
          description: Successful response
        default:
          description: Default response for GET request to Node.js service

    post:
      summary: POST request for Go service
      operationId: postNodeJSData
      x-google-backend:
        address: https://dev-davidchang-api-nodejs-app-oo452quldq-uc.a.run.app
        pathTranslation: APPEND_PATH_TO_ADDRESS
      responses:
        "200":
          description: Successful response
        default:
          description: Default response for POST request to Go service

    put:
      summary: PUT request for Node.js service
      operationId: putNodeJSData
      x-google-backend:
        address: https://dev-davidchang-api-nodejs-app-oo452quldq-uc.a.run.app
        pathTranslation: APPEND_PATH_TO_ADDRESS
      responses:
        "200":
          description: Successful response
        default:
          description: Default response for PUT request to Node.js service

    delete:
      summary: DELETE request for Node.js service
      operationId: deleteNodeJSData
      x-google-backend:
        address: https://dev-davidchang-api-nodejs-app-oo452quldq-uc.a.run.app
        pathTranslation: APPEND_PATH_TO_ADDRESS
      responses:
        "200":
          description: Successful response
        default:
          description: Default response for DELETE request to Node.js service

    patch:
      summary: PATCH request for Node.js service
      operationId: patchNodeJSData
      x-google-backend:
        address: https://dev-davidchang-api-nodejs-app-oo452quldq-uc.a.run.app
        pathTranslation: APPEND_PATH_TO_ADDRESS
      responses:
        "200":
          description: Successful response
        default:
          description: Default response for PATCH request to Node.js service

  '/resumes/latest':
    get:
      operationId: getLatestResume
      summary: Get the most recent resumé
      description: API to get the most recent resumé by year. In case of a tie, returns the most recently modified one.
      tags:
        - resumes
      responses:
        '200':
          description: OK
          schema:
            type: object
            properties:
              id:
                type: string
              year:
                type: integer
              URL:
                type: string
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              message:
                type: string
        default:
          description: Unexpected Error
          schema:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
  '/resumes':
    get:
      operationId: getResumes
      summary: Get all resumés
      description: Simple API that returns a JSON array of all available resumés
      tags:
        - resumes
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              type: object
              properties:
                id:
                  type: string
                year:
                  type: integer
                URL:
                  type: string
        default:
          description: Unexpected Error
          schema:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
    post:
      operationId: addResume
      summary: Add new resumé
      description: Simple API to add a new resumé to the database
      tags:
        - resumes
      parameters: []
      responses:
        '201':
          description: Created
          schema:
            type: object
            properties:
              id:
                type: string
              year:
                type: integer
              URL:
                type: string
        default:
          description: Unexpected Error
          schema:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
  '/resumes/{id}':
    get:
      operationId: getResumeById
      summary: Get resumé by ID
      description: Simple API to get a single resumé by ID
      tags:
        - resumes
      parameters:
        - name: id
          in: path
          required: true
          type: string
          description: Autoincremented value uniquely identifying the resumé
      responses:
        '200':
          description: OK
          schema:
            type: object
            properties:
              id:
                type: string
              year:
                type: integer
              URL:
                type: string
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              message:
                type: string
        default:
          description: Unexpected Error
          schema:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
    patch:
      operationId: updateResumeByID
      summary: Update resumé by ID
      description: Simple API to update an existing resumé by ID
      tags:
        - resumes
      parameters:
        - name: id
          in: path
          required: true
          type: string
          description: Autoincremented value uniquely identifying the resumé
      responses:
        '200':
          description: OK
          schema:
            type: object
            properties:
              id:
                type: string
              year:
                type: integer
              URL:
                type: string
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              message:
                type: string
        default:
          description: Unexpected Error
          schema:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
    delete:
      operationId: deleteResumeById
      summary: Delete resumé by ID
      description: Simple API to delete a single resumé by ID
      tags:
        - resumes
      parameters:
        - name: id
          in: path
          required: true
          type: string
          description: Autoincremented value uniquely identifying the resumé
      responses:
        '200':
          description: OK
          schema:
            type: object
            properties:
              message:
                type: string
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              message:
                type: string
        '500':
          description: Internal Server Error
          schema:
            type: object
            properties:
              message:
                type: string