-
Notifications
You must be signed in to change notification settings - Fork 0
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
MrGrinst
merged 3 commits into
master
from
bib-112-api-updates-to-support-file-manager-changes
Sep 29, 2023
Merged
add new API endpoints for file manager/consume page #63
MrGrinst
merged 3 commits into
master
from
bib-112-api-updates-to-support-file-manager-changes
Sep 29, 2023
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
force-pushed
the
bib-112-api-updates-to-support-file-manager-changes
branch
3 times, most recently
from
September 26, 2023 18:44
1fc77c9
to
126122d
Compare
MrGrinst
changed the title
draft of API updates for file manager
add new API endpoints for file manager/consume page
Sep 26, 2023
jwinston-bn
reviewed
Sep 26, 2023
jwinston-bn
reviewed
Sep 26, 2023
jwinston-bn
reviewed
Sep 26, 2023
jwinston-bn
reviewed
Sep 26, 2023
jwinston-bn
reviewed
Sep 26, 2023
jwinston-bn
reviewed
Sep 26, 2023
jwinston-bn
reviewed
Sep 26, 2023
jwinston-bn
reviewed
Sep 27, 2023
jwinston-bn
reviewed
Sep 27, 2023
MrGrinst
force-pushed
the
bib-112-api-updates-to-support-file-manager-changes
branch
2 times, most recently
from
September 28, 2023 16:17
c8f1df2
to
652ea11
Compare
MrGrinst
commented
Sep 28, 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
MrGrinst
force-pushed
the
bib-112-api-updates-to-support-file-manager-changes
branch
from
September 28, 2023 16:22
652ea11
to
f718a0c
Compare
jwinston-bn
reviewed
Sep 28, 2023
jwinston-bn
reviewed
Sep 28, 2023
jwinston-bn
reviewed
Sep 28, 2023
jwinston-bn
reviewed
Sep 28, 2023
jwinston-bn
reviewed
Sep 28, 2023
jwinston-bn
reviewed
Sep 28, 2023
jwinston-bn
reviewed
Sep 28, 2023
MrGrinst
force-pushed
the
bib-112-api-updates-to-support-file-manager-changes
branch
from
September 28, 2023 20:12
d06619b
to
03fd007
Compare
jwinston-bn
reviewed
Sep 29, 2023
src/Aquifer.API/Modules/Resources/ResourceContentInfoForBookResponse.cs
Outdated
Show resolved
Hide resolved
jwinston-bn
reviewed
Sep 29, 2023
jwinston-bn
reviewed
Sep 29, 2023
jwinston-bn
reviewed
Sep 29, 2023
src/Aquifer.API/Modules/Resources/ResourceContentMetadataResponse.cs
Outdated
Show resolved
Hide resolved
MrGrinst
force-pushed
the
bib-112-api-updates-to-support-file-manager-changes
branch
from
September 29, 2023 14:30
63387d8
to
5c27eda
Compare
jwinston-bn
reviewed
Sep 29, 2023
MrGrinst
force-pushed
the
bib-112-api-updates-to-support-file-manager-changes
branch
2 times, most recently
from
September 29, 2023 15:50
8e0e2d9
to
9de42a3
Compare
MrGrinst
force-pushed
the
bib-112-api-updates-to-support-file-manager-changes
branch
from
September 29, 2023 15:50
9de42a3
to
7a772c2
Compare
jwinston-bn
approved these changes
Sep 29, 2023
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 thegiven resource type with content in the given language
/passages/PASSAGE_ID/language/LANGUAGE_ID
returns content ids for all resources tied to thegiven 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 CDNfor other types
/resources/metadata/CONTENT_ID
returns the display name and any other relevant metadata forcontent