seaals/openapi.yaml at master · Kirimson/seaals · 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
openapi: "3.0.0"
info:
  version: 1.0.0
  title: SEAaLS API server
paths:
  /api/stats:
    get:
      summary: Get stats of the server
      tags:
        - API
      responses:
        "200":
          description: JSON data of server stats
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Stats"
  /api/seal:
    get:
      summary: Get a JSON reprentation of a random Seal
      tags:
        - API
      parameters:
        - $ref: "#/components/parameters/tagParam"
      responses:
        "200":
          description: JSON data of a seal
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Seal"
  /api/seal/{id}:
    get:
      summary: Get a JSON reprentation of a Seal by their ID
      tags:
        - API
      parameters:
        - in: path
          name: id
          schema:
            type: string
          required: true
      responses:
        "200":
          description: JSON data of a seal
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Seal"
  /seal:
    get:
      summary: Get a random Seal
      tags:
        - Seals
      parameters:
        - $ref: "#/components/parameters/tagParam"
        - $ref: "#/components/parameters/filterParam"
        - $ref: "#/components/parameters/permalinkParam"
      responses:
        "200":
          description: Image of a seal
          content:
            image/*:
              type: string
              format: binary
        "302":
          description: Redirect to the permalink URL of a random seal with provided parameters
  /seal/{id}:
    get:
      summary: Get a Seal by their ID
      tags:
        - Seals
      parameters:
        - in: path
          name: id
          schema:
            type: string
          required: true
        - $ref: "#/components/parameters/filterParam"
      responses:
        "200":
          description: Image of a seal
          content:
            image/*:
              type: string
              format: binary
  /seal/says/{text}:
    get:
      summary: Get a random Seal saying something
      tags:
        - Seals
      parameters:
        - in: path
          name: text
          schema:
            type: string
          required: true
        - $ref: "#/components/parameters/tagParam"
        - $ref: "#/components/parameters/filterParam"
        - $ref: "#/components/parameters/positionParam"
        - $ref: "#/components/parameters/fontSizeParam"
        - $ref: "#/components/parameters/fontColourParam"
        - $ref: "#/components/parameters/borderSizeParam"
        - $ref: "#/components/parameters/borderColourParam"
        - $ref: "#/components/parameters/permalinkParam"
      responses:
        "200":
          description: Image of a seal saying something
          content:
            image/*:
              type: string
              format: binary
        "302":
          description: Redirect to the permalink URL of a random seal with provided parameters
  /seal/{id}/says/{text}:
    get:
      summary: Get a random Seal saying something
      tags:
        - Seals
      parameters:
        - in: path
          name: id
          schema:
            type: string
          required: true
        - in: path
          name: text
          schema:
            type: string
          required: true
        - $ref: "#/components/parameters/filterParam"
        - $ref: "#/components/parameters/positionParam"
        - $ref: "#/components/parameters/fontSizeParam"
        - $ref: "#/components/parameters/fontColourParam"
        - $ref: "#/components/parameters/borderSizeParam"
        - $ref: "#/components/parameters/borderColourParam"
      responses:
        "200":
          description: Image of a seal saying something
          content:
            image/*:
              type: string
              format: binary
components:
  parameters:
    tagParam:
      in: query
      name: tag
      schema:
        type: string
      required: false
      description: Tag of the Seal
    filterParam:
      in: query
      name: filter
      schema:
        type: string
        enum:
          - monochrome
          - invert
          - funky
      required: false
      description: Filter to apply to the image
    positionParam:
      in: query
      name: position
      schema:
        type: string
        enum:
          - top
          - bottom
          - middle
          - left
          - right
      required: false
      description: Position of the caption text on the image
    fontSizeParam:
      in: query
      name: fontSize
      schema:
        type: integer
        minimum: 0
        default: 48
      required: false
      description: Size of the caption text
    fontColourParam:
      in: query
      name: fontColour
      schema:
        type: string
        default: white
      required: false
      description: Colour of the caption text
    borderColourParam:
      in: query
      name: borderColour
      schema:
        type: string
        default: black
      required: false
      description: Colour of the caption border
    borderSizeParam:
      in: query
      name: borderSize
      schema:
        type: integer
        minimum: 0
        default: 2
      required: false
      description: Thickness of the caption border
    permalinkParam:
      in: query
      name: permalink
      schema:
        type: boolean
        default: false
      required: false
      description: Redirect to the permalink URL of the image with provided parameters
  schemas:
    Stats:
      type: object
      required:
        - count
        - tags
      properties:
        count:
          type: integer
        tags:
          type: array
          items:
            $ref: "#/components/schemas/TagStats"
    TagStats:
      type: object
      required:
        - name
        - count
      properties:
        name:
          type: string
        count:
          type: integer
    Seal:
      type: object
      required:
        - id
        - permalink
        - tags
        - mimeType
        - createdAt
      properties:
        id:
          type: string
        permalink:
          type: string
        tags:
          type: array
          items:
            $ref: "#/components/schemas/Tag"
        mimeType:
          type: string
        createdAt:
          type: string
    Tag:
      type: string