-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
1337 lines (1254 loc) · 48.5 KB
/
index.html
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
<!DOCTYPE html>
<html>
<head>
<title>smartAPI Specification</title>
<meta charset='utf-8'>
<script src='https://www.w3.org/Tools/respec/respec-w3c-common'
async class='remove'></script>
<script type="text/javascript" src="https://www.w3.org/2007/OWL/toggles.js"></script>
<script class='remove'>
var respecConfig = {
// specification status (e.g. WD, LCWD, WG-NOTE, etc.). If in doubt use ED.
specStatus: "UNOFFICIAL",
previousPublishDate: "2017-05-01",
previousMaturity: "LC",
// the specification's short name, as in http://www.w3.org/TR/short-name/
shortName: "smartAPI",
charterDisclosureURI : "https://www.w3.org/2004/01/pp-impl/64149/status",
// if your specification has a subtitle that goes below the main
// formal title, define it here
// subtitle : "an excellent document",
// if you wish the publication date to be other than the last modification, set this
// publishDate: "2009-08-06",
// if the specification's copyright date is a range of years, specify
// the start date here:
// copyrightStart: "2005"
// if there is a previously published draft, uncomment this and set its YYYY-MM-DD date
// and its maturity status
// previousPublishDate: "1977-03-15",
// previousMaturity: "WD",
// if there a publicly available Editor's Draft, this is the link
// edDraftURI: "http://berjon.com/",
// if this is a LCWD, uncomment and set the end of its review period
// lcEnd: "2009-08-05",
// editors, add as many as you like
// only "name" is required
editors:
[ {
name : "Michel Dumontier",
url : "mailto:[email protected]",
company : "Stanford University, USA",
companyURL : "http://dumontierlab.stanford.edu"
}, {
name : "Chunlei Wu",
url : "mailto:[email protected]",
company : "Scripps Research Institute, USA",
companyURL : "http://sulab.org/the-team/chunlei-wu/"
},
{
name : "Amrapali Zaveri",
url : "mailto:[email protected]",
company : "Stanford University, USA",
companyURL : "http://dumontierlab.stanford.edu"
},
{
name : "Kathleen Jagodnik",
url : "mailto:[email protected]",
company : "Icahn School of Medicine at Mount Sinai, USA",
companyURL : "http://labs.icahn.mssm.edu/maayanlab/"
},
{
name : "Ruben Verborgh",
url : "mailto:[email protected] ",
company : "Ghent University, Belgium",
companyURL : "https://ruben.verborgh.org/"
},
{
name : "Raymond Terryn",
url : "mailto:[email protected]",
company : "University of Miami, USA",
companyURL : "http://ccs.miami.edu/team_member/ray-terryn"
},
{
name : "Paul Avillach",
url : "mailto:[email protected]",
company : "Harvard Medical School, USA",
companyURL : "http://avillach-lab.hms.harvard.edu"
},
{
name : "Gabor Korodi",
url : "mailto:[email protected]",
company : "Harvard Medical School, USA",
companyURL : "http://avillach-lab.hms.harvard.edu"
}
],
// name of the WG
wg: "smartAPI",
// URI of the public WG page
wgURI: "https://amrapalijz.github.io/smartapi/",
// name (without the @w3c.org) of the public mailing to which comments are due
wgPublicList: "spec-writers-anonymous",
// URI of the patent status for this WG, for Rec-track documents
// !!!! IMPORTANT !!!!
// This is important for Rec-track documents, do not copy a patent URI from a random
// document unless you know what you're doing. If in doubt ask your friendly neighbourhood
// Team Contact.
wgPatentURI: "",
// !!!! IMPORTANT !!!! MAKE THE ABOVE BLINK IN YOUR HEAD
maxTocLevel : 2,
localBiblio : {
"Verborgh2016" : {
title : "A Web API ecosystem through feature-based reuse",
authors : ["Ruben Verborgh", "Michel Dumontier"],
date: "2016",
href : "https://arxiv.org/abs/1609.07108"
},
"Wilkinson2016" : {
title : "The FAIR Guiding Principles for scientific data management and stewardship",
authors : [ "Mark D. Wilkinson", "Michel Dumontier", "IJsbrand Jan Aalbersberg", "Gabrielle Appleton", "Myles Axton", "Arie Baak", "Niklas Blomberg", "Jan-Willem Boiten", "Luiz Bonino da Silva Santos", "Philip E. Bourne", "Jildau Bouwman", "Anthony J. Brookes", "Tim Clark", "Mercè Crosas", "Ingrid Dillo", "Olivier Dumon", "Scott Edmunds", "Chris T. Evelo", "Richard Finkers", "Alejandra Gonzalez-Beltran", "Alasdair J.G. Gray", "Paul Groth", "Carole Goble", "Jeffrey S. Grethe", "Jaap Heringa", "Peter A.C ’t Hoen", "Rob Hooft", "Tobias Kuhn", "Ruben Kok", "Joost Kok", "Scott J. Lusher", "Maryann E. Martone", "Albert Mons", "Abel L. Packer", "Bengt Persson", "Philippe Rocca-Serra", "Marco Roos", "Rene van Schaik", "Susanna-Assunta Sansone", "Erik Schultes", "Thierry Sengstag", "Ted Slater", "George Strawn", "Morris A. Swertz", "Mark Thompson", "Johan van der Lei", "Erik van Mulligen", "Jan Velterop", "Andra Waagmeester", "Peter Wittenburg", "Katherine Wolstencroft", "Jun Zhao", "Barend Mons" ],
date : "2016",
status : "Scientific Data 3",
href : "http://www.nature.com/articles/sdata201618"
}
}
};
</script>
<style type="text/css">
table {
border-collapse: collapse;
}
td, th {
border: 1px solid black;
padding: 1em;
}
table#namespaces td {
font-family: monospace;
}
table.definition {
width: 100%;
}
table.definition td.prop {
width: 10em;
}
pre {
padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;
}
pre red {
color: red;
}
</style>
</head>
<body>
<section id='abstract'>
<p>
This document presents a set of 54 metadata elements (organized into five categories) to usefully describe Web-based Application Programming Interfaces (APIs). These elements were developed by the Big Data to Knowledge (BD2K) API Interoperability Working Group, which conducted a survey of API metadata used in the real world. This group developed the smartAPI Specification as an extension of existing repositories such as Programmable Web, Biocatalogue, and available standards including Open API, schema.org, etc. The aim of the BD2K API Interoperability Working Group is to develop a strategy for maximizing interoperability and reuse of Web-based APIs. This specification aims to serve as a standard for API development that will facilitate the efficient communication among APIs and reduce development costs. The smartAPI Specification includes 21 metadata elements beyond those included in the Open API Initiative. The metadata elements are grouped into categories related to APIs, service providers, API operations, operation parameters, and operation responses. For each category, the metadata elements that are mandatory, recommended, or optional are described and illustrated by examples. The widespread adoption of the smartAPI Specification by the community promises to improve the efficiency and lower the costs of API development, promoting cross-API compatibility and resolving current challenges in API usage.
</p>
</section>
<section id='sotd'>
<p>
You need to have a custom SotD paragraph. Maybe give a succinct description of your spec's status.
</p>
</section>
<section>
<h1>Purpose of the smartAPI Specification</h1>
<p>The purpose of the smartAPI Specification is to establish a set of standards for the description of metadata elements and values for the description of Application Programming Interfaces (APIs). This document was produced by the Big Data To Knowledge (BD2K) API Interoperability Working Group, one of the NIH Commons Framework Pilot Working Groups. The BD2K API Interoperability Working Group first conducted a survey of API metadata found in existing repositories and guidelines (see <a href="https://amrapalijz.github.io/smartapi/#survey-of-api-metadata-in-the-wild">Section 2</a>), and subsequently developed the smartAPI Specification as an extension of the Open API Initiative. The <a href="https://www.openapis.org/">Open API Initiative</a> aims to create, develop, and promote an API description format based on the <a href="http://swagger.io/specification/">Swagger Specification</a>.</p>
<p>The smartAPI Specification is intended to be a ‘living’ document that will continue to be revised and improved via the input of API development community members.</p>
</section>
<section>
<h1>Survey of API Metadata in the Wild</h1>
<p>This standard is the result of a survey by the BD2K API Interoperability Working Group of existing metadata repositories and specifications that describe APIs. The following eight resources were surveyed:</p>
Repositories:
<ul>
<li><a href="http://biocatalogue.org" target="_blank">Biocatalogue</a>, a registry of biological web services with 1,184 services.</li>
<li><a href="http://www.programmableweb.com/apis/directory" target="_blank">Programmable Web</a>, a directory of internet-based APIs with over 15,000 API descriptions.</li>
<li><a href="https://bio.tools/" target="_blank">Tools and Data Services Registry</a>, a registry with information about analytical tools and data services for bioinformatics with 2,331 entries.</li>
</ul>
Specifications:
<ul>
<li><a href="http://www.softwarediscoveryindex.org/" target="_blank">Minimal Information About a Software</a>, a key set of minimal fields can that provide maximum value when describing a software.</li>
<li><a href="http://smart-api.info/website/docs/specification/" target="_blank">smartAPI specification</a>, a specification that describes a semantically annotated web service that facilitates discovery and reuse of web-based API.</li>
<li><a href="https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md" target="_blank">openAPI Initiative</a>, created by a consortium of forward-looking industry experts who recognize the immense value of standardizing on how REST APIs are described.</li>
<li><a href="https://rawgit.com/wilkinsonlab/SADI-Specification/master/SADI-W3C-Member-Submission.html#service-metadata" target="_blank">Semantic Automated Discovery and Integration</a>, a set of design patterns defining the behavior of data retrieval and/or analysis resources that must interoperate on the Semantic Web.</li>
<li><a href="https://schema.org/APIReference">schema.org API Reference</a>, a reference document for APIs as described by schema.org.
</ul>
<p>The smartAPI Specification includes 21 metadata elements beyond those included in the Open API Initiative. Examples of the 21 elements are the category to which the API belongs; metadata format and access mode at the API metadata level; the parameter type and parameter value type at the operation parameter level; and the conformance to a specified response profile at the operation response level.</p>
<p>We subsequently aggregated all the metadata elements from the eight resources to produce a common list of 54 API metadata elements. We subsequently divided these elements into five categories:</p>
<ul>
<li><a href="#apimd">API Metadata</a>: 20 elements</li>
<li><a href="#spmd">Service Provider Metadata</a>: 6 elements</li>
<li><a href="#aomd">API Operation Metadata</a>: 10 elements</li>
<li><a href="#opmd">Operation Parameter Metadata</a>: 12 elements</li>
<li><a href="#ormd">Operation Response Metadata</a>: 6 elements</li>
</ul>
<p>Next, we discussed each of the metadata field amongst the working group members to re-evaluate its applicability and relevance and further classified them into whether it MUST, SHOULD, or MAY be included in the API description. The cardinality and datatype of metadata field were further specified along with a description and example. The results of the survey are available <a href="https://goo.gl/wKR51W" target="_blank">here</a>. The key words "MUST", "SHOULD", and "MAY" in this document are to be interpreted as described in <a href="http://www.ietf.org/rfc/rfc2119.txt" target="_blank">RFC 2119</a>.</p>
</section>
<section>
<h2>Audience</h2>
<p>
The target audience includes software developers, data scientists and informatics researchers, publishers of resource descriptions, and funding agencies.
</p>
</section>
<section name="apimd">
<h2>API Metadata Elements</h2>
<p>Note: Asterix (*) against the metadata element indicates that the property is not in the openAPI specification.</p>
<script type="text/javascript"> if (window.showTocToggle) { var tocShowText = "show"; var tocHideText = "hide"; showTocToggle(); } </script>
<div class="buttonpanel">
<form action="#"><p>
<input name="show-sd" onclick="set_display_by_class('div','image','none'); set_display_by_id('hide-sd',''); set_display_by_id('show-sd','none');" type="button" value="Hide Diagrams" />
<input name="hide-sd" onclick="set_display_by_class('div','image',''); set_display_by_id('hide-sd','none'); set_display_by_id('show-sd','');" style="display: none" type="button" value="Show Diagrams" />
<input name="hide-examples" onclick="set_display_by_class('div','example','none'); set_display_by_id('hide-examples','none'); set_display_by_id('show-examples','');" type="button" value="Hide Examples" />
<input name="show-examples" onclick="set_display_by_class('div','example',''); set_display_by_id('hide-examples',''); set_display_by_id('show-examples','none');" style="display: none" type="button" value="Show Examples" />
</p>
</form>
</div>
<p>
<section name="name">
<h3>Name</h3>
<p>A human readable label for the API.</p>
<ul>
<li>Cardinality: 1..1</li>
<li>Datatype: string</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>info.title</font></p>
<div class="example">
<p>
<pre>
"name": "MyGene.info API"
</pre>
<div class="image">
<p><img alt="Must" border="0" height="60" src="must.jpg" width="60" /><br /></p>
</div>
</div>
</section>
<section name="accessPoint">
<h3>Access Point</h3>
<p>The base URI for interacting with the API.</p>
<ul>
<li>Cardinality: 1..1</li>
<li>Datatype: URI</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>basePath</font></p>
<div class="example">
<p>
<pre>
"access point": "http://mygene.info/"
</pre>
<div class="image">
<p><img alt="Must" border="0" height="60" src="must.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="desc">
<h3>Description</h3>
<p>A human readable description of the service functionality.</p>
<ul>
<li>Cardinality: 0..1</li>
<li>Datatype: string</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>info.description</font></p>
<div class="example">
<p>
<pre>
"description": "Documentation of the MyGene.info Gene Query web services. Learn more about [MyGene.info](http://mygene.info/)"
</pre>
<div class="image">
<p><img alt="Should" border="0" height="60" src="should.jpg" width="80" /><br/></p>
</div>
</div>
</section>
<section name="responseMimeType">
<h3>Response Mime-Type</h3>
<p>A list of media types the APIs can produce. This is global to all APIs but can be overridden on specific API calls.</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: string</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>produces</font></p>
<div class="example">
<p>
<pre>
"produces": "application/json"
</pre>
<div class="image">
<p><img alt="Should" border="0" height="60" src="should.jpg" width="80" /><br/></p>
</div>
</div>
</section>
<section name="externalDocs">
<h3>External Docs</h3>
<p>Documentation page URL for the API.</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: URI</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>externalDocs</font></p>
<div class="example">
<p>
<pre>
"documentation": "http://docs.mygene.info/en/v3/"
</pre>
<div class="image">
<p><img alt="Should" border="0" height="60" src="should.jpg" width="80" /><br/></p>
</div>
</div>
</section>
<section name="version">
<h3>Version</h3>
<p>The version of the API.</p>
<ul>
<li>Cardinality: 1..1</li>
<li>Datatype: string</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>info.version</font></p>
<div class="example">
<p>
<pre>
"version": "2.0.0"
</pre>
<div class="image">
<p><img alt="Should" border="0" height="60" src="should.jpg" width="80" /><br/></p>
</div>
</div>
</section>
<section name="termsOfService">
<h3>Terms of Service</h3>
<p>A document that describes the terms of use for the API.</p>
<ul>
<li>Cardinality: 0..1</li>
<li>Datatype: string</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>info.termsOfService</font></p>
<div class="example">
<p>
<pre>
"terms of service": "http://mygene.info/terms/"
</pre>
<div class="image">
<p><img alt="Should" border="0" height="60" src="should.jpg" width="80" /><br/></p>
</div>
</div>
</section>
<section name="sslSupport">
<h3>SSL Support*</h3>
<p>Indication of whether SSL Support is present or absent.</p>
<ul>
<li>Cardinality: 0..1</li>
<li>Datatype: boolean</li>
</ul>
<div class="example">
<p>
<pre>
"ssl support": "yes"
</pre>
<div class="image">
<p><img alt="Should" border="0" height="60" src="should.jpg" width="80" /><br/></p>
</div>
</div>
</section>
<section name="authenticationMode">
<h3>Authentication Mode</h3>
<p>Lists the required security schemes to execute this operation. The object can have multiple security schemes declared in it which are all required.</p>
<ul>
<li>Cardinality: 0..1</li>
<li>Datatype: URI</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>securityDefinitions.basicAuth</font></p>
<div class="example">
<p>
<pre>
"authentication mode": "none"
</pre>
<div class="image">
<p><img alt="Should" border="0" height="60" src="should.jpg" width="80" /><br/></p>
</div>
</div>
</section>
<section name="category">
<h3>Category*</h3>
<p>Primary category that the API belongs to.</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: string</li>
</ul>
<div class="example">
<p>
<pre>
"category": "genetics"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="website">
<h3>Website</h3>
<p>A web page that describes the API.</p>
<ul>
<li>Cardinality: 0..1</li>
<li>Datatype: URI</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>host</font></p>
<div class="example">
<p>
<pre>
"website": "http://mygene.info/"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="publications">
<h3>Publications*</h3>
<p>Publication ID/URL</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: URI</li>
</ul>
<div class="example">
<p>
<pre>
"publications": "Wu C, MacLeod I, Su AI (2013) BioGPS and MyGene.info: organizing online, gene-centric information. Nucl. Acids Res. 41(D1): D561-D565."
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="apiAccessRestrictions">
<h3>API Access Restrictions*</h3>
<p>Indicate whether there are restrictions to using the API</p>
<ul>
<li>Cardinality: 0..1</li>
<li>Datatype: string</li>
</ul>
<div class="example">
<p>
<pre>
"api access restrictions": "free"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="socialMediaLinks">
<h3>Social Media Links*</h3>
<p>Links to social media presence such as Twitter URL, facebook, LinkedIn etc.</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: URI</li>
</ul>
<div class="example">
<p>
<pre>
"social media links": "Twitter: @mygeneinfo"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="accessPointMirrors">
<h3>Access Point Mirrors*</h3>
<p>URL of the mirror that the API is available at.</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: URI</li>
</ul>
<div class="example">
<p>
<pre>
"access point mirrors": "http://mygene.info/v3/api/"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="apiMetadataFormat">
<h3>API Metadata Format*</h3>
<p>Service specification format.</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: string</li>
</ul>
<div class="example">
<p>
<pre>
"api metadata format": "openAPI"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="apiAccessMode">
<h3>API Access Mode*</h3>
<p>The protocols used to access the API</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: string</li>
</ul>
<div class="example">
<p>
<pre>
"api access mode": "REST"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="apiLocation">
<h3>API Location*</h3>
<p>Location, city and country of the API.</p>
<ul>
<li>Cardinality: 0..1</li>
<li>Datatype: URI</li>
</ul>
<div class="example">
<p>
<pre>
"api location": "USA"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="apiImplementationLanguage">
<h3>API Implementation Language*</h3>
<p>Language the API was written in.</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: string</li>
</ul>
<div class="example">
<p>
<pre>
"api implementation language": "python"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="apiMaturity">
<h3>API Maturity*</h3>
<p>Maturity of the API.</p>
<ul>
<li>Cardinality: 0..1</li>
<li>Datatype: enum</li>
</ul>
<div class="example">
<p>
<pre>
"api maturity": "stable"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
</section>
<section name="spmd">
<h2>Service Provider Metadata</h2>
<p>
<section name="responsibleOrganization">
<h3>Responsible Organization</h3>
<p>The identifying name of the contact person/organization.</p>
<ul>
<li>Cardinality: 1..1</li>
<li>Datatype: string</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>contact.url</font></p>
<div class="example">
<p>
<pre>
"responsible organization": "The Scripps Research Institute"
</pre>
<div class="image">
<p><img alt="Must" border="0" height="60" src="must.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="responsibleDeveloper">
<h3>Responsible Developer</h3>
<p>Name of the developer (User ORCID ID/Name)</p>
<ul>
<li>Cardinality: 1..1</li>
<li>Datatype: URI</li>
</ul>
<div class="example">
<p>
<pre>
"responsible developer": "http://orcid.org/0000-0002-2629-6124"
</pre>
<div class="image">
<p><img alt="Must" border="0" height="60" src="must.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="contactEmail">
<h3>Contact Email</h3>
<p>An e-mail address where the provider of the service may be contacted. MUST be in the format of an email address.</p>
<ul>
<li>Cardinality: 1..1</li>
<li>Datatype: email</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>contact.email</font></p>
<div class="example">
<p>
<pre>
"contact email": "[email protected]"
</pre>
<div class="image">
<p><img alt="Must" border="0" height="60" src="must.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="contributor">
<h3>Contributor*</h3>
<p>Contributor person or institute</p>
<ul>
<li>Cardinality: 0..1</li>
<li>Datatype: string</li>
</ul>
<div class="example">
<p>
<pre>
"contributor": "Andrew Su"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="funding">
<h3>Funding*</h3>
<p>Source of funding.</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: string</li>
</ul>
<div class="example">
<p>
<pre>
"funding": "NIH"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="developerForum">
<h3>Developer Forum*</h3>
<p>Forum or Mailing list.</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: URI</li>
</ul>
<div class="example">
<p>
<pre>
"developer forum": "https://bitbucket.org/sulab/mygene.hub"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
</section>
<section name="aomd">
<h2>API Operation Metadata</h2>
<p>
<section name="operationTitle">
<h3>Operation Title*</h3>
<p>Title of the operation. A unique identifier of the operation.</p>
<ul>
<li>Cardinality: 1..1</li>
<li>Datatype: string</li>
</ul>
<div class="example">
<p>
<pre>
"operation title": "q"
</pre>
<div class="image">
<p><img alt="Must" border="0" height="60" src="must.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="operationDescription">
<h3>Operation Description</h3>
<p>Description of the operation.</p>
<ul>
<li>Cardinality: 1..1</li>
<li>Datatype: string</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>operation.description</font></p>
<div class="example">
<p>
<pre>
"description": "Query string. Examples \"CDK2\", \"NM_052827\", \"204639_at\". The detailed query syntax can be found at http://docs.mygene.info/en/latest/doc/query_service.html"
</pre>
<div class="image">
<p><img alt="Must" border="0" height="60" src="must.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="consumes">
<h3>Consumes</h3>
<p>A list of MIME types the operation can consume.</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: string</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>consumes</font></p>
<div class="example">
<p>
<pre>
"consumes": "application/json"
</pre>
<div class="image">
<p><img alt="Should" border="0" height="60" src="should.jpg" width="80" /><br/></p>
</div>
</div>
</section>
<section name="httpMethod">
<h3>http Method</h3>
<p>The base path on which the API is served, which is relative to the host. Or a relative path to an individual endpoint. The field name MUST begin with a slash. The path is appended to the basePath in order to construct the full URL. The object describes the operations available on a single path. The different operations are"get, put, post, delete, options head, patch".</p>
<ul>
<li>Cardinality: 0..1</li>
<li>Datatype: string</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>pathItem</font></p>
<div class="example">
<p>
<pre>
"http method": "get"
</pre>
<div class="image">
<p><img alt="Should" border="0" height="60" src="should.jpg" width="80" /><br/></p>
</div>
</div>
</section>
<section name="operationAuthenticationMode">
<h3>Authentication Mode</h3>
<p>Lists the required security schemes to execute this operation. The object can have multiple security schemes declared in it which are all required.</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: string</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>securityDefinitions.basicAuth</font></p>
<div class="example">
<p>
<pre>
"authentication mode": "none"
</pre>
<div class="image">
<p><img alt="Should" border="0" height="60" src="should.jpg" width="80" /><br/></p>
</div>
</div>
</section>
<section name="transferProtocol">
<h3>Transfer Protocol</h3>
<p>The transfer protocol of the API. Values MUST be from the list: "http", "https", "ws", "wss". This optional value will override the top-level schemes if present.</p>
<ul>
<li>Cardinality: 0..1</li>
<li>Datatype: string0</li>
</ul>
<div class="example">
<p>OpenAPI element: <font size="3" face="verdana" color=green>schemes</font></p>
<p>
<pre>
"transfer protocol": "http"
</pre>
<div class="image">
<p><img alt="Should" border="0" height="60" src="should.jpg" width="80" /><br/></p>
</div>
</div>
</section>
<section name="keywords">
<h3>Keywords</h3>
<p>Keywords describing the operation.</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: string</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>operation.tags</font></p>
<div class="example">
<p>
<pre>
"keywords": [ "query" ]
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="pathTemplate">
<h3>Path Template*</h3>
<p>The path for the operation.</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: string</li>
</ul>
<div class="example">
<p>
<pre>
"path template": "/query"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="operationID">
<h3>Operation ID</h3>
<p>An identifier/URI for the operation.</p>
<ul>
<li>Cardinality: 0..1</li>
<li>Datatype: string</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>operation.operationID</font></p>
<div class="example">
<p>
<pre>
"operation ID": "queryGene"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="operationDocumentation">
<h3>Operation Documentation</h3>
<p>Documentation of the particular operation.</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: URI</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>operation.externalDocs</font></p>
<div class="example">
<p>
<pre>
"operation documentation": " http://docs.mygene.info"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="accessRestrictions">
<h3>Access Restrictions*</h3>
<p>Access restrictions to invoke the operation.</p>
<ul>
<li>Cardinality: 0..1</li>
<li>Datatype: string</li>
</ul>
<div class="example">
<p>
<pre>
"access restrictions": "free"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="collection">
<h3>Collection*</h3>
<p>Names of collections of which the resource is a part e.g. a suite, library etc.</p>
<ul>
<li>Cardinality: 0..n</li>
<li>Datatype: string</li>
</ul>
<div class="example">
<p>
<pre>
"collection": "Gene Annotation"
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="may.jpg" width="60" /><br/></p>
</div>
</div>
</section>
</section>
<section name="opmd">
<h2>Operation Parameter Metadata</h2>
<p>
<section name="operationParameterName">
<h3>Operation Parameter Name</h3>
<p>Name of the operation parameter.</p>
<ul>
<li>Cardinality: 1..1</li>
<li>Datatype: string</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>bodyParameter.patternProperties.name</font></p>
<div class="example">
<p>
<pre>
"operation parameter name": "q"
</pre>
<div class="image">
<p><img alt="Must" border="0" height="60" src="must.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="operationParameterDescription">
<h3>Operation Parameter Description</h3>
<p>Description of operation parameter.</p>
<p>OpenAPI element: <font size="3" face="verdana" color=green>bodyParameter.patternProperties.description</font></p>
<div class="example">
<ul>
<li>Cardinality: 1..1</li>
<li>Datatype: string</li>
</ul>
<p>
<pre>
"description": "multiple query terms seperated by comma (also support \"+\" or white space), but no wildcard, e.g., \"q=1017,1018\" or \"q=CDK2+BTK\""
</pre>
<div class="image">
<p><img alt="May" border="0" height="60" src="must.jpg" width="60" /><br/></p>
</div>
</div>
</section>
<section name="location">
<h3>Location</h3>
<p>Determines the location of the parameter.</p>
<ul>
<li>Cardinality: 1..1</li>
<li>Datatype: string</li>
</ul>
<p>OpenAPI element: <font size="3" face="verdana" color=green>bodyParameter.patternProperties.in</font></p>
<div class="example">
<p>
<pre>
"location": "query"
</pre>
<div class="image">
<p><img alt="Must" border="0" height="60" src="must.jpg" width="60" /><br/></p>
</div>