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

[Task] Document design decision for JSON payloads #277

Open
atextor opened this issue Jan 17, 2024 · 0 comments
Open

[Task] Document design decision for JSON payloads #277

atextor opened this issue Jan 17, 2024 · 0 comments
Labels
acknowledged Has been viewed by one of the maintainers and is ready for further work, discussion or other steps. task

Comments

@atextor
Copy link
Contributor

atextor commented Jan 17, 2024

Is your task related to a problem? Please describe.
The section Payloads documents how JSON payloads are mapped to Aspect Models. Currently no decision record documents why the payload is defined like this, and why it intentionally does not contain any references to the models.

Describe the solution you'd like
A decision record should be created that details:

  • SAMM's approach of cleanly separating between meta model layers (M0/M1/M2/M3) as described in OMG's MOF (i.e. ISO/IEC 19502:2005 / ISO/IEC 19508:2014)
  • Pros and Cons of the approach in comparison to self-describing data or other systematic references from runtime data to the model (e.g. JSON-LD), i.e. backwards compatibility to existing APIs, straightforward APIs (OpenAPI generation), mapping of multiple model versions to data endpoints etc.

Additional context
The topic was already adressed/discussed

@atextor atextor added the task label Jan 17, 2024
@chris-volk chris-volk added the acknowledged Has been viewed by one of the maintainers and is ready for further work, discussion or other steps. label Feb 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
acknowledged Has been viewed by one of the maintainers and is ready for further work, discussion or other steps. task
Projects
None yet
Development

No branches or pull requests

2 participants