aboutsummaryrefslogtreecommitdiffstats
path: root/Writerside/api-docs/patchwork-archive-api.yml
blob: c17c0c6051b0e20748815a071da974ddc7c478d6 (plain) (blame)
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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
openapi: 3.0.3
info:
  title: Patchwork Archive API
  description: |-
    API data from Patchwork Archive is public and **no API key** is required to access what is publicly available on the frontend.

  license:
    name: MIT License
    url: https://opensource.org/license/mit/
  version: MIT
servers:
  - url: https://archive.pinapelz.moe/api
tags:
  - name: channel
    description: Data regarding a specific channel
  - name: video
    description: Data regarding archived videos
  - name: database
    description: More detailed data regarding videos
paths:
  /channel/{channel_id}:
    get:
      tags:
        - channel
      summary: Gets archived videos from a particular channel
      description: Gets a paginated result of archived videos matching a channel id
      parameters:
        - name: channel_id
          in: path
          description: YouTube Channel ID
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: Page of video to show (starts on page 1)
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Video'
  /channel_name:
    get:
      tags:
        - channel
      summary: Gets archived videos from a particular channel
      description: Gets a paginated result of archived videos matching a channel id
      parameters:
        - name: channel_id
          in: query
          description: YouTube Channel ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  channel_name:
                    type: string
                    example: Erina Ch. エリナ・マキナ 【Phase Connect】


  /video/{video_id}:
    get:
      tags:
        - video
      summary: Get basic information regarding a specific video
      description: Pulls basic information about a video from fallback database only
      operationId: getBasicVideoInfo
      parameters:
        - name: video_id
          in: path
          description: YouTube Video ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  channel_id:
                    type: string
                    example: UCupmjRr7kPgzXKh-cPxxGbg
                  channel_name:
                    type: string
                    example: Erina Ch. エリナ・マキナ 【Phase Connect】
                  description:
                    type: string
                    example: The very long description portion
                  title:
                    type: string
                    example: イート / jon-YAKITORY feat.Ado - eat / cover by erina makina
                  upload_date:
                    type: string
                    example: 2022-07-11
                  video_id:
                    type: string
                    example: bX8-8928lcM
        '404':
          description: Video not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: "Video ID does not exist"

  /random_video:
    get:
      tags:
        - video
      summary: Get a singular random video
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Video'

  /discover_videos:
    get:
      tags:
        - video
      summary: Get multiple random videos
      parameters:
        - name: count
          in: query
          description: Number of random videos to get (default=1)
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Video'

  /search/results:
    get:
      tags:
        - video
      summary: Get paginated search results for some keyword
      parameters:
        - name: q
          in: query
          description: Keywords to search for
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: Page number for results (default=1)
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Video'

  /daily_featured_videos:
    get:
      tags:
        - video
      summary: Get today's daily features videos
      description: Either 1 or 2 video objects in an array depending on calculated hash
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Video'

  /recently_archived:
    get:
      tags:
        - video
      summary: Get the 6 most recently archived videos
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Video'

  /database/video_data/{video_id}:
    get:
      tags:
        - database
      summary: Get detailed information about the video if available
      description: If info.json generated by yt-dlp is available it will be directly delivered here, if not, fallback video data from the database is used instead
      parameters:
        - name: video_id
          in: path
          description: YouTube Video ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Video'

  /database/status:
    get:
      tags:
        - database
      summary: Get the status of the database
      responses:
        '200':
          description: successful operation.
          content:
            application/json:
              schema:
                properties:
                  OK:
                    type: string
                    example: "OK"
        '500':
          description: database is down
          content:
            application/json:
              schema:
                properties:
                  FAIL:
                    type: string
                    example: "500"

  /storage/status:
    get:
      tags:
        - database
      summary: Get the status of the database
      description: Gets the number of videos archived and space used in GB
      responses:
        '200':
          description: successful operation.
          content:
            application/json:
              schema:
                properties:
                  number_of_files:
                    type: integer
                    example: 3823
                  storage_size:
                    type: integer
                    example: 900


components:
  schemas:
    Channel:
      type: object
      required:
        - channel_name
      properties:
        channel_name:
          type: string
          example: Erina Ch. エリナ・マキナ 【Phase Connect】
    Video:
      type: object
      required:
        - channel_id
        - channel_name
        - description
        - title
        - upload_date
        - video_id
      properties:
        channel_id:
          type: string
          example: UCupmjRr7kPgzXKh-cPxxGbg
        channel_name:
          type: string
          example: Erina Ch. エリナ・マキナ 【Phase Connect】
        description:
          type: string
          example: The very long description portion
        title:
          type: string
          example: イート / jon-YAKITORY feat.Ado - eat / cover by erina makina
        upload_date:
          type: string
          example: 2022-07-11
        video_id:
          type: string
          example: bX8-8928lcM
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage