-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathopenapi.json
1359 lines (1359 loc) · 67.4 KB
/
openapi.json
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" : {
"version" : "2.8",
"title" : "BibleGet",
"description" : "Get Bible quotes from different Bible versions either requesting by reference (book - chapter - verse) or searching by keyword",
"license" : {
"name" : "Apache 2.0",
"url" : "http://www.apache.org/licenses/LICENSE-2.0"
},
"termsOfService" : "https://www.bibleget.io/BibleGetIOTermsofService.html",
"contact" : {
"name" : "John D'Orazio",
"url" : "https://www.bibleget.io",
"email" : "admin@bibleget.io"
}
},
"servers" : [ {
"url" : "https://query.bibleget.io"
} ],
"paths" : {
"/index.php" : {
"get" : {
"summary" : "Retrieve Bible quotes by reference (book - chapter - verse)",
"description" : "The API endpoint from which one can retrieve Bible quotes by reference (book - chapter - verse)",
"operationId" : "getVersesByGET",
"tags" : [ "MainAPI" ],
"parameters" : [ {
"$ref" : "#/components/parameters/query"
}, {
"$ref" : "#/components/parameters/version"
}, {
"$ref" : "#/components/parameters/return"
}, {
"$ref" : "#/components/parameters/appid"
}, {
"$ref" : "#/components/parameters/pluginversion"
}, {
"$ref" : "#/components/parameters/domain"
} ],
"responses" : {
"200" : {
"description" : "Structured data containing the Bible verses requested and all associated information",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BibleQuoteJSON"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/BibleQuoteXML"
}
},
"text/html" : {
"schema" : {
"$ref" : "#/components/schemas/BibleQuoteJSON"
}
}
}
}
}
},
"post" : {
"summary" : "Retrieve Bible quotes by reference (book - chapter - verse)",
"description" : "The API endpoint from which one can retrieve Bible quotes by reference (book - chapter - verse)",
"operationId" : "getVersesByPOST",
"tags" : [ "MainAPI" ],
"requestBody" : {
"content" : {
"application/x-www-form-urlencoded" : {
"schema" : {
"$ref" : "#/components/schemas/BibleQuotePOST"
},
"encoding" : {
"version" : {
"style" : "form",
"explode" : false
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Structured data containing the Bible verses requested and all associated information",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BibleQuoteJSON"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/BibleQuoteXML"
}
},
"text/html" : {
"schema" : {
"$ref" : "#/components/schemas/BibleQuoteJSON"
}
}
}
}
}
}
},
"/metadata.php" : {
"get" : {
"summary" : "Retrieve metadata about Bible versions that are available and their relative book/chapter/verse indexes",
"description" : "The API endpoint for querying metadata such as Bible versions that are available and their relative book/chapter/verse indexes. **N.B. Applications or plugins should CACHE the information returned by the METADATA endpoint. This data does not change often, there is no need to request it for every Bible quote requested from the main API endpoint. It can be a good idea to refresh this information about, let's say once a month, or create a user interface with a button that will allow the end user to refresh the information from the server if they think the cached information might be old.**",
"operationId" : "getMetadataByGET",
"tags" : [ "MetadataAPI" ],
"parameters" : [ {
"name" : "query",
"in" : "query",
"description" : "Specifies the subset of metadata to retrieve. **`biblebooks`**: retrieve the list of valid **book names** and **abbreviations** in various languages that are currently supported / recognized by the main BibleGet API endpoint. **`bibleversions`**: retrieve the list of **Bible versions** that are currently supported by the main BibleGet API endpoint. **`versionindex`**: retrieve the **indices of chapters and verses** for any of the Bible versions currently supported by the BibleGet engine (this value requires the usage of a second parameter `versions`).",
"required" : true,
"schema" : {
"type" : "string",
"enum" : [ "biblebooks", "bibleversions", "versionindex" ]
},
"examples" : {
"biblebooks" : {
"summary" : "Retrieve the list of valid book names and abbreviations in various languages that are currently supported / recognized by the main BibleGet API endpoint",
"value" : "biblebooks"
},
"bibleversions" : {
"summary" : "Retrieve the list of Bible versions that are currently supported by the main BibleGet API endpoint.",
"value" : "bibleversions"
},
"versionindex" : {
"summary" : "Retrieve the **indices of chapters and verses** for any of the Bible versions currently supported by the BibleGet engine. Requires the usage of a second parameter `versions`.",
"value" : "versionindex"
}
}
}, {
"name" : "versions",
"in" : "query",
"description" : "*(required in the case of a `query=versionindex` request)* Indicates for which Bible versions the indices data should be returned. The acronyms for valid Bible versions as returned by `query=bibleversions` should be used, either as a single string value or as a comma separated list of values.",
"required" : false,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
},
"default" : [ "CEI2008" ]
},
"style" : "form",
"explode" : false,
"examples" : {
"singleVersion" : {
"summary" : "Single Bible version",
"value" : [ "NABRE" ]
},
"multipleVersions" : {
"summary" : "Multiple Bible versions",
"value" : [ "NABRE", "NVBSE" ]
}
}
}, {
"name" : "return",
"in" : "query",
"description" : "Type of data that should be returned in the response",
"required" : false,
"schema" : {
"type" : "string",
"enum" : [ "json", "xml", "html" ],
"default" : "json"
},
"examples" : {
"json" : {
"summary" : "Request that the data be returned in JSON format",
"value" : "json"
},
"xml" : {
"summary" : "Request that the data be returned in XML format",
"value" : "xml"
},
"html" : {
"summary" : "Request that the data be returned in HTML format",
"value" : "html"
}
}
} ],
"responses" : {
"200" : {
"description" : "Structured data containing the required metadata about either Bible versions available, Bible version indexes, or the names and abbreviations of Bible books for any given Bible version",
"content" : {
"application/json" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/MetadataBibleVersions"
}, {
"$ref" : "#/components/schemas/MetadataBibleBooks"
}, {
"$ref" : "#/components/schemas/MetadataVersionIndex"
} ]
}
},
"application/xml" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/MetadataBibleVersions"
}, {
"$ref" : "#/components/schemas/MetadataBibleBooks"
}, {
"$ref" : "#/components/schemas/MetadataVersionIndex"
} ]
}
},
"text/html" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/MetadataBibleVersions"
}, {
"$ref" : "#/components/schemas/MetadataBibleBooks"
}, {
"$ref" : "#/components/schemas/MetadataVersionIndex"
} ]
}
}
}
}
}
},
"post" : {
"summary" : "Retrieve metadata about Bible versions that are available and their relative book/chapter/verse indexes",
"description" : "The API endpoint for querying metadata such as Bible versions that are available and their relative book/chapter/verse indexes",
"operationId" : "getMetadataByPOST",
"tags" : [ "MetadataAPI" ],
"requestBody" : {
"content" : {
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"query" : {
"type" : "string",
"description" : "Specifies the subset of metadata to retrieve. **`biblebooks`**: retrieve the list of valid **book names** and **abbreviations** in various languages that are currently supported / recognized by the main BibleGet API endpoint. **`bibleversions`**: retrieve the list of **Bible versions** that are currently supported by the main BibleGet API endpoint. **`versionindex`**: retrieve the **indices of chapters and verses** for any of the Bible versions currently supported by the BibleGet engine (this value requires the usage of a second parameter `versions`).",
"enum" : [ "biblebooks", "bibleversions", "versionindex" ],
"example" : "bibleversions"
},
"versions" : {
"type" : "array",
"description" : "Bible version or versions from which to retrieve the Bible quote. A list of valid versions can be retrieved from the `metadata.php` API using `query=bibleversions`",
"items" : {
"type" : "string"
},
"example" : [ "NABRE", "NVBSE" ],
"default" : [ "CEI2008" ]
},
"return" : {
"type" : "string",
"description" : "Type of data that should be returned in the response",
"enum" : [ "json", "xml", "html" ],
"example" : "json",
"default" : "json"
}
},
"required" : [ "query" ]
},
"encoding" : {
"versions" : {
"style" : "form",
"explode" : false
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Structured data containing the required metadata about either Bible versions available, Bible version indexes, or the names and abbreviations of Bible books for any given Bible version",
"content" : {
"application/json" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/MetadataBibleVersions"
}, {
"$ref" : "#/components/schemas/MetadataBibleBooks"
}, {
"$ref" : "#/components/schemas/MetadataVersionIndex"
} ]
}
},
"application/xml" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/MetadataBibleVersions"
}, {
"$ref" : "#/components/schemas/MetadataBibleBooks"
}, {
"$ref" : "#/components/schemas/MetadataVersionIndex"
} ]
}
},
"text/html" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/MetadataBibleVersions"
}, {
"$ref" : "#/components/schemas/MetadataBibleBooks"
}, {
"$ref" : "#/components/schemas/MetadataVersionIndex"
} ]
}
}
}
}
}
}
},
"/search.php" : {
"get" : {
"summary" : "Search for Bible verses that contain a given keyword. In the future, search by topic may also be implemented.",
"description" : "The API endpoint for performing search queries for Bible verses by keyword (or topic).",
"operationId" : "searchVersesByGET",
"tags" : [ "SearchAPI" ],
"parameters" : [ {
"name" : "query",
"in" : "query",
"description" : "Specifies the kind of search to perform. As of v2.8 of the search API only a value of `keywordsearch` is available.",
"required" : true,
"schema" : {
"type" : "string",
"enum" : [ "keywordsearch" ]
},
"examples" : {
"keywordsearch" : {
"summary" : "Perfom a search for Bible verses that contain the indicated keyword. Requires the usage of a second parameter: keyword. As of v2.8 of the search API endpoint, Search by topic is not yet available.",
"value" : "keywordsearch"
}
}
}, {
"name" : "keyword",
"in" : "query",
"description" : "*(required when making a request where `query=keywordsearch`)* indicates the keyword that will be searched in the text of the Bible verses",
"schema" : {
"type" : "string"
},
"examples" : {
"creation" : {
"summary" : "Perform a search for Bible verses that contain the keyword 'creation'.",
"value" : "creation"
}
}
}, {
"name" : "version",
"in" : "query",
"description" : "The acronym of the Bible version within which to perform the search by keyword. Can only be a single value, not a comma delimited list of values.",
"required" : true,
"schema" : {
"type" : "string"
},
"examples" : {
"NABRE" : {
"summary" : "perform a search for Bible verses containing a given keyword in the *NABRE* Bible version.",
"value" : "NABRE"
},
"NVBSE" : {
"summary" : "perform a search for Bible verses containing a given keyword in the *NVBSE* Bible version.",
"value" : "NVBSE"
}
}
}, {
"name" : "exactmatch",
"in" : "query",
"description" : "since the default behaviour for a keyword search is to find any word of 4 or more letters which matches or contains the keyword, this option will try to find only exact matches and will also allow to search for words of even only 3 letters (parts of speech excluded)",
"required" : false,
"schema" : {
"type" : "boolean"
},
"examples" : {
"true" : {
"summary" : "find only exact matches of words that are made up of 3 or more letters (parts of speech excluded)",
"value" : "true"
},
"false" : {
"summary" : "find both exact and partial matches of words made up of 4 or more letters",
"value" : "false"
}
}
}, {
"name" : "return",
"in" : "query",
"description" : "Type of data that should be returned in the response",
"required" : false,
"schema" : {
"type" : "string",
"enum" : [ "json", "xml", "html" ],
"default" : "json"
},
"examples" : {
"json" : {
"summary" : "Request that the data be returned in JSON format",
"value" : "json"
},
"xml" : {
"summary" : "Request that the data be returned in XML format",
"value" : "xml"
},
"html" : {
"summary" : "Request that the data be returned in HTML format",
"value" : "html"
}
}
} ],
"responses" : {
"200" : {
"description" : "",
"content" : {
"application/json" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/KeywordSearchJSON"
} ]
}
},
"application/xml" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/KeywordSearchXML"
} ]
}
},
"application/html" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/KeywordSearchJSON"
} ]
}
}
}
}
}
},
"post" : {
"summary" : "Search for Bible verses that contain a given keyword. In the future, search by topic may also be implemented.",
"description" : "The API endpoint for performing search queries for Bible verses by keyword (or topic).",
"operationId" : "searchVersesByPOST",
"tags" : [ "SearchAPI" ],
"requestBody" : {
"content" : {
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"query" : {
"type" : "string",
"description" : "Specifies the kind of search to perform. As of v2.8 of the search API only a value of `keywordsearch` is available.",
"enum" : [ "keywordsearch" ],
"example" : "keywordsearch"
},
"keyword" : {
"type" : "string",
"description" : "*(required when `query=keywordsearch`)* indicates the keyword that will be searched in the text of the Bible verses",
"example" : "creation"
},
"version" : {
"type" : "string",
"description" : "The acronym of the Bible version within which to perform the search by keyword. Can only be a single value, not a comma delimited list of values.",
"example" : "NVBSE"
},
"exactmatch" : {
"type" : "boolean",
"description" : "since the default behaviour for a keyword search is to find any word of 4 or more letters which matches or contains the keyword, this option will try to find only exact matches and will also allow to search for words of even only 3 letters (parts of speech excluded)",
"example" : "true"
},
"return" : {
"type" : "string",
"description" : "Type of data that should be returned in the response",
"enum" : [ "json", "xml", "html" ],
"example" : "json",
"default" : "json"
}
},
"required" : [ "query", "version" ]
}
}
}
},
"responses" : {
"200" : {
"description" : "",
"content" : {
"application/json" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/KeywordSearchJSON"
} ]
}
},
"application/xml" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/KeywordSearchXML"
} ]
}
},
"application/html" : {
"schema" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/KeywordSearchJSON"
} ]
}
}
}
}
}
}
}
},
"components" : {
"schemas" : {
"BibleQuotePOST" : {
"type" : "object",
"properties" : {
"query" : {
"type" : "string",
"description" : "Bible reference using standard Bible citation notation.",
"example" : "Genesis1:1-10"
},
"version" : {
"type" : "array",
"description" : "Bible version or versions from which to retrieve the Bible quote. A list of valid versions can be retrieved from the `metadata.php` API using `query=bibleversions`",
"items" : {
"type" : "string"
},
"example" : [ "NABRE", "NVBSE" ]
},
"return" : {
"type" : "string",
"description" : "Type of data that should be returned in the response",
"enum" : [ "json", "xml", "html" ],
"example" : "json",
"default" : "json"
},
"appid" : {
"type" : "string",
"description" : "Unique identifier of the application making the request, to be agreed upon with the owner of the API endpoint",
"example" : "swaggerhub"
},
"pluginversion" : {
"type" : "string",
"description" : "Version number of the application making the request. Useful not only for statistics, to help understand which version of an application is being actively used, but also (especially in the case of the official applications) to help deal with possibly breaking changes between the application version and versions of the API endpoint",
"example" : "v1.0"
},
"domain" : {
"type" : "string",
"description" : "In the case of web based applications, should indicate the domain from which the request is generated. Currently used by the official plugin for WordPress to better understand usage of the plugin and monitor requests. When the application or plugin making the request can be installed on different domains (as is the case with the WordPress plugin), this value should be generated dynamically from a server variable identifying the domain. If instead it will always be the same domain making the requests, the value can be hardcoded with the actual domain.",
"example" : "app.swaggerhub.com"
}
},
"required" : [ "query", "version", "appid" ]
},
"BibleQuoteJSON" : {
"type" : "object",
"properties" : {
"results" : {
"type" : "array",
"description" : "Array of objects each of which represents a Bible verse with all associated information",
"items" : {
"type" : "object",
"properties" : {
"testament" : {
"type" : "integer",
"enum" : [ 1, 2 ],
"description" : "`1` = *Old Testament*, `2` = *New Testament*",
"xml" : {
"attribute" : true
}
},
"section" : {
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ],
"description" : "`1` = *Pentateuch*, `2` = *Historical Books*, `3` = *Wisdom Books*, `4` = *Prophets*, `5` = *Gospels*, `6` = *Acts of the Apostles*, `7` = *Letters of Saint Paul*, `8` = *Catholic Letters*, `9` = *Apocalypse*",
"xml" : {
"attribute" : true
}
},
"book" : {
"type" : "string",
"description" : "Name of the book of the Bible in the language of the Bible version being quoted from",
"xml" : {
"attribute" : true
}
},
"bookabbrev" : {
"type" : "string",
"description" : "Abbreviated form of the book of the Bible in the language of the Bible version being quoted from",
"xml" : {
"attribute" : true
}
},
"booknum" : {
"type" : "integer",
"description" : "0 based index of the Book of the Bible in the Bible version being quoted from (not all versions have the same books in the same order, especially when considering differences between Catholic and evangelical versions). The value is returned as a number value ready to be used against index information for the Bible version being quoted from. The corresponding name of the Book of the Bible as used in the printed edition of the current Bible version can be retrieved using the `metadata.php` API endpoint, as can index information about the number of chapters in the book and the number of verses in each chapter.",
"xml" : {
"attribute" : true
}
},
"univbooknum" : {
"type" : "string",
"description" : "A number identifying the Book of the Bible according to the universally recognized Catholic version of the Canon of the Sacred Scriptures (*i.e. universally recognized by the Roman Catholic Church*). This is not a 0 based index, but rather `1` = *Genesis*, `2` = *Exodus*, etc. Therefore it is returned as a string, but can be treated as a number.",
"enum" : [ "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" ],
"xml" : {
"attribute" : true
}
},
"chapter" : {
"type" : "integer",
"description" : "Chapter of the book of the Bible in the Bible version that the verse is being quoted from",
"xml" : {
"attribute" : true
}
},
"versedescr" : {
"type" : "string",
"description" : "Not currently used, comes back as a `null` value. Could possible be used in the future for scholarly notes associated with a Bible verse",
"nullable" : true,
"xml" : {
"attribute" : true
}
},
"verse" : {
"type" : "string",
"description" : "Verse Number of the verse being quoted. *N.B. this is returned as a string because it will not always necessarily be a number value, there are verses that have letters in them. The value must be treated as a string and not as a number.*",
"xml" : {
"attribute" : true
}
},
"verseequiv" : {
"type" : "integer",
"description" : "I'm not actually sure if this is currently being used or not, I believe the idea was to have a number value for those verses that have a letter in the verse number... Will mostly return a `null` value.",
"nullable" : true,
"xml" : {
"attribute" : true
}
},
"text" : {
"type" : "string",
"description" : "Contains the actual text of the verse being quoted. May contain `newline` characters that may need to be dealt with. The **NABRE** version will contain ***it's own formatting tags that need to be dealt with***, whether that means producing the proper formatting associated with these tags, or removing them to have a basic formatting. The legal requirements for usage of the NABRE version require the proper formatting to be used where possible. Please [contact the project author](mailto:admin@bibleget.io) for information on how to deal with these tags and their formatting.",
"xml" : {
"attribute" : true
}
},
"version" : {
"type" : "string",
"description" : "the acronym of the Bible version being quoted from. For data associated with any given Bible version, for example index information, the `metadata.php` API endpoint can be used",
"xml" : {
"attribute" : true
}
},
"title1" : {
"type" : "string",
"description" : "not currently used. The original idea (which may yet be implemented) was for this to contain any first-level title text preceding the given verse in the version of the Bible being quoted from.",
"xml" : {
"attribute" : true
}
},
"title2" : {
"type" : "string",
"description" : "not currently used. The original idea (which may yet be implemented) was for this to contain any second-level title text preceding the given verse in the version of the Bible being quoted from.",
"xml" : {
"attribute" : true
}
},
"title3" : {
"type" : "string",
"description" : "not currently used. The original idea (which may yet be implemented) was for this to contain any third-level title text preceding the given verse in the version of the Bible being quoted from.",
"xml" : {
"attribute" : true
}
},
"originalquery" : {
"type" : "string",
"description" : "The original query (Bible reference indicated in the `query` parameter of the sent request) that the endpoint received, which produced this result.",
"xml" : {
"attribute" : true
}
}
}
},
"xml" : {
"wrapped" : true,
"name" : "results"
}
},
"errors" : {
"type" : "array",
"description" : "An array of any error messages that may have been generated indicating a badly formed `query` parameter, a bad value for the `version` parameter, or an API server error",
"items" : {
"type" : "string"
}
},
"info" : {
"type" : "object",
"description" : "An object containing metadata about the API endpoint",
"properties" : {
"ENDPOINT_VERSION" : {
"type" : "string"
}
}
}
}
},
"BibleQuoteXML" : {
"type" : "object",
"properties" : {
"results" : {
"type" : "array",
"description" : "Array of objects each of which represents a Bible verse with all associated information",
"items" : {
"$ref" : "#/components/schemas/BibleQuoteResult"
},
"xml" : {
"name" : "results",
"wrapped" : true
}
},
"errors" : {
"type" : "array",
"description" : "An array of any error messages that may have been generated indicating a badly formed `query` parameter, a bad value for the `version` parameter, or an API server error",
"items" : {
"type" : "string"
}
},
"info" : {
"type" : "object",
"description" : "An object containing metadata about the API endpoint",
"properties" : {
"ENDPOINT_VERSION" : {
"type" : "string"
}
}
}
},
"xml" : {
"name" : "BibleQuote"
}
},
"BibleQuoteResult" : {
"type" : "object",
"properties" : {
"testament" : {
"type" : "integer",
"enum" : [ 1, 2 ],
"description" : "`1` = *Old Testament*, `2` = *New Testament*",
"xml" : {
"attribute" : true
}
},
"section" : {
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ],
"description" : "`1` = *Pentateuch*, `2` = *Historical Books*, `3` = *Wisdom Books*, `4` = *Prophets*, `5` = *Gospels*, `6` = *Acts of the Apostles*, `7` = *Letters of Saint Paul*, `8` = *Catholic Letters*, `9` = *Apocalypse*",
"xml" : {
"attribute" : true
}
},
"book" : {
"type" : "string",
"description" : "Name of the book of the Bible in the language of the Bible version being quoted from",
"xml" : {
"attribute" : true
}
},
"bookabbrev" : {
"type" : "string",
"description" : "Abbreviated form of the book of the Bible in the language of the Bible version being quoted from",
"xml" : {
"attribute" : true
}
},
"booknum" : {
"type" : "integer",
"description" : "0 based index of the Book of the Bible in the Bible version being quoted from (not all versions have the same books in the same order, especially when considering differences between Catholic and evangelical versions). The value is returned as a number value ready to be used against index information for the Bible version being quoted from. The corresponding name of the Book of the Bible as used in the printed edition of the current Bible version can be retrieved using the `metadata.php` API endpoint, as can index information about the number of chapters in the book and the number of verses in each chapter.",
"xml" : {
"attribute" : true
}
},
"univbooknum" : {
"type" : "string",
"description" : "A number identifying the Book of the Bible according to the universally recognized Catholic version of the Canon of the Sacred Scriptures (*i.e. universally recognized by the Roman Catholic Church*). This is not a 0 based index, but rather `1` = *Genesis*, `2` = *Exodus*, etc. Therefore it is returned as a string, but can be treated as a number.",
"enum" : [ "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" ],
"xml" : {
"attribute" : true
}
},
"chapter" : {
"type" : "integer",
"description" : "Chapter of the book of the Bible in the Bible version that the verse is being quoted from",
"xml" : {
"attribute" : true
}
},
"versedescr" : {
"type" : "string",
"description" : "Not currently used, comes back as a `null` value. Could possible be used in the future for scholarly notes associated with a Bible verse",
"nullable" : true,
"xml" : {
"attribute" : true
}
},
"verse" : {
"type" : "string",
"description" : "Verse Number of the verse being quoted. *N.B. this is returned as a string because it will not always necessarily be a number value, there are verses that have letters in them. The value must be treated as a string and not as a number.*",
"xml" : {
"attribute" : true
}
},
"verseequiv" : {
"type" : "integer",
"description" : "I'm not actually sure if this is currently being used or not, I believe the idea was to have a number value for those verses that have a letter in the verse number... Will mostly return a `null` value.",
"nullable" : true,
"xml" : {
"attribute" : true
}
},
"text" : {
"type" : "string",
"description" : "Contains the actual text of the verse being quoted. May contain `newline` characters that may need to be dealt with. The **NABRE** version will contain ***it's own formatting tags that need to be dealt with***, whether that means producing the proper formatting associated with these tags, or removing them to have a basic formatting. The legal requirements for usage of the NABRE version require the proper formatting to be used where possible. Please [contact the project author](mailto:admin@bibleget.io) for information on how to deal with these tags and their formatting.",
"xml" : {
"attribute" : true
}
},
"version" : {
"type" : "string",
"description" : "the acronym of the Bible version being quoted from. For data associated with any given Bible version, for example index information, the `metadata.php` API endpoint can be used",
"xml" : {
"attribute" : true
}
},
"title1" : {
"type" : "string",
"description" : "not currently used. The original idea (which may yet be implemented) was for this to contain any first-level title text preceding the given verse in the version of the Bible being quoted from.",
"xml" : {
"attribute" : true
}
},
"title2" : {
"type" : "string",
"description" : "not currently used. The original idea (which may yet be implemented) was for this to contain any second-level title text preceding the given verse in the version of the Bible being quoted from.",
"xml" : {
"attribute" : true
}
},
"title3" : {
"type" : "string",
"description" : "not currently used. The original idea (which may yet be implemented) was for this to contain any third-level title text preceding the given verse in the version of the Bible being quoted from.",
"xml" : {
"attribute" : true
}
},
"originalquery" : {
"type" : "string",
"description" : "The original query (Bible reference indicated in the `query` parameter of the sent request) that the endpoint received, which produced this result.",
"xml" : {
"attribute" : true
}
}
},
"xml" : {
"name" : "result"
}
},
"MetadataBibleVersions" : {
"type" : "object",
"properties" : {
"validversions" : {
"type" : "array",
"description" : "An array of the acronyms of the Bible versions that are currently supported by the main BibleGet API endpoint",
"items" : {
"type" : "string"
}
},
"validversions_fullname" : {
"type" : "object",
"description" : "An object the keys of which are the acronyms of the Bible versions that are currently supported by the main BibleGet API endpoint, and the values of which are a pipe separated list of 1. The full name of the Bible version 2. The year it was published 3. The two letter ISO 639-1 code of the **language** of the Bible version",
"additionalProperties" : {
"type" : "string"
}
},
"copyrightversions" : {
"type" : "array",
"description" : "An array containing the acronyms of Bible versions that have a copyright holder, the usage of which is regulated under a legally binding agreement with the copyright holder. For example, some copyright holders (usually Episcopal Conferences for Catholic versions) may request that no more than a certain number of verses be issued from a single request to the endpoint (in other words, please don't try to copy the whole Bible through the BibleGet endpoint!). Enforcement of the usage required by the copyright holder is done by the endpoint itself, so applications cannot overcome these limits. If the owner of the endpoint notices that an application attempts in a sly manner to overcome these limitations, access to the main API endpoint may be denied to the application and authorization mechanisms will be necessarily put in place for usage of the endpoints. We are assuming a model of responsible usage for the time being, but if it becomes necessary access will be restricted and authorization will be required",
"items" : {
"type" : "string"
}
},
"errors" : {
"type" : "array",
"description" : "An array of any error messages that may have been generated indicating a badly formed `query` parameter or an API server error",
"items" : {
"type" : "string"
}
},
"info" : {
"type" : "object",
"description" : "An object containing metadata about the API endpoint",
"properties" : {
"ENDPOINT_VERSION" : {
"type" : "string"
}
}
}
},
"xml" : {
"name" : "BibleGetMetadata"
}
},
"MetadataBibleBooks" : {
"type" : "object",
"properties" : {
"languages" : {
"type" : "array",
"description" : "An array indicating the languages supported by the main BibleGet endpoint, for the names of the Books of the Bible. The single languages are returned in the English form, all caps. The implict numbered index of this array will be useful for the data associated with the `results` key.",
"items" : {
"type" : "string"
}
},
"results" : {
"type" : "array",
"description" : "An array containing information about the names of the Bible books that can be used to make queries to the main endpoint. The implict numbered index of this array corresponds with the Bible books universally recognized by the Roman Catholic Church. Bible versions used by evangelicals will generally have a few less Bible books, so the index of reference is the Canon of the Scriptures as recognized by the Roman Catholic Church.",
"items" : {
"$ref" : "#/components/schemas/MetadataBibleBooksResult"
}
},
"errors" : {
"type" : "array",
"description" : "An array of any error messages that may have been generated indicating a badly formed `query` parameter or an API server error",
"items" : {
"type" : "string"
}
},
"info" : {
"type" : "object",
"description" : "An object containing metadata about the API endpoint",
"properties" : {
"ENDPOINT_VERSION" : {
"type" : "string"
}
}
}
},
"xml" : {
"name" : "BibleGetMetadata"
}
},
"MetadataVersionIndex" : {
"type" : "object",
"properties" : {
"indexes" : {
"type" : "object",
"description" : "An object the *keys* of which are the *acronyms of the Bible versions as requested with the `versions` parameter*, and the corresponding *values* of which are objects with the index information associated with that Bible version.",
"additionalProperties" : {
"$ref" : "#/components/schemas/MetadataVersionIndexForVersion"
}
},
"errors" : {
"type" : "array",
"description" : "An array of any error messages that may have been generated indicating a badly formed `query` parameter, a bad value for the `version` parameter, or an API server error",
"items" : {
"type" : "string"
}
},
"info" : {
"type" : "object",
"description" : "An object containing metadata about the API endpoint",
"properties" : {
"ENDPOINT_VERSION" : {
"type" : "string"
}
}
}
},
"xml" : {
"name" : "BibleGetMetadata"
}
},
"MetadataBibleBooksResult" : {
"type" : "array",
"description" : "Each element of the `results` array will is an array whose implicit numbered index corresponds with the *LANGUAGES* supported by the main endoint, as can be found in the `languages` key of the returned data.",
"items" : {
"$ref" : "#/components/schemas/MetadataBibleBooksResultForLang"
}
},
"MetadataBibleBooksResultForLang" : {
"type" : "array",
"description" : "An array with a variable number of elements. The first two elements will always be present: 1. a pipe separated list of the possible Full names of the Bible book in the given language (if there are multiple possible forms that is; the pipe will be not be present if there is not a list of values) 2. a pipe separated list of the possible abbreviated forms of the Bible book in the given language (if there are multiple possible forms that is; the pipe will be not be present if there is not a list of values) 3. Any other elements will not be pipe separated lists but single strings of the possible alternate forms whether full or abbreviated ??? [note to myself: double check this, what was the reasoning behind this kind of structuring of the data?]",
"items" : {
"type" : "string"
}
},
"MetadataVersionIndexForVersion" : {
"type" : "object",
"description" : "",
"properties" : {
"abbreviations" : {