usnistgov/oscal-deep-diff

Switch show content on and off

Closed this issue · 0 comments

User Story:

As an OSCAL tool developer, I want to allow the tool to be able to only show JSON pointers in order to optimize the output object for machine-readable applications.

Goals:

  • The output comparison document is very large, containing the full sub-objects of array items. This is for human readability.
  • In a machine-readable context, the content is irrelevant, only the json pointers are needed.
  • For machine readability and small document sizes (optimized for network-bound workloads such as web applications), an option can be added that would cause the output object to only contain JSON pointers.

Dependencies:

None.

Acceptance Criteria

  • 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.
  • relevant options have command line arguments added