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

Should we introduce a domain-reference object? #333

Closed
rocketstack-matt opened this issue Aug 12, 2024 · 0 comments
Closed

Should we introduce a domain-reference object? #333

rocketstack-matt opened this issue Aug 12, 2024 · 0 comments

Comments

@rocketstack-matt
Copy link
Member

The 2024-08 draft introduces a domain model.

  • The design allows new domains to be defined, as can be seen in the control-specification example.
  • We then declare instances of a domain, as can be seen in the control-instance example.
  • Domain instances can then be specified in CALM instance documents either at either the architecture (document), node or relationship level, as can be seen with the cbom example in one-node-wonder

e.g.

"domains": {
        "cbom": [
          {
            "unique-id": "ci-arch-001",
            "description": "Evidence of Pre Production Review",
            "requirement-schema": "control-specification.json",
            "requirement-instance": "control-instance.json",
            "evidence": [
              {
                "evidence-link": "https://evidence.com/12345",
                "evidence-id": "12345"
              }
            ]
          }
        ]
      }

The implementation requires the author to specify the domain specification a specific domain should adhere to and the instance being referenced, but we also duplicate the unique-id and description. Could we reduce duplication and make the document more readable by creating a new domain-reference object (open to different names) which would be the schema/instance and evidence container rather than referencing the domains themselves?

Tag: @jpgough-ms, @willosborne

jpgough-ms added a commit to jpgough-ms/architecture-as-code that referenced this issue Aug 12, 2024
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

No branches or pull requests

1 participant