forked from Kaggle/kaggle-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
KaggleSwagger.yaml
1057 lines (1057 loc) · 29 KB
/
KaggleSwagger.yaml
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2018 Kaggle Inc
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
swagger: "2.0"
info:
description: API for kaggle.com
version: "1"
title: Kaggle API
termsOfService: https://www.kaggle.com/terms
contact:
name: Contact Kaggle
url: https://www.kaggle.com/contact
host: www.kaggle.com
basePath: /api/v1
schemes:
- https
securityDefinitions:
basicAuth:
type: basic
security:
- basicAuth: []
externalDocs:
description: Further Kaggle documentation
url: https://www.kaggle.com
tags:
- name: kaggle
parameters:
guidParam:
in: path
name: guid
required: true
type: string
minimum: 0
description: guid specifies location where submission should be uploaded
paths:
/competitions/list:
get:
tags:
- kaggle
summary: List competitions
operationId: CompetitionsList
produces:
- application/json
parameters:
- in: query
name: group
type: string
enum: [general, entered, inClass]
default: general
description: Filter competitions by a particular group
- in: query
name: category
type: string
enum: [all, featured, research, recruitment, gettingStarted, masters, playground]
default: all
description: Filter competitions by a particular category
- in: query
name: sortBy
type: string
enum: [grouped, prize, earliestDeadline, latestDeadline, numberOfTeams, recentlyCreated]
default: latestDeadline
description: Sort the results
- in: query
name: page
type: integer
default: 1
description: Page number
- in: query
name: search
type: string
default: ''
description: Search terms
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/competitions/submissions/list/{id}:
get:
tags:
- kaggle
summary: List competition submissions
operationId: CompetitionsSubmissionsList
produces:
- application/json
parameters:
- in: path
name: id
required: true
type: string
description: Competition name
- in: query
name: page
required: false
type: integer
default: 1
description: Page number
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/competitions/submissions/url/{contentLength}/{lastModifiedDateUtc}:
post:
tags:
- kaggle
summary: Generate competition submission URL
operationId: CompetitionsSubmissionsUrl
produces:
- application/json
consumes:
- multipart/form-data
parameters:
- in: formData
name: fileName
required: false
type: string
description: Competition submission file name
- in: path
name: contentLength
required: true
type: integer
description: Content length of file in bytes
- in: path
name: lastModifiedDateUtc
required: true
type: integer
description: Last modified date of file in milliseconds since epoch in UTC
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/competitions/submissions/upload/{guid}/{contentLength}/{lastModifiedDateUtc}:
post:
tags:
- kaggle
summary: Upload competition submission file
operationId: CompetitionsSubmissionsUpload
produces:
- application/json
consumes:
- multipart/form-data
parameters:
- in: formData
name: file
required: true
type: file
description: Competition submission file
- in: path
name: guid
required: true
type: string
description: Location where submission should be uploaded
- in: path
name: contentLength
required: true
type: integer
description: Content length of file in bytes
- in: path
name: lastModifiedDateUtc
required: true
type: integer
description: Last modified date of file in milliseconds since epoch in UTC
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/competitions/submissions/submit/{id}:
post:
tags:
- kaggle
summary: Submit to competition
operationId: CompetitionsSubmissionsSubmit
produces:
- application/json
consumes:
- multipart/form-data
parameters:
- in: formData
name: blobFileTokens
required: true
type: string
description: Token identifying location of uploaded submission file
- in: formData
name: submissionDescription
required: true
type: string
description: Description of competition submission
- in: path
name: id
required: true
type: string
description: Competition name
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/competitions/data/list/{id}:
get:
tags:
- kaggle
summary: List competition data files
operationId: CompetitionsDataListFiles
produces:
- application/json
parameters:
- in: path
name: id
required: true
type: string
description: Competition name
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/competitions/data/download/{id}/{fileName}:
get:
tags:
- kaggle
summary: Download competition data file
operationId: CompetitionsDataDownloadFile
parameters:
- in: path
name: id
required: true
type: string
description: Competition name
- in: path
name: fileName
required: true
type: string
description: Competition name
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/competitions/{id}/leaderboard/download:
get:
tags:
- kaggle
summary: Download competition leaderboard
operationId: CompetitionDownloadLeaderboard
parameters:
- in: path
name: id
required: true
type: string
description: Competition name
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/competitions/{id}/leaderboard/view:
get:
tags:
- kaggle
summary: VIew competition leaderboard
operationId: CompetitionViewLeaderboard
parameters:
- in: path
name: id
required: true
type: string
description: Competition name
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/datasets/list:
get:
tags:
- kaggle
summary: List datasets
operationId: DatasetsList
produces:
- application/json
parameters:
- in: query
name: group
type: string
enum: [public, my, myPrivate, upvoted, user]
default: public
description: Display datasets by a particular group
- in: query
name: sortBy
type: string
enum: [hottest, votes, updated, active]
default: hottest
description: Sort the results
- in: query
name: size
type: string
enum: [all, small, medium, large]
default: all
description: Display datasets of a specific size
- in: query
name: filetype
type: string
enum: [all, csv, sqlite, json, bigQuery]
default: all
description: Display datasets of a specific file type
- in: query
name: license
type: string
enum: [all, cc, gpl, odb, other]
default: all
description: Display datasets with a specific license
- in: query
name: tagids
type: string
description: A comma separated list of tags to filter by
- in: query
name: search
default: ''
type: string
description: Search terms
- in: query
name: user
type: string
description: Display datasets by a specific user or organization
- in: query
name: page
type: integer
default: 1
description: Page number
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/datasets/list/{ownerSlug}/{datasetSlug}:
get:
tags:
- kaggle
summary: List dataset files
operationId: DatasetsListFiles
produces:
- application/json
parameters:
- in: path
name: ownerSlug
required: true
type: string
description: Dataset owner
- in: path
name: datasetSlug
required: true
type: string
description: Dataset name
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/datasets/status/{ownerSlug}/{datasetSlug}:
get:
tags:
- kaggle
summary: Get dataset creation status
operationId: DatasetsStatus
produces:
- application/json
parameters:
- in: path
name: ownerSlug
required: true
type: string
description: Dataset owner
- in: path
name: datasetSlug
required: true
type: string
description: Dataset name
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/datasets/view/{ownerSlug}/{datasetSlug}:
get:
tags:
- kaggle
summary: Show details about a dataset
operationId: DatasetsView
produces:
- application/json
parameters:
- in: path
name: ownerSlug
required: true
type: string
description: Dataset owner
- in: path
name: datasetSlug
required: true
type: string
description: Dataset name
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/datasets/download/{ownerSlug}/{datasetSlug}:
get:
tags:
- kaggle
summary: Download dataset file
operationId: DatasetsDownload
produces:
- file
parameters:
- in: path
name: ownerSlug
required: true
type: string
description: Dataset owner
- in: path
name: datasetSlug
required: true
type: string
description: Dataset name
- in: query
name: datasetVersionNumber
required: false
type: string
description: Dataset version number
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/datasets/download/{ownerSlug}/{datasetSlug}/{fileName}:
get:
tags:
- kaggle
summary: Download dataset file
operationId: DatasetsDownloadFile
produces:
- file
parameters:
- in: path
name: ownerSlug
required: true
type: string
description: Dataset owner
- in: path
name: datasetSlug
required: true
type: string
description: Dataset name
- in: path
name: fileName
required: true
type: string
description: File name
- in: query
name: datasetVersionNumber
required: false
type: string
description: Dataset version number
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/datasets/upload/file/{contentLength}/{lastModifiedDateUtc}:
post:
tags:
- kaggle
summary: Get URL and token to start uploading a data file
operationId: DatasetsUploadFile
produces:
- application/json
consumes:
- multipart/form-data
parameters:
- in: formData
name: fileName
required: true
type: string
description: Dataset file name
- in: path
name: contentLength
required: true
type: integer
description: Content length of file in bytes
- in: path
name: lastModifiedDateUtc
required: true
type: integer
description: Last modified date of file in milliseconds since epoch in UTC
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/datasets/create/version/{id}:
post:
tags:
- kaggle
summary: Create a new dataset version by id
operationId: DatasetsCreateVersionById
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
required: true
type: integer
description: Dataset ID
- in: body
name: datasetNewVersionRequest
required: true
schema:
$ref: '#/definitions/DatasetNewVersionRequest'
description: Information for creating a new dataset version
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/datasets/create/version/{ownerSlug}/{datasetSlug}:
post:
tags:
- kaggle
summary: Create a new dataset version
operationId: DatasetsCreateVersion
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: ownerSlug
required: true
type: string
description: Dataset owner
- in: path
name: datasetSlug
required: true
type: string
description: Dataset name
- in: body
name: datasetNewVersionRequest
required: true
schema:
$ref: '#/definitions/DatasetNewVersionRequest'
description: Information for creating a new dataset version
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/datasets/create/new:
post:
tags:
- kaggle
summary: Create a new dataset
operationId: DatasetsCreateNew
produces:
- application/json
consumes:
- application/json
parameters:
- in: body
name: datasetNewRequest
required: true
schema:
$ref: '#/definitions/DatasetNewRequest'
description: Information for creating a new dataset
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/kernels/list:
get:
tags:
- kaggle
summary: List kernels
operationId: KernelsList
produces:
- application/json
parameters:
- in: query
name: page
type: integer
default: 1
description: Page number
- in: query
name: pageSize
type: integer
default: 20
description: Page size
- in: query
name: search
default: ''
type: string
description: Search terms
- in: query
name: group
type: string
enum: [everyone, profile, upvoted]
default: everyone
description: Display only your kernels
- in: query
name: user
type: string
description: Display kernels by a particular group
- in: query
name: language
type: string
enum: [all, python, r, sqlite, julia]
default: all
description: Display kernels in a specific language
- in: query
name: kernelType
type: string
enum: [all, script, notebook]
default: all
description: Display kernels of a specific type
- in: query
name: outputType
type: string
enum: [all, visualization, data]
default: all
description: Display kernels with a specific output type
- in: query
name: sortBy
type: string
enum: [hotness, commentCount, dateCreated, dateRun, scoreAscending, scoreDescending, viewCount, voteCount, relevance]
default: hotness
description: Sort the results. 'relevance' only works if there is a search query
- in: query
name: dataset
type: string
description: Display kernels using the specified dataset
- in: query
name: competition
type: string
description: Display kernels using the specified competition
- in: query
name: parentKernel
type: string
description: Display kernels that have forked the specified kernel
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/kernels/push:
post:
tags:
- kaggle
summary: Push a new kernel version. Can be used to create a new kernel and update an existing one.
operationId: KernelPush
produces:
- application/json
consumes:
- application/json
parameters:
- in: body
name: kernelPushRequest
required: true
schema:
$ref: '#/definitions/KernelPushRequest'
description: Information for pushing a new kernel version
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/kernels/pull:
get:
tags:
- kaggle
summary: Pull the latest code from a kernel
operationId: KernelPull
produces:
- application/json
parameters:
- in: query
name: userName
required: true
type: string
description: Kernel owner
- in: query
name: kernelSlug
required: true
type: string
description: Kernel name
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/kernels/output:
get:
tags:
- kaggle
summary: Download the latest output from a kernel
operationId: KernelOutput
produces:
- application/json
parameters:
- in: query
name: userName
required: true
type: string
description: Kernel owner
- in: query
name: kernelSlug
required: true
type: string
description: Kernel name
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
/kernels/status:
get:
tags:
- kaggle
summary: Get the status of the latest kernel version
operationId: KernelStatus
produces:
- application/json
parameters:
- in: query
name: userName
required: true
type: string
description: Kernel owner
- in: query
name: kernelSlug
required: true
type: string
description: Kernel name
responses:
200:
description: Result
schema:
$ref: '#/definitions/Result'
default:
description: Error
schema:
$ref: '#/definitions/Error'
definitions:
Result:
type: object
Error:
type: object
properties:
code:
type: integer
example: 404
description: The server error code returned
message:
type: string
example: NotFound
description: The error message generated by the server
DatasetColumn:
type: object
properties:
order:
type: number
description: The order that the column comes in, 0-based. (The first column is 0, second is 1, etc.)
name:
type: string
description: The column name
type:
type: string
description: The type of all of the fields in the column. Please see the data types on https://github.com/Kaggle/kaggle-api/wiki/Dataset-Metadata
originalType:
type: string
description: Used to store the original type of the column, which will be converted to Kaggle's types. For example, an `originalType` of `"integer"` would convert to a `type` of `"numeric"`
description:
type: string
description: The description of the column
DatasetUploadFile:
type: object
properties:
token:
type: string
description: A token referencing a specific file upload that can be used across requests
description:
type: string
description: The file description
columns:
type: array
description: A list of dataset column metadata
items:
$ref: '#/definitions/DatasetColumn'
DatasetNewVersionRequest:
type: object
required:
- versionNotes
- files
properties:
versionNotes:
type: string
description: The version notes for the new dataset version
subtitle:
type: string
description: The subtitle to set on the dataset
description:
type: string
description: The description to set on the dataset
files:
type: array
description: A list of files that should be associated with the dataset
items:
$ref: '#/definitions/DatasetUploadFile'
convertToCsv:
type: boolean
description: Whether or not a tabular dataset should be converted to csv
default: true
categoryIds:
type: array
description: A list of tag IDs to associated with the dataset
items:
type: string
deleteOldVersions:
type: boolean
description: Whether or not all previous versions of the dataset should be deleted upon creating the new version
default: false
DatasetNewRequest:
type: object
required:
- title
- licenseShortName
- files
properties:
title:
type: string
description: The title of the new dataset
slug:
type: string
description: The slug that the dataset should be created with
ownerSlug:
type: string
description: The owner's username
licenseName:
type: string
description: The license that should be associated with the dataset
default: unknown
enum:
- CC0-1.0
- CC-BY-SA-4.0
- GPL-2.0
- ODbL-1.0
- CC-BY-NC-SA-4.0
- unknown
- DbCL-1.0
- CC-BY-SA-3.0
- copyright-authors
- other
- reddit-api
- world-bank
subtitle:
type: string
description: The subtitle to be set on the dataset
description:
type: string
description: The description to be set on the dataset
default: ''
files:
type: array
description: A list of files that should be associated with the dataset
items:
$ref: '#/definitions/DatasetUploadFile'
isPrivate:
type: boolean
description: Whether or not the dataset should be private
default: true
convertToCsv:
type: boolean
description: Whether or not a tabular dataset should be converted to csv
default: true
categoryIds:
type: array
description: A list of tag IDs to associated with the dataset
items:
type: string
KernelPushRequest:
type: object
required:
- text