OSCAL icon indicating copy to clipboard operation
OSCAL copied to clipboard

Develop a solution for managing identifier clashes in OSCAL Profiles

Open david-waltermire opened this issue 2 years ago • 0 comments

User Story

As an OSCAL Profile author or consumer, I need a means to resolve identifier clashes caused by importing catalog content from different sources, whose objects have the same identifier for different objects. The approach that is used must be deterministic and must preserve the provenance of the original identifiers.

A solution must be able to support:

  • [ ] Renaming specific identifiers by specifying an old and new name.
  • [ ] Applying a prefix and/or suffix supporting bulk renaming.
  • [ ] Recording the original identifier for a given object.

Conflicts may occur in controls, groups, parts, and parameters.

This issue will develop a solution to address the following issues:

  • #538 -> PR #1196
  • #843
  • #1327

Goals

  • [ ] Design and document an approach to update the Profile model that will address the requirements above.
    • [ ] Documented approach is backwards compatible with OSCAL 1.x models.
  • [ ] Develop a few examples that illustrate use of the features identified above and publish these examples as GitHub gists.

Issue #1398 will be used to socialize the design with the OSCAL community.

Dependencies

None.

Acceptance Criteria

  • [ ] New design document is publicly available
  • [ ] Examples are published publicly
  • [ ] All OSCAL website and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL 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.

david-waltermire avatar Aug 01 '22 15:08 david-waltermire