Skip to content

Add imported-from relation to links in SSP #1023

@mruge

Description

@mruge

User Story:

To better document how components, capabilities, and controls all relate to one another. Additional pre-defined relation types would be useful. Although the Link assembly allows for arbitrary values some of the time, pre-defined acceptable values would provide users and tool developers better ability to make more universally compatible documents.

Adding additional values to the following Links would simplify importing and referencing source information for objects within the SSP

Goals:

  • Add imported-from as a accepted value in the ssp -> system implementation -> component -> link stanza. This relation is intended to represent the UUID and/or href back to the Component Definition that defined that component.

  • Add imported-from as a accepted value in the ssp -> Control implementation -> implemented requirements -> by-component -> link stanza. This relation is intended to represent the UUID and/or href back to the Component Definition that defined that control narrative.

Dependencies:

  • Enhancing 'link' to indicate internal targets in a 'resource' #756 is completed, as linking to the component-definition/@uuid and its original component/@uuid within need to be addressed at the same time with two different fields or a complex syntax in the one field that is not very ergonomic, @link at this time doesn't support that currently.

Acceptance Criteria

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

{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.}

Metadata

Metadata

Type

No type

Projects

Status

Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions