static-files-microservice/docs/openapi/spec.yaml at main · upb-code-labs/static-files-microservice · 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
openapi: 3.0.3

info:
  title: UPB Code Labs - Static Files Microservice
  license:
    name: AGPL-3.0
    url: https://github.com/upb-code-labs/static-files-microservice/blob/main/LICENSE
  version: 0.4.0

tags:
  - name: Archives
  - name: Templates

paths:

  /archives/save:
    post:
      tags:
        - Archives
      description: Save a `zip` archive.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary  # A `.zip` archive
                archive_type:
                  type: string
                  enum: ["submission", "test"]
      responses:
        "201":
          description: The archive was saved.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uuid:
                    type: string
                    example: "5279018f-5b8a-4635-85e5-828ec2a8db06"
        "400":
          description: The request is not valid or the fields validation failed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/default_error_response"
        "500":
          description: Server side error or unexpected error.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/default_error_response"

  /archives/download:
    post:
      tags:
        - Archives
      description: Download a `zip` archive.
      requestBody:
        content:
          json:
            schema:
              type: object
              properties:
                archive_uuid:
                  type: string
                  example: "5279018f-5b8a-4635-85e5-828ec2a8db06"
                archive_type:
                  type: string
                  enum: ["submission", "test"]
      responses:
        "200":
          description: The archive is downloaded / sent.
          content:
            application/zip:
              schema:
                type: string
                format: binary
        "400":
          description: The request is not valid or the fields validation failed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/default_error_response"
        "404":
          description: No archive with the given UUID and type was found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/default_error_response"
        "500":
          description: Server side error or unexpected error.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/default_error_response"

  /archives/delete:
    post:
      tags:
        - Archives
      description: Delete a `zip` archive.
      requestBody:
        content:
          json:
            schema:
              type: object
              properties:
                archive_uuid:
                  type: string
                  example: "5279018f-5b8a-4635-85e5-828ec2a8db06"
                archive_type:
                  type: string
                  enum: ["submission", "test"]
      responses:
        "204":
          description: The archive was removed.
        "400":
          description: The request is not valid or the fields validation failed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/default_error_response"
        "404":
          description: No archive with the given UUID and type was found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/default_error_response"
        "500":
          description: Server side error or unexpected error.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/default_error_response"

  /archives/overwrite:
    put:
      tags:
        - Archives
      description: Overwrite a `zip` archive.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary  # A `.zip` archive
                archive_uuid:
                  type: string
                  example: "5279018f-5b8a-4635-85e5-828ec2a8db06"
                archive_type:
                  type: string
                  enum: ["submission", "test"]
      responses:
        "204":
          description: The archive was overwrited.
        "400":
          description: The request is not valid or the fields validation failed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/default_error_response"
        "404":
          description: No archive with the given UUID and type was found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/default_error_response"
        "500":
          description: Server side error or unexpected error.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/default_error_response"

  /teamplates/{language_uuid}:
    get:
      tags:
        - Templates
      parameters:
        - in: path
          name: language_uuid
          schema:
            type: string
            example: "746132f0-11d5-4a3e-a3a7-74a56e45cf1c"
          required: true
      description: Download the `.zip` archive with the template for the given language.
      responses:
        "200":
          description: The archive is downloaded / sent.
          content:
            application/zip:
              schema:
                type: string
                format: binary
        "400":
          description: The request is not valid or the fields validation failed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/default_error_response"
        "404":
          description: No template for the given UUID and type was found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/default_error_response"
        "500":
          description: Server side error or unexpected error.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/default_error_response"

components:
  schemas:
    default_error_response:
      type: object
      properties:
        message:
          type: string
          example: "Something went wrong. Try again later."