aboutsummaryrefslogtreecommitdiff
path: root/src/files/SwaggerUI.yaml
blob: 019ca5ed4cce420855a54df269153411728e303a (plain)
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
openapi: 3.0.0
info:
  title: Converted from Thread.yaml with typeconv
  version: '1'
  x-id: Thread.yaml
  x-comment: >-
    Generated from src/models/Thread.ts by core-types-json-schema
    (https://github.com/grantila/core-types-json-schema) on behalf of typeconv
    (https://github.com/grantila/typeconv)
paths:
  /custom:
    post:
      summary: Run a custom sql query
      responses:
        '200':
          description: Success
        '500':
          description: Failed
      requestBody:
        descripton: The command to run
        content:
          text/plain:
            schema:
              title: Command
              type: string
  /boards:
    get:
      summary: Get boards
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '404':
          description: Not Found
  /boards/{board}:
    post:
      summary: Creat a new board
      parameters:
        - name: board
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
        '500':
          description: Failed
  /board/{board}:
    get:
      summary: Get threads in board
      parameters:
        - name: board
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Thread'
        '404':
          description: Not Found
    post:
      summary: Post a thread
      parameters:
        - name: board
          in: path
          required: true
          schema:
            type: string
      requestBody:
        description: Thread to post
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Thread'
      responses:
        '200':
          description: Success
        '500':
          description: Failed

  /board/{board}/{tid}:
    get:
      summary: Get a thread
      parameters:
        - name: board
          in: path
          required: true
          schema:
            type: string
        - name: tid
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Thread'
        '404':
            description: Not Found
    post:
      summary: Post a comment
      parameters:
        - name: board
          in: path
          required: true
          schema:
            type: string
        - name: tid
          in: path
          required: true
          schema:
            type: string
      requestBody:
        descriptors: The comment to post
        content:
          application/json:
            schema:
              $ref: '#components/schemas/Comment'
      responses:
        '200':
          description: Success
        '500':
          description: Failed

components:
  schemas:
    Comment:
      properties:
        id:
          title: Comment.id
          type: string
        timestamp:
          title: Comment.timestamp
          type: number
        content:
          title: Comment.content
          type: string
        image:
          title: Comment.image
          type: string
        imagetype:
          title: Comment.imagetype
          type: string
      required:
        - id
        - timestamp
        - content
        - image
        - imagetype
      additionalProperties: false
      title: Comment
      type: object
    Thread:
      properties:
        id:
          title: Thread.id
          type: string
        timestamp:
          title: Thread.timestamp
          type: number
        title:
          title: Thread.title
          type: string
        content:
          title: Thread.content
          type: string
        comments:
          items:
            $ref: '#/components/schemas/Comment'
            title: Thread.comments.[]
          title: Thread.comments
          type: array
        image:
          title: Thread.image
          type: string
        imagetype:
          title: Thread.imagetype
          type: string
      required:
        - id
        - title
        - contnet
        - comments
        - timestamp
        - image
        - imageType
      additionalProperties: false
      title: Thread
      type: object