Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add new API endpoints for file manager/consume page #63

Merged
merged 3 commits into from
Sep 29, 2023

Conversation

MrGrinst
Copy link

@MrGrinst MrGrinst commented Sep 25, 2023

This rethinks the way the requests are handled in an attempt to simplify usage and optimize response
sizes. There are 7 new endpoints to replace existing ones:

  • /bibles/language/LANGUAGE_ID returns basic details about the Bible versions for a language
  • /bibles/BIBLE_ID/book/BOOK_ID returns info about a given book of a given Bible version,
    including URLs for downloading
  • /passages/language/LANGUAGE_ID/resource/TYPE returns basic details for all passages tied to the
    given resource type with content in the given language
  • /passages/PASSAGE_ID/language/LANGUAGE_ID returns content ids for all resources tied to the
    given passage whether through verse or overlapping passage, in the given language. Also includes
    supporting resources for the given passage.
  • /resources/language/LANGUAGE_ID/book/BOOK_ID?resourceType=CBBTER&resourceType=TyndaleBibleDictionary
    returns all the content ids and basic info for a given book and language, filtered to the
    resources you specified. Groups by chapter.
  • /resources/content/CONTENT_ID returns the JSON content for text types or redirects to the CDN
    for other types
  • /resources/metadata/CONTENT_ID returns the display name and any other relevant metadata for
    content

@linear
Copy link

linear bot commented Sep 25, 2023

BIB-112 API Updates to support File Manager changes

The API will need to be updated to support changes to the File Manager as part of the new UI and filtering, as well as pulling Tyndale and CBBT-ER as Tiptap data instead of from the CDN.

This is a dynamic ticket to house any changes that come up during the sprint.

@MrGrinst MrGrinst force-pushed the bib-112-api-updates-to-support-file-manager-changes branch 3 times, most recently from 1fc77c9 to 126122d Compare September 26, 2023 18:44
@MrGrinst MrGrinst changed the title draft of API updates for file manager add new API endpoints for file manager/consume page Sep 26, 2023
@MrGrinst MrGrinst marked this pull request as ready for review September 26, 2023 18:46
@MrGrinst MrGrinst force-pushed the bib-112-api-updates-to-support-file-manager-changes branch 2 times, most recently from c8f1df2 to 652ea11 Compare September 28, 2023 16:17
This rethinks the way the requests are handled in an attempt to simplify usage and optimize response
sizes. There are 7 new endpoints to replace existing ones:
- `/bibles/language/LANGUAGE_ID` returns basic details about the Bible versions for a language
- `/bibles/BIBLE_ID/book/BOOK_ID` returns info about a given book of a given Bible version,
    including URLs for downloading
- `/passages/language/LANGUAGE_ID/resource/TYPE` returns basic details for all passages tied to the
    given resource type with content in the given language
- `/passages/PASSAGE_ID/language/LANGUAGE_ID` returns content ids for all resources tied to the
    given passage whether through verse or overlapping passage, in the given language. Also includes
    supporting resources for the given passage.
- `/resources/language/LANGUAGE_ID/book/BOOK_ID?resourceType=CBBTER&resourceType=TyndaleBibleDictionary`
    returns all the content ids and basic info for a given book and language, filtered to the
    resources you specified. Groups by chapter.
- `/resources/content/CONTENT_ID` returns the JSON content for text types or redirects to the CDN
    for other types
- `/resources/metadata/CONTENT_ID` returns the display name and any other relevant metadata for
    content
@MrGrinst MrGrinst force-pushed the bib-112-api-updates-to-support-file-manager-changes branch from 652ea11 to f718a0c Compare September 28, 2023 16:22
@MrGrinst MrGrinst force-pushed the bib-112-api-updates-to-support-file-manager-changes branch from d06619b to 03fd007 Compare September 28, 2023 20:12
@MrGrinst MrGrinst force-pushed the bib-112-api-updates-to-support-file-manager-changes branch from 63387d8 to 5c27eda Compare September 29, 2023 14:30
@MrGrinst MrGrinst force-pushed the bib-112-api-updates-to-support-file-manager-changes branch 2 times, most recently from 8e0e2d9 to 9de42a3 Compare September 29, 2023 15:50
@MrGrinst MrGrinst force-pushed the bib-112-api-updates-to-support-file-manager-changes branch from 9de42a3 to 7a772c2 Compare September 29, 2023 15:50
@MrGrinst MrGrinst merged commit 2e1e1c7 into master Sep 29, 2023
2 of 3 checks passed
@MrGrinst MrGrinst deleted the bib-112-api-updates-to-support-file-manager-changes branch September 29, 2023 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants