Output URNs for hrefs in findaway manfiests #1740
Closed
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
tdilauro
approved these changes
Mar 20, 2024
| @@ -684,18 +685,23 @@ def test_findaway_license_to_webpub_manifest( | |||
| assert 16.201 == first["duration"] | |||
| assert "Track 1" == first["title"] | |||
|
|
|||
| # There is no 'href' value for the readingOrder items because the | |||
| # The 'href' value for the readingOrder is a URN because the | |||
There was a problem hiding this comment.
Minor: This first paragraph could be taken to imply that the URN is used by the Findaway SDK.
Possible rephrasing:
The 'href' value for the
readingOrderis a URN. We do not use it to retrieve files, since that must be done through the Findaway SDK.
| @@ -111,18 +111,21 @@ def __init__( | |||
| # Add the SpineItems as reading order items. None of them will | |||
| # have working 'href' fields -- it's just to give the client a | |||
| # picture of the structure of the timeline. | |||
| # For the href we return a URN that includes the part and sequence | |||
There was a problem hiding this comment.
Minor: Might be worthwhile to remove the second sentence of the previous paragraph.
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.
Description
Output manifests with href that look like:
urn:org.thepalaceproject:findaway:{fulfillmentId}:{item.part}:{item.sequence}instead ofNonefor findaway, so its easier for the mobile clients to use the readingOrder href to track things like bookmarks.Motivation and Context
See slack thread here: https://lyrasis.slack.com/archives/C03GKDAKU0H/p1710949080047149
How Has This Been Tested?
Running tests in CI
Checklist