Draft
Conversation
…tion into StructureBlocks
Contributor
jelmerderonde
left a comment
There was a problem hiding this comment.
Finally found some time to look at this. Before I can get to actual feedback I just have some questions:
- The name is a bit confusing to me. Why not just use
structure? - How do you propose to expose this functionality to API consumers? Via an attribute or via a path? If it were up to me I would add it as a path under (for example)
/programs/{programId}/structure. And maybe (now or later) also under/courses/{courseId}/structure. - If that is the case the top level entity (e.g. the json object returned from
/programs/{programId}/structure) can contain a top level attributeblocks. And a maybeblockType.Because json arrays are ordered, I don't thinksequenceis needed. Or maybe I don't understand whatsequencedoes. - Each block should be have a
blocksattribute to allow nesting. - It would be good to have some examples in the PR description to understand how it would work.
- It think it would be wise to gather feedback from various suppliers to make sure this structure can work as intended.
Thanks for this work so far!
Contributor
Author
|
@jelmerderonde Thanks for the questions and the feedback. |
This file contains hidden or 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
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.
No description provided.