{ "openapi": "3.1.0", "info": { "title": "Free Use Bible API", "version": "1.0.0", "description": "An API for accessing over 1000 different Bible translations.", "contact": { "name": "HelloAO", "url": "https://bible.helloao.org", "email": "hello@helloao.org" } }, "servers": [ { "url": "https://bible.helloao.org", "description": "Free Use Bible API production server" } ], "paths": { "/api/available_translations.json": { "get": { "operationId": "getAvailableTranslations", "description": "Get the list of available Bible translations.", "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiAvailableTranslations" } } } } } } }, "/api/{translation}/books.json": { "get": { "operationId": "getTranslationBooks", "description": "Get the list of books available for a specific translation.", "parameters": [ { "in": "path", "name": "translation", "schema": { "type": "string", "description": "The translation ID of the Bible translation to get the books for. For example, \"eng_kjv\" for the King James Version." }, "required": true, "description": "The translation ID of the Bible translation to get the books for. For example, \"eng_kjv\" for the King James Version." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTranslationBooks" } } } }, "404": { "description": "404 Not Found - The specified translation was not found." } } } }, "/api/{translation}/{book}/{chapter}.json": { "get": { "operationId": "getTranslationBookChapter", "description": "Get the content of a specific chapter of a specific book for a specific translation.", "parameters": [ { "in": "path", "name": "translation", "schema": { "type": "string", "description": "The translation ID of the Bible translation to get the books for. For example, \"eng_kjv\" for the King James Version." }, "required": true, "description": "The translation ID of the Bible translation to get the books for. For example, \"eng_kjv\" for the King James Version." }, { "in": "path", "name": "book", "schema": { "$ref": "#/components/schemas/BookId" }, "required": true, "description": "IDs for books. Follows the USFM standard (https://ubsicap.github.io/usfm/identification/books.html)" }, { "in": "path", "name": "chapter", "schema": { "type": "number", "exclusiveMinimum": 0, "description": "The chapter number to get the content for. This should be a positive integer." }, "required": true, "description": "The chapter number to get the content for. This should be a positive integer." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTranslationBookChapter" } } }, "links": { "nextChapter": { "operationId": "getTranslationBookChapter", "description": "Gets the chapter that follows the current chapter in the translation.", "parameters": { "translation": "$response.body#/nextChapterReference/translationId", "book": "$response.body#/nextChapterReference/book", "chapter": "$response.body#/nextChapterReference/chapter" } }, "previousChapter": { "operationId": "getTranslationBookChapter", "description": "Gets the chapter that precedes the current chapter in the translation.", "parameters": { "translation": "$response.body#/previousChapterReference/translationId", "book": "$response.body#/previousChapterReference/book", "chapter": "$response.body#/previousChapterReference/chapter" } } } }, "404": { "description": "404 Not Found - The specified translation, book, or chapter was not found." } } } }, "/api/{translation}/{book}/{chapter}.simple.json": { "get": { "operationId": "getSimpleTranslationBookChapter", "description": "Get the content of a specific chapter of a specific book for a specific translation, using the simplified format. In the simplified format, the content of each verse is a single string instead of a list of formatted content, and the footnotes are available on the verse that they occur in, along with the offset that they occur at.", "parameters": [ { "in": "path", "name": "translation", "schema": { "type": "string", "description": "The translation ID of the Bible translation to get the books for. For example, \"eng_kjv\" for the King James Version." }, "required": true, "description": "The translation ID of the Bible translation to get the books for. For example, \"eng_kjv\" for the King James Version." }, { "in": "path", "name": "book", "schema": { "$ref": "#/components/schemas/BookId" }, "required": true, "description": "IDs for books. Follows the USFM standard (https://ubsicap.github.io/usfm/identification/books.html)" }, { "in": "path", "name": "chapter", "schema": { "type": "number", "exclusiveMinimum": 0, "description": "The chapter number to get the content for. This should be a positive integer." }, "required": true, "description": "The chapter number to get the content for. This should be a positive integer." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSimpleTranslationBookChapter" } } }, "links": { "nextChapter": { "operationId": "getSimpleTranslationBookChapter", "description": "Gets the chapter that follows the current chapter in the translation.", "parameters": { "translation": "$response.body#/nextChapterReference/translationId", "book": "$response.body#/nextChapterReference/book", "chapter": "$response.body#/nextChapterReference/chapter" } }, "previousChapter": { "operationId": "getSimpleTranslationBookChapter", "description": "Gets the chapter that precedes the current chapter in the translation.", "parameters": { "translation": "$response.body#/previousChapterReference/translationId", "book": "$response.body#/previousChapterReference/book", "chapter": "$response.body#/previousChapterReference/chapter" } } } }, "404": { "description": "404 Not Found - The specified translation, book, or chapter was not found." } } } }, "/api/{translation}/{book}/{chapter}.{reader}.audioTimings.json": { "get": { "operationId": "getTranslationBookChapterAudioTimings", "description": "Get the audio timings (per-verse start times, in seconds) for a specific chapter of a specific book for a specific translation and reader.", "parameters": [ { "in": "path", "name": "translation", "schema": { "type": "string", "description": "The translation ID of the Bible translation to get the books for. For example, \"eng_kjv\" for the King James Version." }, "required": true, "description": "The translation ID of the Bible translation to get the books for. For example, \"eng_kjv\" for the King James Version." }, { "in": "path", "name": "book", "schema": { "$ref": "#/components/schemas/BookId" }, "required": true, "description": "IDs for books. Follows the USFM standard (https://ubsicap.github.io/usfm/identification/books.html)" }, { "in": "path", "name": "chapter", "schema": { "type": "number", "exclusiveMinimum": 0, "description": "The chapter number to get the content for. This should be a positive integer." }, "required": true, "description": "The chapter number to get the content for. This should be a positive integer." }, { "in": "path", "name": "reader", "schema": { "type": "string", "description": "The ID of the reader to get the audio timings for. For example, \"hays\" for the Hays reading of the Berean Standard Bible." }, "required": true, "description": "The ID of the reader to get the audio timings for. For example, \"hays\" for the Hays reading of the Berean Standard Bible." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTranslationBookChapterAudioTimings" } } } }, "404": { "description": "404 Not Found - The specified translation, book, chapter, or reader was not found." } } } }, "/api/{translation}/{book}/{chapter}.words.json": { "get": { "operationId": "getTranslationBookChapterWords", "description": "Get the word-level annotations (Strong's numbers and related source data) for a specific chapter of a specific book for a specific translation.", "parameters": [ { "in": "path", "name": "translation", "schema": { "type": "string", "description": "The translation ID of the Bible translation to get the books for. For example, \"eng_kjv\" for the King James Version." }, "required": true, "description": "The translation ID of the Bible translation to get the books for. For example, \"eng_kjv\" for the King James Version." }, { "in": "path", "name": "book", "schema": { "$ref": "#/components/schemas/BookId" }, "required": true, "description": "IDs for books. Follows the USFM standard (https://ubsicap.github.io/usfm/identification/books.html)" }, { "in": "path", "name": "chapter", "schema": { "type": "number", "exclusiveMinimum": 0, "description": "The chapter number to get the content for. This should be a positive integer." }, "required": true, "description": "The chapter number to get the content for. This should be a positive integer." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTranslationBookChapterWords" } } } }, "404": { "description": "404 Not Found - The specified translation, book, or chapter was not found, or the chapter does not have any word-level annotations." } } } }, "/api/{translation}/{book}/{chapter}.words.simple.json": { "get": { "operationId": "getSimpleTranslationBookChapterWords", "description": "Get the word-level annotations (Strong's numbers and related source data) for a specific chapter of a specific book for a specific translation, with their offsets remapped onto the text of each simplified verse. Use this with the simplified chapter format, since the offsets in the regular annotations are anchored to a verse's content array.", "parameters": [ { "in": "path", "name": "translation", "schema": { "type": "string", "description": "The translation ID of the Bible translation to get the books for. For example, \"eng_kjv\" for the King James Version." }, "required": true, "description": "The translation ID of the Bible translation to get the books for. For example, \"eng_kjv\" for the King James Version." }, { "in": "path", "name": "book", "schema": { "$ref": "#/components/schemas/BookId" }, "required": true, "description": "IDs for books. Follows the USFM standard (https://ubsicap.github.io/usfm/identification/books.html)" }, { "in": "path", "name": "chapter", "schema": { "type": "number", "exclusiveMinimum": 0, "description": "The chapter number to get the content for. This should be a positive integer." }, "required": true, "description": "The chapter number to get the content for. This should be a positive integer." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSimpleTranslationBookChapterWords" } } } }, "404": { "description": "404 Not Found - The specified translation, book, or chapter was not found, or the chapter does not have any word-level annotations." } } } }, "/api/{translation}/complete.json": { "get": { "operationId": "getTranslationComplete", "description": "Get the complete content of a specific translation.", "parameters": [ { "in": "path", "name": "translation", "schema": { "type": "string", "description": "The translation ID of the Bible translation to get the books for. For example, \"eng_kjv\" for the King James Version." }, "required": true, "description": "The translation ID of the Bible translation to get the books for. For example, \"eng_kjv\" for the King James Version." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTranslationComplete" } } } }, "404": { "description": "404 Not Found - The specified translation was not found, or complete translations are not available." } } } }, "/api/{translation}/complete.simple.json": { "get": { "operationId": "getSimpleTranslationComplete", "description": "Get the complete content of a specific translation, using the simplified format. In the simplified format, the content of each verse is a single string instead of a list of formatted content, and the footnotes are available on the verse that they occur in, along with the offset that they occur at.", "parameters": [ { "in": "path", "name": "translation", "schema": { "type": "string", "description": "The translation ID of the Bible translation to get the books for. For example, \"eng_kjv\" for the King James Version." }, "required": true, "description": "The translation ID of the Bible translation to get the books for. For example, \"eng_kjv\" for the King James Version." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSimpleTranslationComplete" } } } }, "404": { "description": "404 Not Found - The specified translation was not found, or complete translations are not available." } } } }, "/api/available_commentaries.json": { "get": { "operationId": "getAvailableCommentaries", "description": "Get the list of available commentaries.", "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiAvailableCommentaries" } } } } } } }, "/api/c/{commentary}/books.json": { "get": { "operationId": "getCommentaryBooks", "description": "Get the list of books available for a specific commentary.", "parameters": [ { "in": "path", "name": "commentary", "schema": { "type": "string", "description": "The commentary ID of the commentary to get the books or chapter content for." }, "required": true, "description": "The commentary ID of the commentary to get the books or chapter content for." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiCommentaryBooks" } } } }, "404": { "description": "404 Not Found - The specified commentary was not found." } } } }, "/api/c/{commentary}/{book}/{chapter}.json": { "get": { "operationId": "getCommentaryBookChapter", "description": "Get the content of a specific chapter of a specific book for a specific commentary.", "parameters": [ { "in": "path", "name": "commentary", "schema": { "type": "string", "description": "The commentary ID of the commentary to get the books or chapter content for." }, "required": true, "description": "The commentary ID of the commentary to get the books or chapter content for." }, { "in": "path", "name": "book", "schema": { "$ref": "#/components/schemas/BookId" }, "required": true, "description": "IDs for books. Follows the USFM standard (https://ubsicap.github.io/usfm/identification/books.html)" }, { "in": "path", "name": "chapter", "schema": { "type": "number", "exclusiveMinimum": 0, "description": "The chapter number to get the content for. This should be a positive integer." }, "required": true, "description": "The chapter number to get the content for. This should be a positive integer." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiCommentaryBookChapter" } } } }, "404": { "description": "404 Not Found - The specified commentary, book, or chapter was not found." } } } }, "/api/c/{commentary}/{book}/{chapter}.simple.json": { "get": { "operationId": "getSimpleCommentaryBookChapter", "description": "Get the content of a specific chapter of a specific book for a specific commentary, using the simplified format. In the simplified format, the content of each verse is a single string instead of a list of formatted content.", "parameters": [ { "in": "path", "name": "commentary", "schema": { "type": "string", "description": "The commentary ID of the commentary to get the books or chapter content for." }, "required": true, "description": "The commentary ID of the commentary to get the books or chapter content for." }, { "in": "path", "name": "book", "schema": { "$ref": "#/components/schemas/BookId" }, "required": true, "description": "IDs for books. Follows the USFM standard (https://ubsicap.github.io/usfm/identification/books.html)" }, { "in": "path", "name": "chapter", "schema": { "type": "number", "exclusiveMinimum": 0, "description": "The chapter number to get the content for. This should be a positive integer." }, "required": true, "description": "The chapter number to get the content for. This should be a positive integer." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSimpleCommentaryBookChapter" } } } }, "404": { "description": "404 Not Found - The specified commentary, book, or chapter was not found." } } } }, "/api/available_datasets.json": { "get": { "operationId": "getAvailableDatasets", "description": "Get the list of available datasets.", "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiAvailableDatasets" } } } } } } }, "/api/d/{dataset}/books.json": { "get": { "operationId": "getDatasetBooks", "description": "Get the list of books available for a specific dataset.", "parameters": [ { "in": "path", "name": "dataset", "schema": { "type": "string", "description": "The dataset ID of the dataset to get the books or chapter content for." }, "required": true, "description": "The dataset ID of the dataset to get the books or chapter content for." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDatasetBooks" } } } }, "404": { "description": "404 Not Found - The specified dataset was not found." } } } }, "/api/d/{dataset}/{book}/{chapter}.json": { "get": { "operationId": "getDatasetBookChapter", "description": "Get the content of a specific chapter of a specific book for a specific dataset. For cross reference datasets, this is the list of cross references for each verse in the chapter. For entity datasets (such as \"theographic\"), this is the people, places, and events that appear in the chapter.", "parameters": [ { "in": "path", "name": "dataset", "schema": { "type": "string", "description": "The dataset ID of the dataset to get the books or chapter content for." }, "required": true, "description": "The dataset ID of the dataset to get the books or chapter content for." }, { "in": "path", "name": "book", "schema": { "$ref": "#/components/schemas/BookId" }, "required": true, "description": "IDs for books. Follows the USFM standard (https://ubsicap.github.io/usfm/identification/books.html)" }, { "in": "path", "name": "chapter", "schema": { "type": "number", "exclusiveMinimum": 0, "description": "The chapter number to get the content for. This should be a positive integer." }, "required": true, "description": "The chapter number to get the content for. This should be a positive integer." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ApiDatasetBookChapter" }, { "$ref": "#/components/schemas/ApiDatasetEntityBookChapter" } ] } } } }, "404": { "description": "404 Not Found - The specified dataset, book, or chapter was not found." } } } }, "/api/d/{dataset}/people.json": { "get": { "operationId": "getDatasetPeople", "description": "Get the list of people that are available for a specific dataset.", "parameters": [ { "in": "path", "name": "dataset", "schema": { "type": "string", "description": "The dataset ID of the dataset to get the books or chapter content for." }, "required": true, "description": "The dataset ID of the dataset to get the books or chapter content for." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDatasetPeople" } } } }, "404": { "description": "404 Not Found - The specified dataset was not found or doesn't contain people." } } } }, "/api/d/{dataset}/people/{person}.json": { "get": { "operationId": "getDatasetPerson", "description": "Get the information about a specific person for a specific dataset. Includes the Bible references that mention the person and their relationships to other people, places, events, and people groups.", "parameters": [ { "in": "path", "name": "dataset", "schema": { "type": "string", "description": "The dataset ID of the dataset to get the books or chapter content for." }, "required": true, "description": "The dataset ID of the dataset to get the books or chapter content for." }, { "in": "path", "name": "person", "schema": { "type": "string", "description": "The ID of the person to get the information for. For example, \"paul_2479\" for the apostle Paul." }, "required": true, "description": "The ID of the person to get the information for. For example, \"paul_2479\" for the apostle Paul." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDatasetPerson" } } } }, "404": { "description": "404 Not Found - The specified dataset or person was not found." } } } }, "/api/d/{dataset}/places.json": { "get": { "operationId": "getDatasetPlaces", "description": "Get the list of places that are available for a specific dataset.", "parameters": [ { "in": "path", "name": "dataset", "schema": { "type": "string", "description": "The dataset ID of the dataset to get the books or chapter content for." }, "required": true, "description": "The dataset ID of the dataset to get the books or chapter content for." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDatasetPlaces" } } } }, "404": { "description": "404 Not Found - The specified dataset was not found or doesn't contain places." } } } }, "/api/d/{dataset}/places/{place}.json": { "get": { "operationId": "getDatasetPlace", "description": "Get the information about a specific place for a specific dataset. Includes the Bible references that mention the place and its related people and events.", "parameters": [ { "in": "path", "name": "dataset", "schema": { "type": "string", "description": "The dataset ID of the dataset to get the books or chapter content for." }, "required": true, "description": "The dataset ID of the dataset to get the books or chapter content for." }, { "in": "path", "name": "place", "schema": { "type": "string", "description": "The ID of the place to get the information for. For example, \"jerusalem_636\" for Jerusalem." }, "required": true, "description": "The ID of the place to get the information for. For example, \"jerusalem_636\" for Jerusalem." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDatasetPlace" } } } }, "404": { "description": "404 Not Found - The specified dataset or place was not found." } } } }, "/api/d/{dataset}/events.json": { "get": { "operationId": "getDatasetEvents", "description": "Get the list of events that are available for a specific dataset.", "parameters": [ { "in": "path", "name": "dataset", "schema": { "type": "string", "description": "The dataset ID of the dataset to get the books or chapter content for." }, "required": true, "description": "The dataset ID of the dataset to get the books or chapter content for." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDatasetEvents" } } } }, "404": { "description": "404 Not Found - The specified dataset was not found or doesn't contain events." } } } }, "/api/d/{dataset}/events/{event}.json": { "get": { "operationId": "getDatasetEvent", "description": "Get the information about a specific event for a specific dataset. Includes the Bible references that describe the event and its related people, places, and people groups.", "parameters": [ { "in": "path", "name": "dataset", "schema": { "type": "string", "description": "The dataset ID of the dataset to get the books or chapter content for." }, "required": true, "description": "The dataset ID of the dataset to get the books or chapter content for." }, { "in": "path", "name": "event", "schema": { "type": "string", "description": "The ID of the event to get the information for. For example, \"saul-is-converted_326\" for the conversion of Saul." }, "required": true, "description": "The ID of the event to get the information for. For example, \"saul-is-converted_326\" for the conversion of Saul." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDatasetEvent" } } } }, "404": { "description": "404 Not Found - The specified dataset or event was not found." } } } }, "/api/d/{dataset}/groups.json": { "get": { "operationId": "getDatasetPeopleGroups", "description": "Get the list of people groups that are available for a specific dataset.", "parameters": [ { "in": "path", "name": "dataset", "schema": { "type": "string", "description": "The dataset ID of the dataset to get the books or chapter content for." }, "required": true, "description": "The dataset ID of the dataset to get the books or chapter content for." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDatasetPeopleGroups" } } } }, "404": { "description": "404 Not Found - The specified dataset was not found or doesn't contain people groups." } } } }, "/api/d/{dataset}/groups/{group}.json": { "get": { "operationId": "getDatasetPeopleGroup", "description": "Get the information about a specific people group for a specific dataset. Includes the members of the group and the events that the group participated in.", "parameters": [ { "in": "path", "name": "dataset", "schema": { "type": "string", "description": "The dataset ID of the dataset to get the books or chapter content for." }, "required": true, "description": "The dataset ID of the dataset to get the books or chapter content for." }, { "in": "path", "name": "group", "schema": { "type": "string", "description": "The ID of the people group to get the information for. For example, \"tribe-of-benjamin\" for the tribe of Benjamin." }, "required": true, "description": "The ID of the people group to get the information for. For example, \"tribe-of-benjamin\" for the tribe of Benjamin." } ], "responses": { "200": { "description": "200 OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDatasetPeopleGroup" } } } }, "404": { "description": "404 Not Found - The specified dataset or people group was not found." } } } } }, "components": { "schemas": { "BookId": { "type": "string", "enum": [ "GEN", "EXO", "LEV", "NUM", "DEU", "JOS", "JDG", "RUT", "1SA", "2SA", "1KI", "2KI", "1CH", "2CH", "EZR", "NEH", "EST", "JOB", "PSA", "PRO", "ECC", "SNG", "ISA", "JER", "LAM", "EZK", "DAN", "HOS", "JOL", "AMO", "OBA", "JON", "MIC", "NAM", "HAB", "ZEP", "HAG", "ZEC", "MAL", "MAT", "MRK", "LUK", "JHN", "ACT", "ROM", "1CO", "2CO", "GAL", "EPH", "PHP", "COL", "1TH", "2TH", "1TI", "2TI", "TIT", "PHM", "HEB", "JAS", "1PE", "2PE", "1JN", "2JN", "3JN", "JUD", "REV", "TOB", "JDT", "ESG", "WIS", "SIR", "BAR", "LJE", "S3Y", "SUS", "BEL", "1MA", "2MA", "3MA", "4MA", "1ES", "2ES", "MAN", "PS2", "ODA", "PSS", "EZA", "5EZ", "6EZ", "DAG", "PS3", "2BA", "LBA", "JUB", "ENO", "1MQ", "2MQ", "3MQ", "REP", "4BA", "LAO" ], "description": "IDs for books. Follows the USFM standard (https://ubsicap.github.io/usfm/identification/books.html)" }, "ApiAvailableTranslations": { "type": "object", "properties": { "translations": { "type": "array", "items": { "$ref": "#/components/schemas/ApiTranslation" }, "description": "The list of translations that are available in the API." } }, "required": [ "translations" ], "additionalProperties": false, "description": "The list of available translations. Maps to the /api/available-translations.json endpoint." }, "ApiTranslation": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the translation." }, "name": { "type": "string", "description": "The name of the translation." }, "website": { "type": "string", "description": "The website for the translation." }, "licenseUrl": { "type": "string", "description": "The URL that the license for the translation can be found." }, "licenseNotes": { "description": "The API-added notes for the license.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "licenseNotice": { "description": "The notice that should be displayed when displaying content from the translation.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "license": { "description": "The structured license terms that were detected for the translation, if any.", "anyOf": [ { "$ref": "#/components/schemas/License" }, { "type": "null" } ] }, "shortName": { "description": "The short name for the translation.", "type": "string" }, "englishName": { "type": "string", "description": "The English name for the translation." }, "language": { "type": "string", "description": "The ISO 639 3-letter language tag that the translation is primarily in." }, "textDirection": { "type": "string", "enum": [ "ltr", "rtl" ], "description": "The direction that the language is written in. `ltr` indicates that the text is written from the left side of the page to the right. `rtl` indicates that the text is written from the right side of the page to the left." }, "listOfBooksApiLink": { "type": "string", "description": "The API link for the list of books for this translation. Relative to the API origin." }, "availableFormats": { "type": "array", "items": { "type": "string", "enum": [ "json", "usfm" ] } }, "numberOfBooks": { "type": "number", "description": "The number of books that are contained in this translation. Complete translations should have the same number of books as the Bible (66)." }, "totalNumberOfChapters": { "type": "number", "description": "The total number of chapters that are contained in this translation. Complete translations should have the same number of chapters as the Bible (1,189)." }, "totalNumberOfVerses": { "type": "number", "description": "The total number of verses that are contained in this translation. Complete translations should have the same number of verses as the Bible (around 31,102 - some translations exclude verses based on the aparent likelyhood of existing in the original source texts)." }, "numberOfApocryphalBooks": { "description": "The total number of apocryphal books that are contained in this translation.", "type": "number" }, "totalNumberOfApocryphalChapters": { "description": "The total number of apocryphal chapters that are contained in this translation.", "type": "number" }, "totalNumberOfApocryphalVerses": { "description": "The total number of apocryphal verses that are contained in this translation.", "type": "number" }, "languageName": { "description": "Gets the name of the language that the translation is in. Null or undefined if the name of the language is not known.", "type": "string" }, "languageEnglishName": { "description": "Gets the name of the language in English. Null or undefined if the language doesn't have an english name.", "type": "string" }, "completeTranslationApiLink": { "description": "The API link for downloading the complete translation as a single JSON file. Relative to the API origin. Undefined if complete translation files are not available.", "type": "string" }, "simpleCompleteTranslationApiLink": { "description": "The API link for downloading the complete translation as a single JSON file, using the simplified chapter format. Relative to the API origin. Undefined if complete translation files are not available.", "type": "string" } }, "required": [ "id", "name", "website", "licenseUrl", "englishName", "language", "textDirection", "listOfBooksApiLink", "availableFormats", "numberOfBooks", "totalNumberOfChapters", "totalNumberOfVerses" ], "additionalProperties": false, "description": "Defines a translation that is used in the API." }, "License": { "type": "object", "properties": { "attribution": { "type": "string", "enum": [ "required", "not-required" ], "description": "Whether attribution to the original source is required when using the translation." }, "commercialUse": { "type": "string", "enum": [ "allowed", "not-allowed" ], "description": "Whether commercial use of the translation is allowed." }, "derivatives": { "type": "string", "enum": [ "allowed", "not-allowed" ], "description": "Whether creating and distributing derivative works of the translation is allowed." }, "copyleft": { "type": "boolean", "description": "Whether derivative works must be distributed under the same license (i.e. a \"share-alike\" requirement)." }, "publicDomain": { "type": "boolean", "description": "Whether the translation has been dedicated to the public domain." } }, "required": [ "attribution", "commercialUse", "derivatives", "copyleft", "publicDomain" ], "additionalProperties": false, "description": "Defines the structured license terms that were detected for a translation." }, "ApiTranslationBooks": { "type": "object", "properties": { "translation": { "description": "The translation information for the books.", "$ref": "#/components/schemas/ApiTranslation" }, "books": { "type": "array", "items": { "$ref": "#/components/schemas/ApiTranslationBook" }, "description": "The list of books that are available for the translation." } }, "required": [ "translation", "books" ], "additionalProperties": false, "description": "Defines an interface that contains information about the books that are available for a translation." }, "ApiTranslationBook": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/BookId" }, "name": { "type": "string", "description": "The name that the translation provided for the book." }, "commonName": { "type": "string", "description": "The common name for the book." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The title of the book. This is usually a more descriptive version of the book name. If not available, then one was not provided by the translation." }, "order": { "type": "number", "description": "The numerical order of the book in the translation." }, "isApocryphal": { "description": "Whether the book is an apocryphal book.", "type": "boolean" }, "firstChapterNumber": { "type": "number", "description": "The number of the first chapter in the book." }, "firstChapterApiLink": { "type": "string", "description": "The link to the first chapter of the book." }, "firstChapterReference": { "$ref": "#/components/schemas/TranslationChapterReference" }, "lastChapterNumber": { "type": "number", "description": "The number of the last chapter in the book." }, "lastChapterApiLink": { "type": "string", "description": "The link to the last chapter of the book." }, "lastChapterReference": { "$ref": "#/components/schemas/TranslationChapterReference" }, "numberOfChapters": { "type": "number", "description": "The number of chapters that the book contains." }, "totalNumberOfVerses": { "type": "number", "description": "The number of verses that the book contains." } }, "required": [ "id", "name", "commonName", "title", "order", "firstChapterNumber", "firstChapterApiLink", "firstChapterReference", "lastChapterNumber", "lastChapterApiLink", "lastChapterReference", "numberOfChapters", "totalNumberOfVerses" ], "additionalProperties": false, "description": "Defines a schema that contains information about a translation book." }, "TranslationChapterReference": { "type": "object", "properties": { "translationId": { "type": "string", "description": "The ID of the translation that the chapter reference is for." }, "book": { "$ref": "#/components/schemas/BookId" }, "chapter": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "The chapter number of the chapter reference." } }, "required": [ "translationId", "book", "chapter" ], "additionalProperties": false, "description": "Defines a reference to a chapter in a translation." }, "ApiTranslationBookChapter": { "type": "object", "properties": { "chapter": { "description": "The information for the chapter.", "type": "object", "properties": { "number": { "type": "number", "description": "The number of the chapter." }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/ChapterContent" }, "description": "The content of the chapter." }, "footnotes": { "type": "array", "items": { "$ref": "#/components/schemas/ChapterFootnote" }, "description": "The list of footnotes for the chapter." } }, "required": [ "number", "content", "footnotes" ], "additionalProperties": false }, "thisChapterAudioLinks": { "description": "The links to different audio versions for the chapter.", "$ref": "#/components/schemas/TranslationBookChapterAudioLinks" }, "thisChapterAudioTimings": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" }, "description": "The links to the audio timings for different audio versions for the chapter. Relative to the API origin." }, "translation": { "description": "The translation information for the book chapter.", "$ref": "#/components/schemas/ApiTranslation" }, "book": { "description": "The book information for the book chapter.", "$ref": "#/components/schemas/ApiTranslationBook" }, "thisChapterLink": { "type": "string", "description": "The API link for this chapter. Relative to the API origin." }, "thisChapterReference": { "$ref": "#/components/schemas/TranslationChapterReference" }, "nextChapterApiLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The API link to the next chapter. Relative to the API origin. Null if this is the last chapter in the translation." }, "nextChapterReference": { "anyOf": [ { "$ref": "#/components/schemas/TranslationChapterReference" }, { "type": "null" } ], "description": "The reference for the next chapter. Null if this is the last chapter in the translation." }, "nextChapterAudioLinks": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, { "type": "null" } ], "description": "The links to the audio versions for the next chapter. Relative to the API origin. Null if this is the last chapter in the translation." }, "nextChapterAudioTimings": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, { "type": "null" } ], "description": "The links to the audio timings for different audio versions for the next chapter. Relative to the API origin. Null if this is the last chapter in the translation." }, "previousChapterAudioTimings": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, { "type": "null" } ], "description": "The links to the audio timings for different audio versions for the previous chapter. Relative to the API origin. Null if this is the first chapter in the translation." }, "previousChapterApiLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The API link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the translation." }, "previousChapterReference": { "anyOf": [ { "$ref": "#/components/schemas/TranslationChapterReference" }, { "type": "null" } ], "description": "The reference for the previous chapter. Null if this is the first chapter in the translation." }, "previousChapterAudioLinks": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, { "type": "null" } ], "description": "The links to the audio versions for the previous chapter. Relative to the API origin. Null if this is the first chapter in the translation." }, "thisChapterWordsLink": { "description": "The link to the word-level annotations for this chapter. Relative to the API origin. Omitted if the chapter doesn't have any word-level annotations.", "type": "string" }, "nextChapterWordsLink": { "description": "The link to the word-level annotations for the next chapter. Relative to the API origin. Omitted if this is the last chapter in the translation, or if the next chapter doesn't have any word-level annotations.", "type": "string" }, "previousChapterWordsLink": { "description": "The link to the word-level annotations for the previous chapter. Relative to the API origin. Omitted if this is the first chapter in the translation, or if the previous chapter doesn't have any word-level annotations.", "type": "string" }, "numberOfVerses": { "type": "number", "description": "The number of verses that the chapter contains." }, "simpleChapterApiLink": { "description": "The API link to the simplified version of this chapter. Relative to the API origin. Omitted if simplified chapters are not available.", "type": "string" } }, "required": [ "chapter", "thisChapterAudioLinks", "thisChapterAudioTimings", "translation", "book", "thisChapterLink", "thisChapterReference", "nextChapterApiLink", "nextChapterReference", "nextChapterAudioLinks", "nextChapterAudioTimings", "previousChapterAudioTimings", "previousChapterApiLink", "previousChapterReference", "previousChapterAudioLinks", "numberOfVerses" ], "additionalProperties": false, "description": "Defines an interface that contains information about a book chapter in a translation." }, "ChapterContent": { "oneOf": [ { "$ref": "#/components/schemas/ChapterHeading" }, { "$ref": "#/components/schemas/ChapterLineBreak" }, { "$ref": "#/components/schemas/ChapterVerse" }, { "$ref": "#/components/schemas/ChapterHebrewSubtitle" } ], "description": "Defines a union type that represents a single piece of chapter content. A piece of chapter content can be one of the following things: A heading, a line break, a verse, or a Hebrew Subtitle.", "type": "object", "discriminator": { "propertyName": "type", "mapping": { "heading": "#/components/schemas/ChapterHeading", "line_break": "#/components/schemas/ChapterLineBreak", "verse": "#/components/schemas/ChapterVerse", "hebrew_subtitle": "#/components/schemas/ChapterHebrewSubtitle" } } }, "ChapterHeading": { "type": "object", "properties": { "type": { "type": "string", "const": "heading" }, "content": { "type": "array", "items": { "type": "string" }, "description": "The content for the heading. If multiple strings are included in the array, they should be concatenated with a space." } }, "required": [ "type", "content" ], "additionalProperties": false, "description": "Defines the schema for a heading in a chapter." }, "ChapterLineBreak": { "type": "object", "properties": { "type": { "type": "string", "const": "line_break" } }, "required": [ "type" ], "additionalProperties": false, "description": "Defines the schema for a line break in a chapter." }, "ChapterVerse": { "type": "object", "properties": { "type": { "type": "string", "const": "verse" }, "number": { "type": "number", "description": "The number of the verse." }, "content": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/FormattedText" }, { "$ref": "#/components/schemas/InlineHeading" }, { "$ref": "#/components/schemas/InlineLineBreak" }, { "$ref": "#/components/schemas/VerseFootnoteReference" } ] }, "description": "The list of content for the verse. Each element in the list could be a string, formatted text, or a footnote reference." } }, "required": [ "type", "number", "content" ], "additionalProperties": false, "description": "Defines the schema for a verse in a chapter." }, "FormattedText": { "type": "object", "properties": { "text": { "type": "string", "description": "The text that is formatted." }, "poem": { "description": "Whether the text represents a poem. The number indicates the level of indent. Common in Psalms.", "type": "number" }, "wordsOfJesus": { "description": "Whether the text represents the Words of Jesus.", "type": "boolean" } }, "required": [ "text" ], "additionalProperties": false, "description": "Defines the schema for formatted text. That is, text that is formatted in a particular manner." }, "InlineHeading": { "type": "object", "properties": { "heading": { "type": "string", "description": "The text of the heading." } }, "required": [ "heading" ], "additionalProperties": false, "description": "Defines the schema for a heading that is embedded in a verse." }, "InlineLineBreak": { "type": "object", "properties": { "lineBreak": { "type": "boolean", "const": true } }, "required": [ "lineBreak" ], "additionalProperties": false, "description": "Defines the schema for a line break that is embedded in a verse." }, "VerseFootnoteReference": { "type": "object", "properties": { "noteId": { "type": "number", "description": "The ID of the note." } }, "required": [ "noteId" ], "additionalProperties": false, "description": "Defines the schema for a footnote reference in a verse or a Hebrew Subtitle." }, "ChapterHebrewSubtitle": { "type": "object", "properties": { "type": { "type": "string", "const": "hebrew_subtitle" }, "content": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/FormattedText" }, { "$ref": "#/components/schemas/VerseFootnoteReference" } ] }, "description": "The content that is contained in the subtitle. Each element in the list could be a string, formatted text, or a footnote reference." } }, "required": [ "type", "content" ], "additionalProperties": false, "description": "Defines the schema for a Hebrew Subtitle in a chapter." }, "ChapterFootnote": { "type": "object", "properties": { "noteId": { "type": "number", "description": "The ID of the note that is referenced." }, "text": { "type": "string", "description": "The text of the footnote." }, "reference": { "description": "The verse reference for the footnote. Undefined if the footnote isn't associated with a specific verse.", "type": "object", "properties": { "chapter": { "type": "number" }, "verse": { "type": "number" } }, "required": [ "chapter", "verse" ], "additionalProperties": false }, "caller": { "anyOf": [ { "type": "string", "const": "+" }, { "type": "string" }, { "type": "null" } ], "description": "The caller that should be used for the footnote. For footnotes, a \"caller\" is the character that is used in the text to reference to footnote. For example, in the text: Hello (a) World ---- (a) This is a footnote. The \"(a)\" is the caller. If \"+\", then the caller should be autogenerated. If null, then the caller should be empty. If a string, then the caller should be that string." } }, "required": [ "noteId", "text", "caller" ], "additionalProperties": false, "description": "Defines the schema for information about a footnote." }, "TranslationBookChapterAudioLinks": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" }, "description": "Defines the schema for the audio links for a book chapter." }, "ApiSimpleTranslationBookChapter": { "type": "object", "properties": { "thisChapterAudioLinks": { "description": "The links to different audio versions for the chapter.", "$ref": "#/components/schemas/TranslationBookChapterAudioLinks" }, "thisChapterAudioTimings": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" }, "description": "The links to the audio timings for different audio versions for the chapter. Relative to the API origin." }, "translation": { "description": "The translation information for the book chapter.", "$ref": "#/components/schemas/ApiTranslation" }, "book": { "description": "The book information for the book chapter.", "$ref": "#/components/schemas/ApiTranslationBook" }, "thisChapterLink": { "type": "string", "description": "The API link for this chapter. Relative to the API origin." }, "thisChapterReference": { "$ref": "#/components/schemas/TranslationChapterReference" }, "nextChapterApiLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The API link to the next chapter. Relative to the API origin. Null if this is the last chapter in the translation." }, "nextChapterReference": { "anyOf": [ { "$ref": "#/components/schemas/TranslationChapterReference" }, { "type": "null" } ], "description": "The reference for the next chapter. Null if this is the last chapter in the translation." }, "nextChapterAudioLinks": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, { "type": "null" } ], "description": "The links to the audio versions for the next chapter. Relative to the API origin. Null if this is the last chapter in the translation." }, "nextChapterAudioTimings": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, { "type": "null" } ], "description": "The links to the audio timings for different audio versions for the next chapter. Relative to the API origin. Null if this is the last chapter in the translation." }, "previousChapterAudioTimings": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, { "type": "null" } ], "description": "The links to the audio timings for different audio versions for the previous chapter. Relative to the API origin. Null if this is the first chapter in the translation." }, "previousChapterApiLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The API link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the translation." }, "previousChapterReference": { "anyOf": [ { "$ref": "#/components/schemas/TranslationChapterReference" }, { "type": "null" } ], "description": "The reference for the previous chapter. Null if this is the first chapter in the translation." }, "previousChapterAudioLinks": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, { "type": "null" } ], "description": "The links to the audio versions for the previous chapter. Relative to the API origin. Null if this is the first chapter in the translation." }, "thisChapterWordsLink": { "description": "The link to the word-level annotations for this chapter. Relative to the API origin. Omitted if the chapter doesn't have any word-level annotations.", "type": "string" }, "nextChapterWordsLink": { "description": "The link to the word-level annotations for the next chapter. Relative to the API origin. Omitted if this is the last chapter in the translation, or if the next chapter doesn't have any word-level annotations.", "type": "string" }, "previousChapterWordsLink": { "description": "The link to the word-level annotations for the previous chapter. Relative to the API origin. Omitted if this is the first chapter in the translation, or if the previous chapter doesn't have any word-level annotations.", "type": "string" }, "numberOfVerses": { "type": "number", "description": "The number of verses that the chapter contains." }, "chapter": { "description": "The simplified information for the chapter. Each verse contains a single text string, and the footnotes and formatting are represented by offsets into that string.", "$ref": "#/components/schemas/SimpleChapterData" }, "fullChapterApiLink": { "type": "string", "description": "The API link to the regular (non-simplified) version of this chapter. Relative to the API origin." } }, "required": [ "thisChapterAudioLinks", "thisChapterAudioTimings", "translation", "book", "thisChapterLink", "thisChapterReference", "nextChapterApiLink", "nextChapterReference", "nextChapterAudioLinks", "nextChapterAudioTimings", "previousChapterAudioTimings", "previousChapterApiLink", "previousChapterReference", "previousChapterAudioLinks", "numberOfVerses", "chapter", "fullChapterApiLink" ], "additionalProperties": false, "description": "Defines an interface that contains information about a book chapter in a translation, using the simplified chapter format." }, "SimpleChapterData": { "type": "object", "properties": { "number": { "type": "number", "description": "The number of the chapter." }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleChapterContent" }, "description": "The content of the chapter." }, "footnotes": { "type": "array", "items": { "$ref": "#/components/schemas/ChapterFootnote" }, "description": "The list of footnotes that could not be associated with a verse. Footnotes that belong to a verse are included on the verse itself, so this list is usually empty." } }, "required": [ "number", "content", "footnotes" ], "additionalProperties": false, "description": "Defines the schema for the data in a simplified chapter. Unlike the regular chapter format, each verse contains a single text string and the footnotes/formatting are represented by offsets into that string." }, "SimpleChapterContent": { "oneOf": [ { "$ref": "#/components/schemas/SimpleChapterHeading" }, { "$ref": "#/components/schemas/ChapterLineBreak" }, { "$ref": "#/components/schemas/SimpleChapterVerse" }, { "$ref": "#/components/schemas/SimpleChapterHebrewSubtitle" } ], "description": "Defines a union type that represents a single piece of content in a simplified chapter. A piece of chapter content can be one of the following things: A heading, a line break, a verse, or a Hebrew Subtitle.", "type": "object", "discriminator": { "propertyName": "type", "mapping": { "heading": "#/components/schemas/SimpleChapterHeading", "line_break": "#/components/schemas/ChapterLineBreak", "verse": "#/components/schemas/SimpleChapterVerse", "hebrew_subtitle": "#/components/schemas/SimpleChapterHebrewSubtitle" } } }, "SimpleChapterHeading": { "type": "object", "properties": { "type": { "type": "string", "const": "heading" }, "text": { "type": "string", "description": "The text of the heading." } }, "required": [ "type", "text" ], "additionalProperties": false, "description": "Defines the schema for a heading in a simplified chapter." }, "SimpleChapterVerse": { "type": "object", "properties": { "type": { "type": "string", "const": "verse" }, "number": { "type": "number", "description": "The number of the verse." }, "text": { "type": "string", "description": "The text of the verse. Lines of poetry and line breaks are separated by newline (\\n) characters." }, "footnotes": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleVerseFootnote" }, "description": "The footnotes that occur in the verse." }, "headings": { "description": "The headings that occur in the middle of the verse. Omitted if the verse contains no inline headings.", "type": "array", "items": { "$ref": "#/components/schemas/SimpleInlineHeading" } }, "wordsOfJesus": { "description": "The ranges of the verse text that represent the Words of Jesus. Omitted if the verse contains none.", "type": "array", "items": { "$ref": "#/components/schemas/SimpleTextRange" } }, "poem": { "description": "The ranges of the verse text that represent lines of poetry. Omitted if the verse contains none.", "type": "array", "items": { "$ref": "#/components/schemas/SimplePoemRange" } } }, "required": [ "type", "number", "text", "footnotes" ], "additionalProperties": false, "description": "Defines the schema for a verse in a simplified chapter." }, "SimpleVerseFootnote": { "type": "object", "properties": { "noteId": { "type": "number", "description": "The ID of the note." }, "offset": { "type": "number", "description": "The index in the verse text that the footnote caller should be inserted at. Measured in UTF-16 code units." }, "text": { "type": "string", "description": "The text of the footnote." }, "caller": { "anyOf": [ { "type": "string", "const": "+" }, { "type": "string" }, { "type": "null" } ], "description": "The caller that should be used for the footnote. If \"+\", then the caller should be autogenerated. If null, then the caller should be empty. If a string, then the caller should be that string." } }, "required": [ "noteId", "offset", "text", "caller" ], "additionalProperties": false, "description": "Defines the schema for a footnote in a simplified verse. Unlike the footnotes in the regular chapter format, simplified footnotes include the position that they occur at in the verse text." }, "SimpleInlineHeading": { "type": "object", "properties": { "offset": { "type": "number", "description": "The index in the verse text that the heading occurs at. Measured in UTF-16 code units." }, "text": { "type": "string", "description": "The text of the heading." } }, "required": [ "offset", "text" ], "additionalProperties": false, "description": "Defines the schema for a heading that is embedded in a simplified verse." }, "SimpleTextRange": { "type": "object", "properties": { "start": { "type": "number", "description": "The index of the first character of the range in the verse text. Measured in UTF-16 code units." }, "end": { "type": "number", "description": "The index after the last character of the range in the verse text. Measured in UTF-16 code units." } }, "required": [ "start", "end" ], "additionalProperties": false, "description": "Defines the schema for a range of text inside a simplified verse. Ranges are expressed as offsets into the text of the verse that contains them, measured in UTF-16 code units." }, "SimplePoemRange": { "type": "object", "properties": { "start": { "type": "number", "description": "The index of the first character of the range in the verse text. Measured in UTF-16 code units." }, "end": { "type": "number", "description": "The index after the last character of the range in the verse text. Measured in UTF-16 code units." }, "level": { "type": "number", "description": "The level of indent that the line of poetry should be displayed with." } }, "required": [ "start", "end", "level" ], "additionalProperties": false, "description": "Defines the schema for a range of text inside a simplified verse that represents a line of poetry." }, "SimpleChapterHebrewSubtitle": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the verse. Lines of poetry and line breaks are separated by newline (\\n) characters." }, "footnotes": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleVerseFootnote" }, "description": "The footnotes that occur in the verse." }, "headings": { "description": "The headings that occur in the middle of the verse. Omitted if the verse contains no inline headings.", "type": "array", "items": { "$ref": "#/components/schemas/SimpleInlineHeading" } }, "wordsOfJesus": { "description": "The ranges of the verse text that represent the Words of Jesus. Omitted if the verse contains none.", "type": "array", "items": { "$ref": "#/components/schemas/SimpleTextRange" } }, "poem": { "description": "The ranges of the verse text that represent lines of poetry. Omitted if the verse contains none.", "type": "array", "items": { "$ref": "#/components/schemas/SimplePoemRange" } }, "type": { "type": "string", "const": "hebrew_subtitle" } }, "required": [ "text", "footnotes", "type" ], "additionalProperties": false, "description": "Defines the schema for a Hebrew Subtitle in a simplified chapter." }, "ApiTranslationBookChapterAudioTimings": { "type": "object", "properties": { "translationId": { "type": "string", "description": "The ID of the translation." }, "bookId": { "type": "string", "description": "The ID of the book." }, "chapterNumber": { "type": "number", "description": "The number of the chapter." }, "reader": { "type": "string", "description": "The reader for the chapter." }, "audioLink": { "type": "string", "description": "The link to the audio for these timings." }, "thisChapterLink": { "type": "string", "description": "The link to the information for this chapter." }, "nextChapterLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The link to the information for the next chapter. Null if this is the last chapter in the translation." }, "previousChapterLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The link to the information for the previous chapter. Null if this is the first chapter in the translation." }, "thisChapterAudioTimingsLink": { "type": "string", "description": "The link to this audio timings file." }, "nextChapterAudioTimingsLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The link to the timings for the next chapter. Null if this is the last chapter in the translation." }, "previousChapterAudioTimingsLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The link to the timings for the previous chapter. Null if this is the first chapter in the translation." }, "verses": { "type": "array", "items": { "type": "number" }, "description": "The times in seconds at which each verse starts, in order. The first number (index 0) is the time in the recording at which the first verse starts." } }, "required": [ "translationId", "bookId", "chapterNumber", "reader", "audioLink", "thisChapterLink", "nextChapterLink", "previousChapterLink", "thisChapterAudioTimingsLink", "nextChapterAudioTimingsLink", "previousChapterAudioTimingsLink", "verses" ], "additionalProperties": false, "description": "Defines an interface that contains the audio timings for a book chapter, for a specific reader." }, "ApiTranslationBookChapterWords": { "type": "object", "properties": { "translationId": { "type": "string", "description": "The ID of the translation." }, "bookId": { "type": "string", "description": "The ID of the book." }, "chapterNumber": { "type": "number", "description": "The number of the chapter." }, "thisChapterLink": { "type": "string", "description": "The link to the information for this chapter." }, "nextChapterLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The link to the information for the next chapter. Null if this is the last chapter in the translation." }, "previousChapterLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The link to the information for the previous chapter. Null if this is the first chapter in the translation." }, "thisChapterWordsLink": { "type": "string", "description": "The link to this words file." }, "nextChapterWordsLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The link to the words for the next chapter. Null if this is the last chapter in the translation, or if the next chapter doesn't have any word-level annotations." }, "previousChapterWordsLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The link to the words for the previous chapter. Null if this is the first chapter in the translation, or if the previous chapter doesn't have any word-level annotations." }, "verses": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ChapterWord" } }, "description": "The annotated words for each verse in the chapter, keyed by verse number. Each list is in the order that the words occur in the verse." } }, "required": [ "translationId", "bookId", "chapterNumber", "thisChapterLink", "nextChapterLink", "previousChapterLink", "thisChapterWordsLink", "nextChapterWordsLink", "previousChapterWordsLink", "verses" ], "additionalProperties": false, "description": "Defines an interface that contains the word-level annotations for a book chapter." }, "ChapterWord": { "type": "object", "properties": { "contentIndex": { "type": "number", "description": "The index of the item in the verse's content array that the annotation applies to." }, "start": { "type": "number", "description": "The index of the first character of the annotated word in the content item's text." }, "end": { "type": "number", "description": "The index after the last character of the annotated word in the content item's text. That is, text.slice(start, end) is the annotated word." }, "strongs": { "description": "The Strong's number(s) for the word. Omitted if the translation only provided other annotations for the word.", "type": "array", "items": { "type": "string" } }, "lemma": { "description": "The dictionary (citation) form of the word. Omitted if the translation did not provide one.", "type": "string" }, "morph": { "description": "The morphology parse code for the word. Omitted if the translation did not provide one.", "type": "string" }, "srcloc": { "description": "The pointer to the word in the source text, in the : format. Omitted if the translation did not provide one.", "type": "string" }, "occurrence": { "description": "Which occurrence of the source word this word is. 1-based. Omitted if the translation did not provide one.", "type": "number" }, "occurrences": { "description": "The total number of times that the source word occurs. Omitted if the translation did not provide one.", "type": "number" } }, "required": [ "contentIndex", "start", "end" ], "additionalProperties": false, "description": "Defines the schema for a word-level annotation in a chapter. The annotation is anchored to a range of characters in a single item of a verse's content." }, "ApiSimpleTranslationBookChapterWords": { "type": "object", "properties": { "translationId": { "type": "string", "description": "The ID of the translation." }, "bookId": { "type": "string", "description": "The ID of the book." }, "chapterNumber": { "type": "number", "description": "The number of the chapter." }, "thisChapterLink": { "type": "string", "description": "The link to the information for this chapter." }, "nextChapterLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The link to the information for the next chapter. Null if this is the last chapter in the translation." }, "previousChapterLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The link to the information for the previous chapter. Null if this is the first chapter in the translation." }, "thisChapterWordsLink": { "type": "string", "description": "The link to this words file." }, "nextChapterWordsLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The link to the words for the next chapter. Null if this is the last chapter in the translation, or if the next chapter doesn't have any word-level annotations." }, "previousChapterWordsLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The link to the words for the previous chapter. Null if this is the first chapter in the translation, or if the previous chapter doesn't have any word-level annotations." }, "verses": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleChapterWord" } }, "description": "The annotated words for each verse in the chapter, keyed by verse number. Each list is in the order that the words occur in the verse. The offsets are into the text of the simplified verse." } }, "required": [ "translationId", "bookId", "chapterNumber", "thisChapterLink", "nextChapterLink", "previousChapterLink", "thisChapterWordsLink", "nextChapterWordsLink", "previousChapterWordsLink", "verses" ], "additionalProperties": false, "description": "Defines an interface that contains the word-level annotations for a book chapter, with their offsets remapped onto the text of each simplified verse." }, "SimpleChapterWord": { "type": "object", "properties": { "start": { "type": "number", "description": "The index of the first character of the annotated word in the content item's text." }, "end": { "type": "number", "description": "The index after the last character of the annotated word in the content item's text. That is, text.slice(start, end) is the annotated word." }, "strongs": { "description": "The Strong's number(s) for the word. Omitted if the translation only provided other annotations for the word.", "type": "array", "items": { "type": "string" } }, "lemma": { "description": "The dictionary (citation) form of the word. Omitted if the translation did not provide one.", "type": "string" }, "morph": { "description": "The morphology parse code for the word. Omitted if the translation did not provide one.", "type": "string" }, "srcloc": { "description": "The pointer to the word in the source text, in the : format. Omitted if the translation did not provide one.", "type": "string" }, "occurrence": { "description": "Which occurrence of the source word this word is. 1-based. Omitted if the translation did not provide one.", "type": "number" }, "occurrences": { "description": "The total number of times that the source word occurs. Omitted if the translation did not provide one.", "type": "number" } }, "required": [ "start", "end" ], "additionalProperties": false, "description": "Defines the schema for a word-level annotation in a simplified chapter. The annotation is anchored to a range of characters in the verse's text." }, "ApiTranslationComplete": { "type": "object", "properties": { "translation": { "description": "The translation metadata.", "$ref": "#/components/schemas/ApiTranslation" }, "books": { "type": "array", "items": { "$ref": "#/components/schemas/ApiTranslationCompleteBook" }, "description": "The complete list of books with all their chapters." } }, "required": [ "translation", "books" ], "additionalProperties": false, "description": "Defines the complete translation download data. Maps to the /api/:translationId/complete.json endpoint." }, "ApiTranslationCompleteBook": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/BookId" }, "name": { "type": "string", "description": "The name that the translation provided for the book." }, "commonName": { "type": "string", "description": "The common name for the book." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The title of the book. This is usually a more descriptive version of the book name. If not available, then one was not provided by the translation." }, "order": { "type": "number", "description": "The numerical order of the book in the translation." }, "isApocryphal": { "description": "Whether the book is an apocryphal book.", "type": "boolean" }, "numberOfChapters": { "type": "number", "description": "The number of chapters in the book." }, "totalNumberOfVerses": { "type": "number", "description": "The total number of verses in the book." }, "chapters": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationCompleteChapter" }, "description": "The complete list of chapters with all content." } }, "required": [ "id", "name", "commonName", "title", "order", "numberOfChapters", "totalNumberOfVerses", "chapters" ], "additionalProperties": false, "description": "A book in the complete translation download." }, "TranslationCompleteChapter": { "type": "object", "properties": { "chapter": { "description": "The information for the chapter.", "type": "object", "properties": { "number": { "type": "number", "description": "The number of the chapter." }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/ChapterContent" }, "description": "The content of the chapter." }, "footnotes": { "type": "array", "items": { "$ref": "#/components/schemas/ChapterFootnote" }, "description": "The list of footnotes for the chapter." } }, "required": [ "number", "content", "footnotes" ], "additionalProperties": false }, "thisChapterAudioLinks": { "description": "The links to different audio versions for the chapter.", "$ref": "#/components/schemas/TranslationBookChapterAudioLinks" }, "thisChapterAudioTimings": { "description": "The audio timings (per-verse start times, in seconds) for different audio versions for the chapter.", "$ref": "#/components/schemas/TranslationBookChapterAudioTimings" }, "numberOfVerses": { "type": "number", "description": "The number of verses that the chapter contains." }, "thisChapterWordsLink": { "description": "The link to the word-level annotations for this chapter. Relative to the API origin. Omitted if the chapter doesn't have any word-level annotations.", "type": "string" } }, "required": [ "chapter", "thisChapterAudioLinks", "thisChapterAudioTimings", "numberOfVerses" ], "additionalProperties": false, "description": "A chapter in the complete translation download." }, "TranslationBookChapterAudioTimings": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "number" } }, "description": "Defines the schema for the audio timings for a book chapter. Maps a reader ID to the list of times (in seconds) that each verse starts, in verse order." }, "ApiSimpleTranslationComplete": { "type": "object", "properties": { "translation": { "description": "The translation metadata.", "$ref": "#/components/schemas/ApiTranslation" }, "books": { "type": "array", "items": { "$ref": "#/components/schemas/ApiSimpleTranslationCompleteBook" }, "description": "The complete list of books with all their chapters." } }, "required": [ "translation", "books" ], "additionalProperties": false, "description": "Defines the complete translation download data, using the simplified chapter format. Maps to the /api/:translationId/complete.simple.json endpoint." }, "ApiSimpleTranslationCompleteBook": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/BookId" }, "name": { "type": "string", "description": "The name that the translation provided for the book." }, "commonName": { "type": "string", "description": "The common name for the book." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The title of the book. This is usually a more descriptive version of the book name. If not available, then one was not provided by the translation." }, "order": { "type": "number", "description": "The numerical order of the book in the translation." }, "isApocryphal": { "description": "Whether the book is an apocryphal book.", "type": "boolean" }, "numberOfChapters": { "type": "number", "description": "The number of chapters in the book." }, "totalNumberOfVerses": { "type": "number", "description": "The total number of verses in the book." }, "chapters": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleTranslationCompleteChapter" }, "description": "The complete list of chapters with all content." } }, "required": [ "id", "name", "commonName", "title", "order", "numberOfChapters", "totalNumberOfVerses", "chapters" ], "additionalProperties": false, "description": "A book in the complete translation download, using the simplified chapter format." }, "SimpleTranslationCompleteChapter": { "type": "object", "properties": { "chapter": { "description": "The simplified information for the chapter.", "$ref": "#/components/schemas/SimpleChapterData" }, "thisChapterAudioLinks": { "description": "The links to different audio versions for the chapter.", "$ref": "#/components/schemas/TranslationBookChapterAudioLinks" }, "thisChapterAudioTimings": { "description": "The audio timings (per-verse start times, in seconds) for different audio versions for the chapter.", "$ref": "#/components/schemas/TranslationBookChapterAudioTimings" }, "numberOfVerses": { "type": "number", "description": "The number of verses that the chapter contains." }, "thisChapterWordsLink": { "description": "The link to the word-level annotations for this chapter. Relative to the API origin. Omitted if the chapter doesn't have any word-level annotations.", "type": "string" } }, "required": [ "chapter", "thisChapterAudioLinks", "thisChapterAudioTimings", "numberOfVerses" ], "additionalProperties": false, "description": "A chapter in the complete translation download, using the simplified chapter format." }, "ApiAvailableCommentaries": { "type": "object", "properties": { "commentaries": { "type": "array", "items": { "$ref": "#/components/schemas/ApiCommentary" }, "description": "The list of commentaries that are available in the API." } }, "required": [ "commentaries" ], "additionalProperties": false, "description": "The list of available commentaries. Maps to the /api/available-commentaries.json endpoint." }, "ApiCommentary": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the commentary." }, "name": { "type": "string", "description": "The name of the commentary." }, "website": { "type": "string", "description": "The website for the commentary." }, "licenseUrl": { "type": "string", "description": "The URL that the license for the commentary can be found." }, "licenseNotes": { "description": "The API-added notes for the license.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "englishName": { "type": "string", "description": "The English name for the commentary." }, "language": { "type": "string", "description": "The ISO 639 3-letter language tag that the translation is primarily in." }, "textDirection": { "type": "string", "enum": [ "ltr", "rtl" ], "description": "The direction that the language is written in. `ltr` indicates that the text is written from the left side of the page to the right. `rtl` indicates that the text is written from the right side of the page to the left." }, "listOfBooksApiLink": { "type": "string", "description": "The API link for the list of books for this commentary. Relative to the API origin." }, "listOfProfilesApiLink": { "type": "string", "description": "The API link for the list of profiles for this commentary. Relative to the API origin." }, "availableFormats": { "type": "array", "items": { "type": "string", "enum": [ "json", "usfm" ] } }, "numberOfBooks": { "type": "number", "description": "The number of books that are contained in this commentary. Complete commentaries should have the same number of books as the Bible (66)." }, "totalNumberOfChapters": { "type": "number", "description": "The total number of chapters that are contained in this commentary. Complete commentaries should have the same number of chapters as the Bible (1,189)." }, "totalNumberOfVerses": { "type": "number", "description": "The total number of verses that are contained in this commentary. Complete commentaries should have the same number of verses as the Bible (around 31,102 - some commentaries exclude verses based on the aparent likelyhood of existing in the original source texts)." }, "totalNumberOfProfiles": { "type": "number", "description": "The total number of profiles that are contained in this commentary. Profiles are used to provide additional information about people and people groups that are mentioned in the Bible." }, "languageName": { "description": "Gets the name of the language that the commentary is in. Null or undefined if the name of the language is not known.", "type": "string" }, "languageEnglishName": { "description": "Gets the name of the language in English. Null or undefined if the language doesn't have an english name.", "type": "string" } }, "required": [ "id", "name", "website", "licenseUrl", "englishName", "language", "textDirection", "listOfBooksApiLink", "listOfProfilesApiLink", "availableFormats", "numberOfBooks", "totalNumberOfChapters", "totalNumberOfVerses", "totalNumberOfProfiles" ], "additionalProperties": false, "description": "Defines a commentary that is used in the API." }, "ApiCommentaryBooks": { "type": "object", "properties": { "commentary": { "description": "The commentary information for the books.", "$ref": "#/components/schemas/ApiCommentary" }, "books": { "type": "array", "items": { "$ref": "#/components/schemas/ApiCommentaryBook" }, "description": "The list of books that are available for the commentary." } }, "required": [ "commentary", "books" ], "additionalProperties": false, "description": "Defines an interface that contains information about the books that are available for a commentary." }, "ApiCommentaryBook": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/BookId" }, "name": { "type": "string", "description": "The name that the commentary provided for the book." }, "commonName": { "type": "string", "description": "The common name for the book." }, "introduction": { "description": "The commentary's introduction for the book. Undefined if the commentary didn't provide an introduction for the book.", "type": "string" }, "introductionSummary": { "description": "The summary of the commentary's introduction for the book. Undefined if the commentary didn't provide a summary for the book.", "type": "string" }, "order": { "type": "number", "description": "The order of the book in the Bible." }, "firstChapterNumber": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The number of the first chapter in the book. Null if the comentary book has no chapters." }, "firstChapterApiLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The link to the first chapter of the book. Null if the comentary book has no chapters." }, "firstChapterReference": { "anyOf": [ { "$ref": "#/components/schemas/CommentaryChapterReference" }, { "type": "null" } ], "description": "The reference for the first chapter in the book. Null if the comentary book has no chapters." }, "lastChapterNumber": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The number of the last chapter in the book. Null if the comentary book has no chapters." }, "lastChapterApiLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The link to the last chapter of the book. Null if the comentary book has no chapters." }, "lastChapterReference": { "anyOf": [ { "$ref": "#/components/schemas/CommentaryChapterReference" }, { "type": "null" } ], "description": "The reference for the last chapter in the book. Null if the comentary book has no chapters." }, "numberOfChapters": { "type": "number", "description": "The number of chapters that the book contains." }, "totalNumberOfVerses": { "type": "number", "description": "The number of verses that the book contains." } }, "required": [ "id", "name", "commonName", "order", "firstChapterNumber", "firstChapterApiLink", "firstChapterReference", "lastChapterNumber", "lastChapterApiLink", "lastChapterReference", "numberOfChapters", "totalNumberOfVerses" ], "additionalProperties": false, "description": "Defines a schema that contains information about a commentary book." }, "CommentaryChapterReference": { "type": "object", "properties": { "commentaryId": { "type": "string", "description": "The ID of the commentary that the chapter reference is for." }, "book": { "$ref": "#/components/schemas/BookId" }, "chapter": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "The chapter number of the chapter reference." } }, "required": [ "commentaryId", "book", "chapter" ], "additionalProperties": false, "description": "Defines a reference to a chapter in a commentary." }, "ApiCommentaryBookChapter": { "type": "object", "properties": { "chapter": { "description": "The information for the chapter.", "type": "object", "properties": { "number": { "type": "number", "description": "The number of the chapter." }, "introduction": { "description": "The introduction that the commentary provided to the chapter. Not all commentaries provide an introduction to a chapter.", "type": "string" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/ChapterVerse" }, "description": "The content of the chapter." } }, "required": [ "number", "content" ], "additionalProperties": false }, "commentary": { "description": "The commentary information for the book chapter.", "$ref": "#/components/schemas/ApiCommentary" }, "book": { "description": "The book information for the book chapter.", "$ref": "#/components/schemas/ApiCommentaryBook" }, "thisChapterLink": { "type": "string", "description": "The API link for this chapter. Relative to the API origin." }, "thisChapterReference": { "$ref": "#/components/schemas/CommentaryChapterReference" }, "nextChapterApiLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The API link to the next chapter. Relative to the API origin. Null if this is the last chapter in the commentary." }, "nextChapterReference": { "anyOf": [ { "$ref": "#/components/schemas/CommentaryChapterReference" }, { "type": "null" } ], "description": "The reference for the next chapter. Null if this is the last chapter in the commentary." }, "previousChapterApiLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The API link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the commentary." }, "previousChapterReference": { "anyOf": [ { "$ref": "#/components/schemas/CommentaryChapterReference" }, { "type": "null" } ], "description": "The reference for the previous chapter. Null if this is the first chapter in the commentary." }, "numberOfVerses": { "type": "number", "description": "The number of verses that the chapter contains." }, "simpleChapterApiLink": { "description": "The API link to the simplified version of this chapter. Relative to the API origin. Omitted if simplified chapters are not available.", "type": "string" } }, "required": [ "chapter", "commentary", "book", "thisChapterLink", "thisChapterReference", "nextChapterApiLink", "nextChapterReference", "previousChapterApiLink", "previousChapterReference", "numberOfVerses" ], "additionalProperties": false, "description": "Defines a schema that contains information about a book chapter in a commentary." }, "ApiSimpleCommentaryBookChapter": { "type": "object", "properties": { "commentary": { "description": "The commentary information for the book chapter.", "$ref": "#/components/schemas/ApiCommentary" }, "book": { "description": "The book information for the book chapter.", "$ref": "#/components/schemas/ApiCommentaryBook" }, "thisChapterLink": { "type": "string", "description": "The API link for this chapter. Relative to the API origin." }, "thisChapterReference": { "$ref": "#/components/schemas/CommentaryChapterReference" }, "nextChapterApiLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The API link to the next chapter. Relative to the API origin. Null if this is the last chapter in the commentary." }, "nextChapterReference": { "anyOf": [ { "$ref": "#/components/schemas/CommentaryChapterReference" }, { "type": "null" } ], "description": "The reference for the next chapter. Null if this is the last chapter in the commentary." }, "previousChapterApiLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The API link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the commentary." }, "previousChapterReference": { "anyOf": [ { "$ref": "#/components/schemas/CommentaryChapterReference" }, { "type": "null" } ], "description": "The reference for the previous chapter. Null if this is the first chapter in the commentary." }, "numberOfVerses": { "type": "number", "description": "The number of verses that the chapter contains." }, "chapter": { "description": "The simplified information for the chapter. Each verse contains a single text string, and the footnotes and formatting are represented by offsets into that string.", "$ref": "#/components/schemas/SimpleCommentaryChapterData" }, "fullChapterApiLink": { "type": "string", "description": "The API link to the regular (non-simplified) version of this chapter. Relative to the API origin." } }, "required": [ "commentary", "book", "thisChapterLink", "thisChapterReference", "nextChapterApiLink", "nextChapterReference", "previousChapterApiLink", "previousChapterReference", "numberOfVerses", "chapter", "fullChapterApiLink" ], "additionalProperties": false, "description": "Defines a schema that contains information about a book chapter in a commentary, using the simplified chapter format." }, "SimpleCommentaryChapterData": { "type": "object", "properties": { "number": { "type": "number", "description": "The number of the chapter." }, "introduction": { "description": "The introduction that the commentary provided to the chapter. Not all commentaries provide an introduction to a chapter.", "type": "string" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleChapterVerse" }, "description": "The content of the chapter." } }, "required": [ "number", "content" ], "additionalProperties": false, "description": "Defines the schema for the data in a simplified commentary chapter." }, "ApiAvailableDatasets": { "type": "object", "properties": { "datasets": { "type": "array", "items": { "$ref": "#/components/schemas/ApiDataset" }, "description": "The list of datasets that are available in the API." } }, "required": [ "datasets" ], "additionalProperties": false, "description": "The list of available datasets. Maps to the /api/available-datasets.json endpoint." }, "ApiDataset": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the dataset." }, "name": { "type": "string", "description": "The name of the dataset." }, "website": { "type": "string", "description": "The website for the dataset." }, "licenseUrl": { "type": "string", "description": "The URL that the license for the dataset can be found." }, "licenseNotes": { "description": "The API-added notes for the license.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "englishName": { "type": "string", "description": "The English name for the dataset." }, "language": { "type": "string", "description": "The ISO 639 3-letter language tag that the dataset is primarily in." }, "textDirection": { "type": "string", "enum": [ "ltr", "rtl" ], "description": "The direction that the language is written in." }, "listOfBooksApiLink": { "type": "string", "description": "The API link for the list of books for this dataset. Relative to the API origin." }, "availableFormats": { "type": "array", "items": { "type": "string", "const": "json" } }, "numberOfBooks": { "type": "number", "description": "The number of books that are contained in this dataset." }, "totalNumberOfChapters": { "type": "number", "description": "The total number of chapters that are contained in this dataset." }, "totalNumberOfVerses": { "type": "number", "description": "The total number of verses that are contained in this dataset." }, "totalNumberOfReferences": { "type": "number", "description": "The total number of references that are contained in this dataset." }, "languageName": { "description": "Gets the name of the language that the dataset is in. Null or undefined if the name of the language is not known.", "type": "string" }, "languageEnglishName": { "description": "Gets the name of the language in English. Null or undefined if the language doesn't have an english name.", "type": "string" }, "listOfPeopleApiLink": { "description": "The API link for the list of people for this dataset. Relative to the API origin. Omitted if the dataset doesn't contain people.", "type": "string" }, "listOfPlacesApiLink": { "description": "The API link for the list of places for this dataset. Relative to the API origin. Omitted if the dataset doesn't contain places.", "type": "string" }, "listOfEventsApiLink": { "description": "The API link for the list of events for this dataset. Relative to the API origin. Omitted if the dataset doesn't contain events.", "type": "string" }, "listOfPeopleGroupsApiLink": { "description": "The API link for the list of people groups for this dataset. Relative to the API origin. Omitted if the dataset doesn't contain people groups.", "type": "string" }, "totalNumberOfPeople": { "description": "The total number of people that are contained in this dataset. Omitted if the dataset doesn't contain people.", "type": "number" }, "totalNumberOfPlaces": { "description": "The total number of places that are contained in this dataset. Omitted if the dataset doesn't contain places.", "type": "number" }, "totalNumberOfEvents": { "description": "The total number of events that are contained in this dataset. Omitted if the dataset doesn't contain events.", "type": "number" }, "totalNumberOfPeopleGroups": { "description": "The total number of people groups that are contained in this dataset. Omitted if the dataset doesn't contain people groups.", "type": "number" } }, "required": [ "id", "name", "website", "licenseUrl", "englishName", "language", "textDirection", "listOfBooksApiLink", "availableFormats", "numberOfBooks", "totalNumberOfChapters", "totalNumberOfVerses", "totalNumberOfReferences" ], "additionalProperties": false, "description": "Defines a dataset that is used in the API." }, "ApiDatasetBooks": { "type": "object", "properties": { "dataset": { "description": "The dataset information for the books.", "$ref": "#/components/schemas/ApiDataset" }, "books": { "type": "array", "items": { "$ref": "#/components/schemas/ApiDatasetBook" }, "description": "The list of books that are available for the dataset." } }, "required": [ "dataset", "books" ], "additionalProperties": false, "description": "Defines an interface that contains information about the books that are available for a dataset." }, "ApiDatasetBook": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/BookId" }, "order": { "type": "number", "description": "The order of the book in the Bible." }, "firstChapterNumber": { "type": "number", "description": "The number of the first chapter in the book." }, "firstChapterApiLink": { "type": "string", "description": "The link to the first chapter of the book." }, "firstChapterReference": { "$ref": "#/components/schemas/DatasetChapterReference" }, "lastChapterNumber": { "type": "number", "description": "The number of the last chapter in the book." }, "lastChapterApiLink": { "type": "string", "description": "The link to the last chapter of the book." }, "lastChapterReference": { "$ref": "#/components/schemas/DatasetChapterReference" }, "numberOfChapters": { "type": "number", "description": "The number of chapters that the book contains." }, "totalNumberOfVerses": { "type": "number", "description": "The number of verses that the book contains." }, "totalNumberOfReferences": { "type": "number", "description": "The number of references that the book contains." } }, "required": [ "id", "order", "firstChapterNumber", "firstChapterApiLink", "firstChapterReference", "lastChapterNumber", "lastChapterApiLink", "lastChapterReference", "numberOfChapters", "totalNumberOfVerses", "totalNumberOfReferences" ], "additionalProperties": false, "description": "Defines a schema that contains information about a book in a dataset." }, "DatasetChapterReference": { "type": "object", "properties": { "datasetId": { "type": "string", "description": "The ID of the dataset that the chapter reference is for." }, "book": { "$ref": "#/components/schemas/BookId" }, "chapter": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "The chapter number of the chapter reference." } }, "required": [ "datasetId", "book", "chapter" ], "additionalProperties": false, "description": "Defines a reference to a chapter in a dataset." }, "ApiDatasetBookChapter": { "type": "object", "properties": { "chapter": { "description": "The data for the chapter.", "$ref": "#/components/schemas/DatasetChapterData" }, "dataset": { "description": "The dataset information for the book chapter.", "$ref": "#/components/schemas/ApiDataset" }, "book": { "description": "The book information for the book chapter.", "$ref": "#/components/schemas/ApiDatasetBook" }, "thisChapterLink": { "type": "string", "description": "The API link for this chapter. Relative to the API origin." }, "thisChapterReference": { "$ref": "#/components/schemas/DatasetChapterReference" }, "nextChapterApiLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The API link to the next chapter. Relative to the API origin. Null if this is the last chapter in the dataset." }, "nextChapterReference": { "anyOf": [ { "$ref": "#/components/schemas/DatasetChapterReference" }, { "type": "null" } ], "description": "The reference for the next chapter. Null if this is the last chapter in the dataset." }, "previousChapterApiLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The API link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the dataset." }, "previousChapterReference": { "anyOf": [ { "$ref": "#/components/schemas/DatasetChapterReference" }, { "type": "null" } ], "description": "The reference for the previous chapter. Null if this is the first chapter in the dataset." }, "numberOfVerses": { "type": "number", "description": "The number of verses that the chapter contains." }, "numberOfReferences": { "type": "number", "description": "The number of references that the chapter contains." } }, "required": [ "chapter", "dataset", "book", "thisChapterLink", "thisChapterReference", "nextChapterApiLink", "nextChapterReference", "previousChapterApiLink", "previousChapterReference", "numberOfVerses", "numberOfReferences" ], "additionalProperties": false, "description": "Defines a schema that contains information about a book chapter in a dataset." }, "DatasetChapterData": { "type": "object", "properties": { "number": { "type": "number", "description": "The number of the chapter." }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/DatasetChapterVerseContent" }, "description": "The content of the chapter." } }, "required": [ "number", "content" ], "additionalProperties": false, "description": "Defines the schema for information about a chapter in a dataset." }, "DatasetChapterVerseContent": { "type": "object", "properties": { "verse": { "type": "number", "description": "The number of the verse." }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/ScoredVerseRef" }, "description": "The list of references for the verse." } }, "required": [ "verse", "references" ], "additionalProperties": false, "description": "Defines the schema for information about a verse in a dataset chapter." }, "ScoredVerseRef": { "type": "object", "properties": { "book": { "$ref": "#/components/schemas/BookId" }, "chapter": { "type": "number", "description": "The chapter number that the reference starts at." }, "verse": { "type": "number", "description": "The verse number that the reference starts at." }, "content": { "description": "The rest of the content of the verse reference. This is the part of the string that comes after the verse reference. For example, in \"GEN 1:1 In the beginning, God created the Heavens and the Earth.\", the content would be \"In the beginning, God created the Heavens and the Earth.\"", "type": "string" }, "endChapter": { "description": "The chapter that the verse reference ends at. This is used for references that span multiple chapters, such as \"GEN 1:1-2:3\". In this case, the endChapter would be 2.", "type": "number" }, "endVerse": { "description": "The verse that the verse reference ends at. This is used for references that span multiple verses, such as \"GEN 1:1-1:3\". In this case, the endVerse would be 3.", "type": "number" }, "score": { "type": "number", "description": "The score for the verse reference. The meaning of the score is arbitrary and is determined by the dataset." } }, "required": [ "book", "chapter", "verse", "score" ], "additionalProperties": false, "description": "Defines the schema for information about a verse reference that has an arbitrary score attached to it." }, "ApiDatasetEntityBookChapter": { "type": "object", "properties": { "dataset": { "description": "The dataset information for the book chapter.", "$ref": "#/components/schemas/ApiDataset" }, "book": { "description": "The book information for the book chapter.", "$ref": "#/components/schemas/ApiDatasetBook" }, "chapter": { "description": "The entity data for the chapter.", "$ref": "#/components/schemas/ApiDatasetEntityChapterData" }, "thisChapterLink": { "type": "string", "description": "The link to this chapter. Relative to the API origin." }, "thisChapterReference": { "description": "The reference for this chapter.", "$ref": "#/components/schemas/DatasetChapterReference" }, "nextChapterApiLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The link to the next chapter. Relative to the API origin. Null if this is the last chapter in the dataset." }, "nextChapterReference": { "anyOf": [ { "$ref": "#/components/schemas/DatasetChapterReference" }, { "type": "null" } ], "description": "The reference for the next chapter. Null if this is the last chapter in the dataset." }, "previousChapterApiLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the dataset." }, "previousChapterReference": { "anyOf": [ { "$ref": "#/components/schemas/DatasetChapterReference" }, { "type": "null" } ], "description": "The reference for the previous chapter. Null if this is the first chapter in the dataset." }, "numberOfPeople": { "type": "number", "description": "The number of people that appear in the chapter." }, "numberOfPlaces": { "type": "number", "description": "The number of places that appear in the chapter." }, "numberOfEvents": { "type": "number", "description": "The number of events that appear in the chapter." } }, "required": [ "dataset", "book", "chapter", "thisChapterLink", "thisChapterReference", "nextChapterApiLink", "nextChapterReference", "previousChapterApiLink", "previousChapterReference", "numberOfPeople", "numberOfPlaces", "numberOfEvents" ], "additionalProperties": false, "description": "The entities (people, places, and events) that appear in a chapter of a book for a dataset. Maps to the /api/d/:datasetId/:bookId/:chapterNumber.json endpoint for datasets that contain entities." }, "ApiDatasetChapterPerson": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the person." }, "name": { "type": "string", "description": "The name of the person." }, "isProperName": { "description": "Whether the name of the person is a proper name.", "type": "boolean" }, "gender": { "description": "The gender of the person.", "type": "string" }, "birthYear": { "description": "The year that the person was born. Negative numbers are years BC. Positive numbers are years AD.", "type": "number" }, "deathYear": { "description": "The year that the person died. Negative numbers are years BC. Positive numbers are years AD.", "type": "number" }, "apiLink": { "type": "string", "description": "The API link for the person. Relative to the API origin." }, "verses": { "type": "array", "items": { "type": "number" }, "description": "The numbers of the verses in the chapter that mention the person. Sorted in ascending order." } }, "required": [ "id", "name", "apiLink", "verses" ], "additionalProperties": false, "description": "Defines a person that appears in a chapter of a dataset." }, "ApiDatasetChapterPlace": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the place." }, "name": { "type": "string", "description": "The name of the place." }, "featureType": { "description": "The type of geographical feature that the place is. For example, \"City\", \"Region\", \"Mountain\", \"Water\", etc.", "type": "string" }, "latitude": { "description": "The latitude of the place.", "type": "number" }, "longitude": { "description": "The longitude of the place.", "type": "number" }, "apiLink": { "type": "string", "description": "The API link for the place. Relative to the API origin." }, "verses": { "type": "array", "items": { "type": "number" }, "description": "The numbers of the verses in the chapter that mention the place. Sorted in ascending order." } }, "required": [ "id", "name", "apiLink", "verses" ], "additionalProperties": false, "description": "Defines a place that appears in a chapter of a dataset." }, "ApiDatasetChapterEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the event." }, "name": { "type": "string", "description": "The name of the event." }, "startDate": { "description": "The date that the event started at. Negative numbers are years BC. Positive numbers are years AD. More specific dates use the `YYYY-MM-DD` format.", "type": "string" }, "apiLink": { "type": "string", "description": "The API link for the event. Relative to the API origin." }, "verses": { "type": "array", "items": { "type": "number" }, "description": "The numbers of the verses in the chapter that describe the event. Sorted in ascending order." } }, "required": [ "id", "name", "apiLink", "verses" ], "additionalProperties": false, "description": "Defines an event that appears in a chapter of a dataset." }, "ApiDatasetEntityChapterData": { "type": "object", "properties": { "number": { "type": "number", "description": "The number of the chapter." }, "people": { "type": "array", "items": { "$ref": "#/components/schemas/ApiDatasetChapterPerson" }, "description": "The people that appear in the chapter. Sorted by the first verse that they appear in." }, "places": { "type": "array", "items": { "$ref": "#/components/schemas/ApiDatasetChapterPlace" }, "description": "The places that appear in the chapter. Sorted by the first verse that they appear in." }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/ApiDatasetChapterEvent" }, "description": "The events that appear in the chapter. Sorted by the first verse that they appear in." } }, "required": [ "number", "people", "places", "events" ], "additionalProperties": false, "description": "Defines the entity data for a chapter in a dataset. Contains the people, places, and events that appear in the chapter." }, "ApiDatasetPeople": { "type": "object", "properties": { "dataset": { "description": "The dataset information for the people.", "$ref": "#/components/schemas/ApiDataset" }, "people": { "type": "array", "items": { "$ref": "#/components/schemas/ApiDatasetPersonSummary" }, "description": "The list of people that are available for the dataset." } }, "required": [ "dataset", "people" ], "additionalProperties": false, "description": "The list of people in a dataset. Maps to the /api/d/:datasetId/people.json endpoint." }, "ApiDatasetPersonSummary": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the person." }, "name": { "type": "string", "description": "The name of the person." }, "isProperName": { "description": "Whether the name of the person is a proper name.", "type": "boolean" }, "gender": { "description": "The gender of the person.", "type": "string" }, "numberOfReferences": { "type": "number", "description": "The number of Bible references that mention the person." }, "thisPersonApiLink": { "type": "string", "description": "The API link for the person. Relative to the API origin." } }, "required": [ "id", "name", "numberOfReferences", "thisPersonApiLink" ], "additionalProperties": false, "description": "Defines a summary of a person in a dataset." }, "ApiDatasetPerson": { "type": "object", "properties": { "dataset": { "description": "The dataset information for the person.", "$ref": "#/components/schemas/ApiDataset" }, "person": { "description": "The information about the person.", "$ref": "#/components/schemas/DatasetPerson" }, "thisPersonApiLink": { "type": "string", "description": "The API link for this person. Relative to the API origin." } }, "required": [ "dataset", "person", "thisPersonApiLink" ], "additionalProperties": false, "description": "The information about a person in a dataset. Maps to the /api/d/:datasetId/people/:personId.json endpoint." }, "DatasetEntityRef": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the entity that is being referenced." }, "type": { "description": "The type of the entity that is being referenced. Matches the collection segment of the entity's API link, so the link can be constructed as `/api/d/{dataset}/{type}/{id}.json`.", "$ref": "#/components/schemas/DatasetEntityType" }, "name": { "description": "The name of the entity that is being referenced.", "type": "string" }, "apiLink": { "description": "The API link for the entity that is being referenced. Relative to the API origin. Only present in API responses.", "type": "string" } }, "required": [ "id", "type" ], "additionalProperties": false, "description": "Defines the schema for a reference to another entity (person, place, event, or people group) in a dataset." }, "DatasetEntityType": { "type": "string", "enum": [ "people", "places", "events", "groups" ], "description": "The type of an entity in a dataset. Matches the collection segment of the entity API paths, so the API link for an entity can be constructed as `/api/d/{dataset}/{type}/{id}.json`." }, "VerseRef": { "type": "object", "properties": { "book": { "$ref": "#/components/schemas/BookId" }, "chapter": { "type": "number", "description": "The chapter number that the reference starts at." }, "verse": { "type": "number", "description": "The verse number that the reference starts at." }, "content": { "description": "The rest of the content of the verse reference. This is the part of the string that comes after the verse reference. For example, in \"GEN 1:1 In the beginning, God created the Heavens and the Earth.\", the content would be \"In the beginning, God created the Heavens and the Earth.\"", "type": "string" }, "endChapter": { "description": "The chapter that the verse reference ends at. This is used for references that span multiple chapters, such as \"GEN 1:1-2:3\". In this case, the endChapter would be 2.", "type": "number" }, "endVerse": { "description": "The verse that the verse reference ends at. This is used for references that span multiple verses, such as \"GEN 1:1-1:3\". In this case, the endVerse would be 3.", "type": "number" } }, "required": [ "book", "chapter", "verse" ], "additionalProperties": false, "description": "Defines a schema for verse references. A verse reference is a string that contains a book ID, chapter number, and verse number, such as \"GEN 1:1\". It can also contain an optional content part that comes after the verse reference, such as \"GEN 1:1 In the beginning, God created the Heavens and the Earth.\" It can also contain optional endChapter and endVerse fields for references that span multiple chapters or verses, such as \"GEN 1:1-2:3\"." }, "DatasetPerson": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the person." }, "name": { "type": "string", "description": "The name of the person." }, "alsoCalled": { "description": "Other names that the person is called by.", "type": "array", "items": { "type": "string" } }, "isProperName": { "description": "Whether the name of the person is a proper name.", "type": "boolean" }, "gender": { "description": "The gender of the person.", "type": "string" }, "description": { "description": "The description of the person. Each string is a paragraph.", "type": "array", "items": { "type": "string" } }, "birthYear": { "description": "The year that the person was born. Negative numbers are years BC. Positive numbers are years AD.", "type": "number" }, "deathYear": { "description": "The year that the person died. Negative numbers are years BC. Positive numbers are years AD.", "type": "number" }, "minYear": { "description": "The earliest year that the person is mentioned in. Negative numbers are years BC. Positive numbers are years AD.", "type": "number" }, "maxYear": { "description": "The latest year that the person is mentioned in. Negative numbers are years BC. Positive numbers are years AD.", "type": "number" }, "birthPlace": { "description": "The place that the person was born in.", "$ref": "#/components/schemas/DatasetEntityRef" }, "deathPlace": { "description": "The place that the person died in.", "$ref": "#/components/schemas/DatasetEntityRef" }, "father": { "description": "The father(s) of the person.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "mother": { "description": "The mother(s) of the person.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "partners": { "description": "The partners (spouses) of the person.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "children": { "description": "The children of the person.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "siblings": { "description": "The siblings of the person.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "halfSiblingsSameMother": { "description": "The half-siblings of the person that share the same mother.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "halfSiblingsSameFather": { "description": "The half-siblings of the person that share the same father.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "memberOf": { "description": "The people groups that the person is a member of.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "events": { "description": "The events that the person participated in.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/VerseRef" }, "description": "The list of Bible references that mention the person. Sorted by book order, chapter, and verse. Consecutive verses in the same chapter are collapsed into a single reference using `endVerse`." } }, "required": [ "id", "name", "references" ], "additionalProperties": false, "description": "Defines the schema for information about a person in a dataset." }, "ApiDatasetPlaces": { "type": "object", "properties": { "dataset": { "description": "The dataset information for the places.", "$ref": "#/components/schemas/ApiDataset" }, "places": { "type": "array", "items": { "$ref": "#/components/schemas/ApiDatasetPlaceSummary" }, "description": "The list of places that are available for the dataset." } }, "required": [ "dataset", "places" ], "additionalProperties": false, "description": "The list of places in a dataset. Maps to the /api/d/:datasetId/places.json endpoint." }, "ApiDatasetPlaceSummary": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the place." }, "name": { "type": "string", "description": "The name of the place." }, "featureType": { "description": "The type of geographical feature that the place is. For example, \"City\", \"Region\", \"Mountain\", \"Water\", etc.", "type": "string" }, "latitude": { "description": "The latitude of the place.", "type": "number" }, "longitude": { "description": "The longitude of the place.", "type": "number" }, "numberOfReferences": { "type": "number", "description": "The number of Bible references that mention the place." }, "thisPlaceApiLink": { "type": "string", "description": "The API link for the place. Relative to the API origin." } }, "required": [ "id", "name", "numberOfReferences", "thisPlaceApiLink" ], "additionalProperties": false, "description": "Defines a summary of a place in a dataset." }, "ApiDatasetPlace": { "type": "object", "properties": { "dataset": { "description": "The dataset information for the place.", "$ref": "#/components/schemas/ApiDataset" }, "place": { "description": "The information about the place.", "$ref": "#/components/schemas/DatasetPlace" }, "thisPlaceApiLink": { "type": "string", "description": "The API link for this place. Relative to the API origin." } }, "required": [ "dataset", "place", "thisPlaceApiLink" ], "additionalProperties": false, "description": "The information about a place in a dataset. Maps to the /api/d/:datasetId/places/:placeId.json endpoint." }, "DatasetPlace": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the place." }, "name": { "type": "string", "description": "The name of the place." }, "kjvName": { "description": "The name of the place as it appears in the King James Version.", "type": "string" }, "esvName": { "description": "The name of the place as it appears in the English Standard Version.", "type": "string" }, "aliases": { "description": "Other names that the place is called by.", "type": "array", "items": { "type": "string" } }, "featureType": { "description": "The type of geographical feature that the place is. For example, \"City\", \"Region\", \"Mountain\", \"Water\", etc.", "type": "string" }, "featureSubType": { "description": "The sub-type of geographical feature that the place is.", "type": "string" }, "latitude": { "description": "The latitude of the place.", "type": "number" }, "longitude": { "description": "The longitude of the place.", "type": "number" }, "precision": { "description": "How precise the latitude and longitude of the place are.", "type": "string" }, "description": { "description": "The description of the place. Each string is a paragraph.", "type": "array", "items": { "type": "string" } }, "comment": { "description": "The comment on the place from the dataset authors.", "type": "string" }, "rootPlace": { "description": "The root place for this place. Different names for the same geographical location share the same root place.", "$ref": "#/components/schemas/DatasetEntityRef" }, "duplicateOf": { "description": "The place that this place is a duplicate of.", "$ref": "#/components/schemas/DatasetEntityRef" }, "people": { "description": "The people that have been at the place.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "peopleBorn": { "description": "The people that were born at the place.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "peopleDied": { "description": "The people that died at the place.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "events": { "description": "The events that happened at the place.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/VerseRef" }, "description": "The list of Bible references that mention the place. Sorted by book order, chapter, and verse. Consecutive verses in the same chapter are collapsed into a single reference using `endVerse`." } }, "required": [ "id", "name", "references" ], "additionalProperties": false, "description": "Defines the schema for information about a place in a dataset." }, "ApiDatasetEvents": { "type": "object", "properties": { "dataset": { "description": "The dataset information for the events.", "$ref": "#/components/schemas/ApiDataset" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/ApiDatasetEventSummary" }, "description": "The list of events that are available for the dataset." } }, "required": [ "dataset", "events" ], "additionalProperties": false, "description": "The list of events in a dataset. Maps to the /api/d/:datasetId/events.json endpoint." }, "ApiDatasetEventSummary": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the event." }, "name": { "type": "string", "description": "The name of the event." }, "startDate": { "description": "The date that the event started at. Negative numbers are years BC. Positive numbers are years AD. More specific dates use the `YYYY-MM-DD` format.", "type": "string" }, "numberOfReferences": { "type": "number", "description": "The number of Bible references that describe the event." }, "thisEventApiLink": { "type": "string", "description": "The API link for the event. Relative to the API origin." } }, "required": [ "id", "name", "numberOfReferences", "thisEventApiLink" ], "additionalProperties": false, "description": "Defines a summary of an event in a dataset." }, "ApiDatasetEvent": { "type": "object", "properties": { "dataset": { "description": "The dataset information for the event.", "$ref": "#/components/schemas/ApiDataset" }, "event": { "description": "The information about the event.", "$ref": "#/components/schemas/DatasetEvent" }, "thisEventApiLink": { "type": "string", "description": "The API link for this event. Relative to the API origin." } }, "required": [ "dataset", "event", "thisEventApiLink" ], "additionalProperties": false, "description": "The information about an event in a dataset. Maps to the /api/d/:datasetId/events/:eventId.json endpoint." }, "DatasetEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the event." }, "name": { "type": "string", "description": "The name of the event." }, "startDate": { "description": "The date that the event started at. Negative numbers are years BC. Positive numbers are years AD. More specific dates use the `YYYY-MM-DD` format.", "type": "string" }, "duration": { "description": "The duration of the event. For example, \"1D\" is one day and \"40Y\" is fourty years.", "type": "string" }, "participants": { "description": "The people that participated in the event.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "locations": { "description": "The places that the event happened at.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "groups": { "description": "The people groups that participated in the event.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "partOf": { "description": "The event that this event is a part of.", "$ref": "#/components/schemas/DatasetEntityRef" }, "predecessor": { "description": "The event that happened before this event.", "$ref": "#/components/schemas/DatasetEntityRef" }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/VerseRef" }, "description": "The list of Bible references that describe the event. Sorted by book order, chapter, and verse. Consecutive verses in the same chapter are collapsed into a single reference using `endVerse`." } }, "required": [ "id", "name", "references" ], "additionalProperties": false, "description": "Defines the schema for information about an event in a dataset." }, "ApiDatasetPeopleGroups": { "type": "object", "properties": { "dataset": { "description": "The dataset information for the people groups.", "$ref": "#/components/schemas/ApiDataset" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/ApiDatasetPeopleGroupSummary" }, "description": "The list of people groups that are available for the dataset." } }, "required": [ "dataset", "groups" ], "additionalProperties": false, "description": "The list of people groups in a dataset. Maps to the /api/d/:datasetId/groups.json endpoint." }, "ApiDatasetPeopleGroupSummary": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the people group." }, "name": { "type": "string", "description": "The name of the people group." }, "numberOfMembers": { "type": "number", "description": "The number of people that are members of the people group." }, "thisPeopleGroupApiLink": { "type": "string", "description": "The API link for the people group. Relative to the API origin." } }, "required": [ "id", "name", "numberOfMembers", "thisPeopleGroupApiLink" ], "additionalProperties": false, "description": "Defines a summary of a people group in a dataset." }, "ApiDatasetPeopleGroup": { "type": "object", "properties": { "dataset": { "description": "The dataset information for the people group.", "$ref": "#/components/schemas/ApiDataset" }, "group": { "description": "The information about the people group.", "$ref": "#/components/schemas/DatasetPeopleGroup" }, "thisPeopleGroupApiLink": { "type": "string", "description": "The API link for this people group. Relative to the API origin." } }, "required": [ "dataset", "group", "thisPeopleGroupApiLink" ], "additionalProperties": false, "description": "The information about a people group in a dataset. Maps to the /api/d/:datasetId/groups/:groupId.json endpoint." }, "DatasetPeopleGroup": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the people group." }, "name": { "type": "string", "description": "The name of the people group." }, "members": { "description": "The people that are members of the people group.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "events": { "description": "The events that the people group participated in.", "type": "array", "items": { "$ref": "#/components/schemas/DatasetEntityRef" } }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/VerseRef" }, "description": "The list of Bible references that mention the people group. Sorted by book order, chapter, and verse. Consecutive verses in the same chapter are collapsed into a single reference using `endVerse`." } }, "required": [ "id", "name", "references" ], "additionalProperties": false, "description": "Defines the schema for information about a people group in a dataset." } } } }