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

Spectral Rules for Advanced Checking on Models #20

Closed
jpgough-ms opened this issue Feb 21, 2024 · 3 comments
Closed

Spectral Rules for Advanced Checking on Models #20

jpgough-ms opened this issue Feb 21, 2024 · 3 comments
Labels
enhancement New feature or request

Comments

@jpgough-ms
Copy link
Member

Feature Request

Description of Problem:

JSON schema provides a significant amount of checking, but when we need referential constraints e.g. uniqueId defined in relationships it would be good to use an advanced linting tool.

Potential Solutions:

  • Use Spectral to create a limited set of core rules that will allow us to identify any relationships that do not fall within constraints.
  • Use Spectral to create rules that will check for where instantiated patterns have not replaced placeholder/default values
@jpgough-ms
Copy link
Member Author

@willosborne has a PoC of this to share

@jpgough-ms
Copy link
Member Author

jpgough-ms commented Feb 21, 2024

Another feature we might want to add is to constrain the relationship type based on the nodes in the relationship. For example, and actor should be able to interact with a system or service. A system should not interact with another system, but instead connect

@willosborne
Copy link
Member

This has been done for instantiations, but not patterns. Basic validations are run as part of the CI build, see issue #35
The full feature will be implemented as part of the CLI, see issue #73

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants