Skip to content
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

DP-685: Update component diagrams #710

Merged
merged 3 commits into from
Oct 7, 2024
Merged

DP-685: Update component diagrams #710

merged 3 commits into from
Oct 7, 2024

Conversation

jakzal
Copy link
Member

@jakzal jakzal commented Oct 3, 2024

I opted to document abstractions rather than concrete implementations in most cases. Specifically, instead of documenting every possible endpoint and use case, they're represented by a single component - "Endpoint", "UseCase", etc. This way it's:

  • easier to maintain as we don't have to update diagrams each time we add a new component (if we wanted go this route it would be easier to generate these based on code)
  • easier to read as there's less clutter on diagrams

Authority

Organisation App

Tenant Api

Person Api

Organisation Api

Forms Api

Data Sharing Api

Entity Verification

@jakzal jakzal changed the title Update component diagrams DP-685: Update component diagrams Oct 7, 2024
@jakzal jakzal marked this pull request as ready for review October 7, 2024 09:08
@jakzal jakzal merged commit b6f1d3d into main Oct 7, 2024
8 checks passed
@jakzal jakzal deleted the docs/component-diagrams branch October 7, 2024 13:40
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