Skip to content

Support XPath for XML and JSON Pointer for JSON/YAML in validation output in CLI default and SARIF output modes #32

@aj-stein-gsa

Description

@aj-stein-gsa

User Story:

As a developer of OSCAL-based tools, in order to transition between different formats more seamlessly in general and processing validation results in particular, I would like the ability to switch from the default Metapaths in constraints' validation results from Metapath to XPath (1.0 or 3.0 flavors TBD) and JSON Pointer

Goals:

Support for:

  • emitting paths in constraint validation results in pure XPath (1.0 or 3.0 up for discussion and confirmation with oscal-cli maintainers)
  • emitting path in constraint validation results in pure JSON Pointer (RFC6901)
  • capability to automatically switch between them based on input document type (auto-sense XPath for XML, JSON Pointer for JSON/YAML)
  • a command-line option at runtime to explicitly mandate the output of one over the other

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.
  • 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.

Metadata

Metadata

Labels

enhancementNew feature or request

Type

No type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions