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

Support message syntax and semantics to all constraint types #34

Open
9 of 14 tasks
aj-stein-gsa opened this issue Oct 17, 2024 · 2 comments
Open
9 of 14 tasks

Support message syntax and semantics to all constraint types #34

aj-stein-gsa opened this issue Oct 17, 2024 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@aj-stein-gsa
Copy link
Contributor

aj-stein-gsa commented Oct 17, 2024

User Story:

As a Metaschema-enabled software developer, I want more flexible reporting for a variety of constraints not just expect, so I would like the ability to add a message to the following types of constraints:

Goals:

Dependencies:

{Describe any previous issues or related work that must be completed to start or complete this issue.}

Acceptance Criteria

  • All website and readme documentation affected by the changes in this issue have been updated. Changes to the website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.

{The items above are general acceptance criteria for all User Stories. Please describe anything else that must be completed for this issue to be considered resolved.}

@aj-stein-gsa aj-stein-gsa added the enhancement New feature or request label Oct 17, 2024
@aj-stein-gsa
Copy link
Contributor Author

@david-waltermire I just wanted to point out there a pretty good example of how the most efficient way to calculate model deviations with constraints for a large set of document instances (yes, plural) in OSCAL came up and I would much rather do it that way with index-has-key. However, knowing the user base of the constraints the output messages are hard to customize for downstream users who are not well-read on the Metaschema models. Example output here.

GSA/fedramp-automation#736 (review)

Is this something we can discuss later today?

@aj-stein-gsa
Copy link
Contributor Author

aj-stein-gsa commented Oct 25, 2024

Met with the maintainers and discussed this issue. They are not opposed moving forward.

  • Need to update the XML schema
  • Need to update the Metaschema schema modules for constraints
  • Update specification and publish website
  • Update implementations
    • metaschema-java maintainers is ready to implement an updated implementation to conform with a new spec after the next release (current upcoming release is pending as of this week).
    • metaschema-xslt is open to implement to be conformant with an updated spec, but there is no bandwidth at this time. It will be a medium to long-term goal.

aj-stein-gsa added a commit to aj-stein-gsa/metaschema that referenced this issue Oct 26, 2024
aj-stein-gsa added a commit to aj-stein-gsa/metaschema that referenced this issue Oct 26, 2024
aj-stein-gsa added a commit to aj-stein-gsa/metaschema that referenced this issue Oct 26, 2024
aj-stein-gsa added a commit to aj-stein-gsa/metaschema that referenced this issue Oct 26, 2024
@david-waltermire david-waltermire moved this from To Triage to In progress in Tooling Work Board Oct 26, 2024
david-waltermire added a commit to david-waltermire/metaschema-enhanced that referenced this issue Oct 27, 2024
@david-waltermire david-waltermire self-assigned this Oct 27, 2024
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
Status: In progress
Development

No branches or pull requests

2 participants