Skip to content

Structure blocks#363

Draft
hamrt wants to merge 14 commits into6.0from
StructureBlocks
Draft

Structure blocks#363
hamrt wants to merge 14 commits into6.0from
StructureBlocks

Conversation

@hamrt
Copy link
Contributor

@hamrt hamrt commented May 23, 2025

No description provided.

@hamrt hamrt marked this pull request as draft May 23, 2025 12:27
Copy link
Contributor

@jelmerderonde jelmerderonde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 attribute blocks. And a maybe blockType. Because json arrays are ordered, I don't think sequence is needed. Or maybe I don't understand what sequence does.
  • Each block should be have a blocks attribute 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!

@hamrt
Copy link
Contributor Author

hamrt commented Oct 27, 2025

@jelmerderonde Thanks for the questions and the feedback.
The idea was to have a completely separate path that provides information about how the education itself is organised. Following that train of thought, since programmes and courses can be combined in different ways, the use of a path for getting this type of information might not be practical. More information on structure blocks for now:
structure-blocks.pptx

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.

3 participants