Skip to content

Builder registration feature design#4

Open
MonikaKumari26 wants to merge 11 commits into
stmuench:initial_rust_api_design_for_diag_libfrom
MonikaKumari26:builder-registration-feature-design
Open

Builder registration feature design#4
MonikaKumari26 wants to merge 11 commits into
stmuench:initial_rust_api_design_for_diag_libfrom
MonikaKumari26:builder-registration-feature-design

Conversation

@MonikaKumari26

Copy link
Copy Markdown

This PR has been created to add Builder Collection Registration pattern feature for Rust-based API design.

Additionally some updates on the README.md which includes working implementation examples that demonstrate how to use the API design in practice. The corresponding implementation can be found in the following PR:

a56dee3

@MonikaKumari26 MonikaKumari26 marked this pull request as ready for review June 10, 2026 08:49
@MonikaKumari26

Copy link
Copy Markdown
Author
diag_api_rust

@darkwisebear darkwisebear left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This diagram serves no purpose other than duplicating information that is already (or will soon be) present in the source code. No one will understand the API by looking at this diagram, so it fails to serve it's primary purpose, which is to illustrate graphically how this API works.

To change this, we should

  • Remove nitty gritty details such as small helper classes or irrelevant relations that go across 4 screens
  • Split the diagram into several, with each diagram focusing on an API aspect
  • (If that helps) have a high level diagram showing the most important entities of the diag API and how they interact with user software.
  • Use colors to distinguish types (e.g. user-provided types vs. core library types vs utility types vs standard types)
  • Assist PlantUML's layout engine by using arrows of varying length, to express how close objects shallo be rendered.

You may have a look at https://github.com/eclipse-score/communication/blob/main/score/mw/com/design/skeleton_proxy/README.md for diagrams that are exhaustive but still provide a good overview without removing too much detail.

@stmuench stmuench force-pushed the initial_rust_api_design_for_diag_lib branch from 22b1ca3 to 8a36d87 Compare June 15, 2026 12:22
@MonikaKumari26

MonikaKumari26 commented Jun 15, 2026

Copy link
Copy Markdown
Author

Thanks for this suggestion... Agreed, diagram above was too dense to convey design intent effectively... I am addressing this with focused diagram. But before I add this to the PR, wanted to get your thoughts on this :
registration

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