-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yml
18758 lines (18519 loc) · 607 KB
/
swagger.yml
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
openapi: 3.0.3
info:
title: 'CCDI Data Federation: Participating Nodes API'
description: |-
This is the concrete OpenAPI specification for the CCDI
Data Federation API—though this document contains all of the API calls
that CCDI Federation nodes must implement, it does not outline the
complete specification.
* Visit the [documentation homepage](https://cbiit.github.io/ccdi-federation-api)
to view the complete set of requirements to maintain and deploy a CCDI
Federation node.
* Additionally, you can view the Swagger specification in a more traditional
theme by visiting
[this link](https://editor.swagger.io/?url=https://cbiit.github.io/ccdi-federation-api/swagger.yml).
contact:
name: Childhood Cancer Data Initiative support email
email: NCIChildhoodCancerDataInitiative@mail.nih.gov
version: v1.1.0-rc.1
servers:
- url: https://ccdi.stjude.cloud/api/v1
description: St. Jude Children's Research Hospital CCDI API server
- url: https://ccdifederation.pedscommons.org/api/v1
description: Pediatric Cancer Data Commons CCDI API server
- url: https://ccdi.treehouse.gi.ucsc.edu/api/v1
description: UCSC Treehouse CCDI API server
- url: https://ccdi.kidsfirstdrc.org/api/v1
description: KidsFirst CCDI API server
paths:
/subject:
get:
tags:
- Subject
summary: Gets the subjects known by this server.
description: |-
Gets the subjects known by this server.
### Pagination
This endpoint is paginated. Users may override the default pagination
parameters by providing one or more of the pagination-related query
parameters below.
### Filtering
All harmonized (top-level) and unharmonized (nested under the
`metadata.unharmonized` key) metadata fields are filterable. To achieve
this, you can provide the field name as a [`String`]. Filtering follows the
following rules:
* For single-value metadata field, the subject is included in the results if
its value _exactly_ matches the query string. Matches are case-sensitive.
* For multiple-value metadata fields, the subject is included in the results
if any of its values for the field _exactly_ match the query string (a
logical OR [`||`]). Matches are case-sensitive.
* When the metadata field is `null` (in the case of singular or
multiple-valued metadata fields) or empty, the subject is not included.
* When multiple fields are provided as filters, a logical AND (`&&`) strings
together the predicates. In other words, all filters must match for a
subject to be returned. Note that this means that servers do not natively
support logical OR (`||`) across multiple fields: that must be done by
calling this endpoint with each of your desired queries and performing a
set union of those subjects out of band.
### Ordering
This endpoint has default ordering requirements—those details are documented
in the `responses::Subjects` schema.
operationId: subject_index
parameters:
- name: sex
in: query
description: Matches any subject where the `sex` field matches the string provided.
required: false
schema:
type: string
- name: race
in: query
description: |-
Matches any subject where any member of the `race` field matches the
string provided.
**Note:** a logical OR (`||`) is performed across the values when
determining whether the subject should be included in the results.
required: false
schema:
type: string
- name: ethnicity
in: query
description: |-
Matches any subject where the `ethnicity` field matches the string
provided.
required: false
schema:
type: string
- name: identifiers
in: query
description: |-
Matches any subject where any member of the `identifiers` field matches
the string provided.
**Note:** a logical OR (`||`) is performed across the values when
determining whether the subject should be included in the results.
required: false
schema:
type: string
- name: vital_status
in: query
description: |-
Matches any subject where the `vital_status` field matches the string
provided.
required: false
schema:
type: string
- name: age_at_vital_status
in: query
description: |-
Matches any subject where the `age_at_vital_status` field matches the
string provided.
required: false
schema:
type: string
- name: depositions
in: query
description: |-
Matches any subject where any member of the `depositions` fields match
the string provided.
**Note:** a logical OR (`||`) is performed across the values when
determining whether the subject should be included in the results.
required: false
schema:
type: string
- name: metadata.unharmonized.<field>
in: query
description: |-
All unharmonized fields should be filterable in the same manner as harmonized fields:
* Filtering on a singular field should include the `Subject` in the results if the query exactly matches the value of that field for the `Subject` (case-sensitive).
* Filtering on field with multiple values should include the `Subject` in the results if the query exactly matches any of the values of the field for that `Subject` (case-sensitive).
* Unlike harmonized fields, unharmonized fields must be prefixed with `metadata.unharmonized`.
**Note:** this query parameter is intended to be symbolic of any unharmonized field. Because of limitations within Swagger UI, it will show up as a query parameter that can be optionally be submitted as part of a request within Swagger UI. Please keep in mind that the literal query parameter `?metadata.unharmonized.<field>=value` is not supported, so attempting to use it within Swagger UI will not work!
required: false
schema:
type: string
- name: page
in: query
description: |-
The page to retrieve.
This is a 1-based index of a page within a page set. The value of `page`
**must** default to `1` when this parameter is not provided.
required: false
schema:
type: integer
minimum: 0
- name: per_page
in: query
description: |-
The number of results per page.
Each server can select its own default value for `per_page` when this
parameter is not provided. That said, the convention within the
community is to use `100` as a default value if any value is equally
reasonable.
required: false
schema:
type: integer
minimum: 0
responses:
'200':
description: Successful operation.
headers:
link:
schema:
type: string
description: "Links to URLs that may be of interest when paging through paginated responses. This header contains two or more links of interest. The format of the field is as follows: \n\n`Link: <URL>; rel=\"REL\"` \n### Relationships\n\nIn the format above, `URL` represents a valid URL for the link of interest and `REL` is one of four values: \n- `first` (_Required_). A link to the first page in the results (can be the same as `last` if there is only one page).\n- `last` (_Required_). A link to the first page in the results (can be the same as `first` if there is only one page).\n- `next` (_Optional_). A link to the next page (if it exists).\n- `prev` (_Optional_). A link to the previous page (if it exists).\n\n### Requirements\n\n- This header _must_ provide links for at least the `first` and `last` rels.\n - The `prev` and `next` links must exist only (a) when there are multiple pages in the result page set and (b) when the current page is not the first or last page, respectively.\n- This list of links is unordered.\n\n ### Notes\n\n- HTTP 1.1 and HTTP 2.0 dictate that response headers are case insensitive. Though not required, we recommend an all lowercase name of `link` for this response header."
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Subjects'
'404':
description: |-
Not found.
Servers that cannot provide line-level data should use this response rather than Forbidden (403), as there is no level of authorization that would allow one to access the information included in the API.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Errors'
example:
errors:
- kind: UnshareableData
entity: Subjects
reason: Our agreement with data providers prohibits us from sharing line-level data.
message: 'Unable to share data for subjects: our agreement with data providers prohibits us from sharing line-level data.'
'422':
description: Invalid query or path parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Errors'
example:
errors:
- kind: InvalidParameters
parameters:
- page
- per_page
reason: Unable to calculate offset.
message: 'Invalid value for parameters ''page'' and ''per_page'': unable to calculate offset.'
/subject/{organization}/{namespace}/{name}:
get:
tags:
- Subject
summary: Gets the subject matching the provided id (if the subject exists).
description: Gets the subject matching the provided id (if the subject exists).
operationId: subject_show
parameters:
- name: organization
in: path
description: The organization identifier of the namespace to which the subject belongs.
required: true
schema:
type: string
- name: namespace
in: path
description: The name of the namespace to which the subject belongs.
required: true
schema:
type: string
- name: name
in: path
description: The name portion of the subject identifier.
required: true
schema:
type: string
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Subject'
'404':
description: |-
Not found.
Servers that cannot provide line-level data should use this response rather than Forbidden (403), as there is no level of authorization that would allow one to access the information included in the API.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Errors'
example:
errors:
- kind: NotFound
entity: Subjects
message: Subjects not found.
/subject/by/{field}/count:
get:
tags:
- Subject
summary: Groups the subjects by the specified metadata field and returns counts.
description: Groups the subjects by the specified metadata field and returns counts.
operationId: subjects_by_count
parameters:
- name: field
in: path
description: The field to group by and count with.
required: true
schema:
type: string
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.by.count.subject.Results'
'422':
description: Unsupported field.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Errors'
example:
errors:
- kind: UnsupportedField
field: handedness
reason: This field is not present for subjects.
message: 'Field ''handedness'' is not supported: this field is not present for subjects.'
/subject/summary:
get:
tags:
- Subject
summary: Reports summary information for the subjects known by this server.
description: Reports summary information for the subjects known by this server.
operationId: subject_summary
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Summary'
/sample:
get:
tags:
- Sample
summary: Gets the samples known by this server.
description: |-
Gets the samples known by this server.
### Pagination
This endpoint is paginated. Users may override the default pagination
parameters by providing one or more of the pagination-related query
parameters below.
### Filtering
All harmonized (top-level) and unharmonized (nested under the
`metadata.unharmonized` key) metadata fields are filterable. To achieve
this, you can provide the field name as a [`String`]. Filtering follows the
following rules:
* For single-value metadata field, the sample is included in the results if
its value _exactly_ matches the query string. Matches are case-sensitive.
* For multiple-value metadata fields, the sample is included in the results
if any of its values for the field _exactly_ match the query string (a
logical OR [`||`]). Matches are case-sensitive.
* When the metadata field is `null` (in the case of singular or
multiple-valued metadata fields) or empty, the sample is not included.
* When multiple fields are provided as filters, a logical AND (`&&`) strings
together the predicates. In other words, all filters must match for a
sample to be returned. Note that this means that servers do not natively
support logical OR (`||`) across multiple fields: that must be done by
calling this endpoint with each of your desired queries and performing a
set union of those samples out of band.
### Ordering
This endpoint has default ordering requirements—those details are documented
in the `responses::Samples` schema.
operationId: sample_index
parameters:
- name: disease_phase
in: query
description: |-
Matches any sample where the `disease_phase` field matches the string
provided.
required: false
schema:
type: string
- name: anatomical_site
in: query
description: |-
Matches any sample where the `anatomical_site` field matches the string
provided.
**Note:** a logical OR (`||`) is performed across the values when
determining whether the subject should be included in the results.
required: false
schema:
type: string
- name: library_selection_method
in: query
description: |-
Matches any sample where the `library_selection_method` field matches the string
provided.
required: false
schema:
type: string
- name: library_strategy
in: query
description: |-
Matches any sample where the `library_strategy` field matches the string
provided.
required: false
schema:
type: string
- name: library_source_material
in: query
description: |-
Matches any sample where the `library_source_material` field matches the string
provided.
required: false
schema:
type: string
- name: preservation_method
in: query
description: |-
Matches any sample where the `preservation_method` field matches the string
provided.
required: false
schema:
type: string
- name: specimen_molecular_analyte_type
in: query
description: |-
Matches any sample where the `specimen_molecular_analyte_type` field matches the string
provided.
required: false
schema:
type: string
- name: tissue_type
in: query
description: |-
Matches any sample where the `tissue_type` field matches the string
provided.
required: false
schema:
type: string
- name: tumor_classification
in: query
description: |-
Matches any sample where the `tumor_classification` field matches the
string provided.
required: false
schema:
type: string
- name: age_at_diagnosis
in: query
description: |-
Matches any sample where the `age_at_diagnosis` field matches the string
provided.
required: false
schema:
type: string
- name: age_at_collection
in: query
description: |-
Matches any sample where the `age_at_collection` field matches the
string provided.
required: false
schema:
type: string
- name: tumor_tissue_morphology
in: query
description: |-
Matches any sample where the `tumor_tissue_morphology` field matches the
string provided.
required: false
schema:
type: string
- name: depositions
in: query
description: |-
Matches any sample where any member of the `depositions` fields match
the string provided.
**Note:** a logical OR (`||`) is performed across the values when
determining whether the sample should be included in the results.
required: false
schema:
type: string
- name: metadata.unharmonized.<field>
in: query
description: |-
All unharmonized fields should be filterable in the same manner as harmonized fields:
* Filtering on a singular field should include the `Sample` in the results if the query exactly matches the value of that field for the `Sample` (case-sensitive).
* Filtering on field with multiple values should include the `Sample` in the results if the query exactly matches any of the values of the field for that `Sample` (case-sensitive).
* Unlike harmonized fields, unharmonized fields must be prefixed with `metadata.unharmonized`.
**Note:** this query parameter is intended to be symbolic of any unharmonized field. Because of limitations within Swagger UI, it will show up as a query parameter that can be optionally be submitted as part of a request within Swagger UI. Please keep in mind that the literal query parameter `?metadata.unharmonized.<field>=value` is not supported, so attempting to use it within Swagger UI will not work!
required: false
schema:
type: string
- name: page
in: query
description: |-
The page to retrieve.
This is a 1-based index of a page within a page set. The value of `page`
**must** default to `1` when this parameter is not provided.
required: false
schema:
type: integer
minimum: 0
- name: per_page
in: query
description: |-
The number of results per page.
Each server can select its own default value for `per_page` when this
parameter is not provided. That said, the convention within the
community is to use `100` as a default value if any value is equally
reasonable.
required: false
schema:
type: integer
minimum: 0
responses:
'200':
description: Successful operation.
headers:
link:
schema:
type: string
description: "Links to URLs that may be of interest when paging through paginated responses. This header contains two or more links of interest. The format of the field is as follows: \n\n`Link: <URL>; rel=\"REL\"` \n### Relationships\n\nIn the format above, `URL` represents a valid URL for the link of interest and `REL` is one of four values: \n- `first` (_Required_). A link to the first page in the results (can be the same as `last` if there is only one page).\n- `last` (_Required_). A link to the first page in the results (can be the same as `first` if there is only one page).\n- `next` (_Optional_). A link to the next page (if it exists).\n- `prev` (_Optional_). A link to the previous page (if it exists).\n\n### Requirements\n\n- This header _must_ provide links for at least the `first` and `last` rels.\n - The `prev` and `next` links must exist only (a) when there are multiple pages in the result page set and (b) when the current page is not the first or last page, respectively.\n- This list of links is unordered.\n\n ### Notes\n\n- HTTP 1.1 and HTTP 2.0 dictate that response headers are case insensitive. Though not required, we recommend an all lowercase name of `link` for this response header."
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Samples'
'404':
description: |-
Not found.
Servers that cannot provide line-level data should use this response rather than Forbidden (403), as there is no level of authorization that would allow one to access the information included in the API.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Errors'
example:
errors:
- kind: UnshareableData
entity: Samples
reason: Our agreement with data providers prohibits us from sharing line-level data.
message: 'Unable to share data for samples: our agreement with data providers prohibits us from sharing line-level data.'
'422':
description: Invalid query or path parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Errors'
example:
errors:
- kind: InvalidParameters
parameters:
- page
- per_page
reason: Unable to calculate offset.
message: 'Invalid value for parameters ''page'' and ''per_page'': unable to calculate offset.'
/sample/{organization}/{namespace}/{name}:
get:
tags:
- Sample
summary: Gets the sample matching the provided name (if the sample exists).
description: Gets the sample matching the provided name (if the sample exists).
operationId: sample_show
parameters:
- name: organization
in: path
description: The organization identifier of the namespace to which the sample belongs.
required: true
schema:
type: string
- name: namespace
in: path
description: The name of the namespace to which the sample belongs.
required: true
schema:
type: string
- name: name
in: path
description: The name portion of the sample identifier.
required: true
schema:
type: string
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Sample'
'404':
description: |-
Not found.
Servers that cannot provide line-level data should use this response rather than Forbidden (403), as there is no level of authorization that would allow one to access the information included in the API.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Errors'
example:
errors:
- kind: NotFound
entity: Sample with namespace 'foo' and name 'bar'
message: Sample with namespace 'foo' and name 'bar' not found.
/sample/by/{field}/count:
get:
tags:
- Sample
summary: Groups the samples by the specified metadata field and returns counts.
description: Groups the samples by the specified metadata field and returns counts.
operationId: samples_by_count
parameters:
- name: field
in: path
description: The field to group by and count with.
required: true
schema:
type: string
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.by.count.sample.Results'
'422':
description: Unsupported field.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Errors'
example:
errors:
- kind: UnsupportedField
field: handedness
reason: This field is not present for samples.
message: 'Field ''handedness'' is not supported: this field is not present for samples.'
/sample/summary:
get:
tags:
- Sample
summary: Reports summary information for the samples known by this server.
description: Reports summary information for the samples known by this server.
operationId: sample_summary
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Summary'
/file:
get:
tags:
- File
summary: Gets the files known by this server.
description: |-
Gets the files known by this server.
### Pagination
This endpoint is paginated. Users may override the default pagination
parameters by providing one or more of the pagination-related query
parameters below.
### Filtering
All harmonized (top-level) and unharmonized (nested under the
`metadata.unharmonized` key) metadata fields are filterable. To achieve
this, you can provide the field name as a [`String`]. Filtering follows the
following rules:
* For single-value metadata field, the file is included in the results if
its value _exactly_ matches the query string. Matches are case-sensitive.
* For multiple-value metadata fields, the file is included in the results
if any of its values for the field _exactly_ match the query string (a
logical OR [`||`]). Matches are case-sensitive.
* When the metadata field is `null` (in the case of singular or
multiple-valued metadata fields) or empty, the file is not included.
* When multiple fields are provided as filters, a logical AND (`&&`) strings
together the predicates. In other words, all filters must match for a
file to be returned. Note that this means that servers do not natively
support logical OR (`||`) across multiple fields: that must be done by
calling this endpoint with each of your desired queries and performing a
set union of those files out of band.
### Ordering
This endpoint has default ordering requirements—those details are documented
in the `responses::Files` schema.
operationId: file_index
parameters:
- name: type
in: query
description: Matches any file where the `type` field matches the string provided.
required: false
schema:
type: string
- name: size
in: query
description: Matches any file where the `size` field matches the string provided.
required: false
schema:
type: string
- name: checksums
in: query
description: |-
Matches any file where the `checksums` field matches the string
provided.
**Note:** a logical OR (`||`) is performed across the values when
determining whether the file should be included in the results.
required: false
schema:
type: string
- name: description
in: query
description: |-
Matches any file where the `description` field matches the string
provided.
**Note:** a file is returned if the value provided is a substring of the
description.
required: false
schema:
type: string
- name: depositions
in: query
description: |-
Matches any file where any member of the `depositions` fields match
the string provided.
**Note:** a logical OR (`||`) is performed across the values when
determining whether the sample should be included in the results.
required: false
schema:
type: string
- name: metadata.unharmonized.<field>
in: query
description: |-
All unharmonized fields should be filterable in the same manner as harmonized fields:
* Filtering on a singular field should include the `File` in the results if the query exactly matches the value of that field for the `File` (case-sensitive).
* Filtering on field with multiple values should include the `File` in the results if the query exactly matches any of the values of the field for that `File` (case-sensitive).
* Unlike harmonized fields, unharmonized fields must be prefixed with `metadata.unharmonized`.
**Note:** this query parameter is intended to be symbolic of any unharmonized field. Because of limitations within Swagger UI, it will show up as a query parameter that can be optionally be submitted as part of a request within Swagger UI. Please keep in mind that the literal query parameter `?metadata.unharmonized.<field>=value` is not supported, so attempting to use it within Swagger UI will not work!
required: false
schema:
type: string
- name: page
in: query
description: |-
The page to retrieve.
This is a 1-based index of a page within a page set. The value of `page`
**must** default to `1` when this parameter is not provided.
required: false
schema:
type: integer
minimum: 0
- name: per_page
in: query
description: |-
The number of results per page.
Each server can select its own default value for `per_page` when this
parameter is not provided. That said, the convention within the
community is to use `100` as a default value if any value is equally
reasonable.
required: false
schema:
type: integer
minimum: 0
responses:
'200':
description: Successful operation.
headers:
link:
schema:
type: string
description: "Links to URLs that may be of interest when paging through paginated responses. This header contains two or more links of interest. The format of the field is as follows: \n\n`Link: <URL>; rel=\"REL\"` \n### Relationships\n\nIn the format above, `URL` represents a valid URL for the link of interest and `REL` is one of four values: \n- `first` (_Required_). A link to the first page in the results (can be the same as `last` if there is only one page).\n- `last` (_Required_). A link to the first page in the results (can be the same as `first` if there is only one page).\n- `next` (_Optional_). A link to the next page (if it exists).\n- `prev` (_Optional_). A link to the previous page (if it exists).\n\n### Requirements\n\n- This header _must_ provide links for at least the `first` and `last` rels.\n - The `prev` and `next` links must exist only (a) when there are multiple pages in the result page set and (b) when the current page is not the first or last page, respectively.\n- This list of links is unordered.\n\n ### Notes\n\n- HTTP 1.1 and HTTP 2.0 dictate that response headers are case insensitive. Though not required, we recommend an all lowercase name of `link` for this response header."
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Files'
'404':
description: |-
Not found.
Servers that cannot provide line-level data should use this response rather than Forbidden (403), as there is no level of authorization that would allow one to access the information included in the API.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Errors'
example:
errors:
- kind: UnshareableData
entity: Files
reason: Our agreement with data providers prohibits us from sharing file-level data.
message: 'Unable to share data for files: our agreement with data providers prohibits us from sharing file-level data.'
'422':
description: Invalid query or path parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Errors'
example:
errors:
- kind: InvalidParameters
parameters:
- page
- per_page
reason: Unable to calculate offset.
message: 'Invalid value for parameters ''page'' and ''per_page'': unable to calculate offset.'
/file/{organization}/{namespace}/{name}:
get:
tags:
- File
summary: Gets the file matching the provided name (if the file exists).
description: Gets the file matching the provided name (if the file exists).
operationId: file_show
parameters:
- name: organization
in: path
description: The organization identifier of the namespace to which the file belongs.
required: true
schema:
type: string
- name: namespace
in: path
description: The name of the namespace to which the file belongs.
required: true
schema:
type: string
- name: name
in: path
description: The name portion of the file identifier.
required: true
schema:
type: string
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.File'
'404':
description: |-
Not found.
Servers that cannot provide line-level data should use this response rather than Forbidden (403), as there is no level of authorization that would allow one to access the information included in the API.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Errors'
example:
errors:
- kind: NotFound
entity: File with namespace 'foo' and name 'bar'
message: File with namespace 'foo' and name 'bar' not found.
/file/by/{field}/count:
get:
tags:
- File
summary: Groups the files by the specified metadata field and returns counts.
description: Groups the files by the specified metadata field and returns counts.
operationId: files_by_count
parameters:
- name: field
in: path
description: The field to group by and count with.
required: true
schema:
type: string
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.by.count.file.Results'
'422':
description: Unsupported field.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Errors'
example:
errors:
- kind: UnsupportedField
field: handedness
reason: This field is not present for files.
message: 'Field ''handedness'' is not supported: this field is not present for files.'
/file/summary:
get:
tags:
- File
summary: Reports summary information for the files known by this server.
description: Reports summary information for the files known by this server.
operationId: file_summary
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Summary'
/metadata/fields/subject:
get:
tags:
- Metadata
summary: Gets the metadata fields for subjects that are supported by this server.
description: Gets the metadata fields for subjects that are supported by this server.
operationId: metadata_fields_subject
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.metadata.FieldDescriptions'
/metadata/fields/sample:
get:
tags:
- Metadata
summary: Gets the metadata fields for samples that are supported by this server.
description: Gets the metadata fields for samples that are supported by this server.
operationId: metadata_fields_sample
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.metadata.FieldDescriptions'
/metadata/fields/file:
get:
tags:
- Metadata
summary: Gets the metadata fields for files that are supported by this server.
description: Gets the metadata fields for files that are supported by this server.
operationId: metadata_fields_file
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.metadata.FieldDescriptions'
/namespace:
get:
tags:
- Namespace
summary: Gets the namespaces known by this server.
description: Gets the namespaces known by this server.
operationId: namespace_index
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Namespaces'
/namespace/{organization}/{namespace}:
get:
tags:
- Namespace
summary: Gets the namespace matching the provided name (if it exists).
description: Gets the namespace matching the provided name (if it exists).
operationId: namespace_show
parameters:
- name: organization
in: path
description: The organization of the namespace.
required: true
schema:
type: string
- name: namespace
in: path
description: The name of the namespace.
required: true
schema:
type: string
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Namespace'
'404':
description: Not found.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Errors'
example:
errors:
- kind: NotFound
entity: Namespaces
message: Namespaces not found.
/organization:
get:
tags:
- Organization
summary: Gets the organizations known by this server.
description: Gets the organizations known by this server.
operationId: organization_index
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Organizations'
/organization/{name}:
get:
tags:
- Organization
summary: Gets the organization matching the provided name (if it exists).
description: Gets the organization matching the provided name (if it exists).
operationId: organization_show
parameters:
- name: name
in: path
description: The name of the organization.
required: true