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

Profiles when resolved should show their provenance #680

Closed
3 tasks
wendellpiez opened this issue May 31, 2020 · 5 comments
Closed
3 tasks

Profiles when resolved should show their provenance #680

wendellpiez opened this issue May 31, 2020 · 5 comments
Assignees
Labels
closable enhancement Scope: Tooling and APIs Issues targeted at development of tooling and APIs to support OSCAL content creation and use. User Story
Milestone

Comments

@wendellpiez
Copy link
Contributor

User Story:

A profile when resolved produces a catalog representing the baseline, selection or customization of the source catalog(s), as described by the profile. This "resolved profile" document has its own metadata - derived from the metadata of the source document - but it is not readily discernible that it (nominally a catalog) is actually a "resolved view" of a profile represented anywhere (such as the XML or JSON document from which it was produced).

The document metadata of a resolved profile should say that it is a resolved profile and link to its source documents, not only the ultimate catalog or upstream profile sources, but the source profile document.

In doing so it can refer to a resource in back-matter produced by profile resolution to specify and link to the nominal source, including both identifying information (its uuid and/or info from its metadata) and any available address(es) for its retrieval.

Goals:

  • Update specs to define this behavior
  • Update tools to conform to specs
  • Take advantage of features of uuid properties on source documents to document provenance
  • Document what happens in profile resolution to make it traceable
  • Document any expectations or best practices especially relating to uuid assignments and traceability.

Dependencies:

No known external dependencies. Profile resolution must be stable.

Updating the tools will include updating any applicable unit tests to reflect new requirements in the outputs.

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.
@david-waltermire david-waltermire added the model-refactor Used to mark issues related to model refactoring for the Metaschema v4 transition. label Sep 11, 2020
@david-waltermire david-waltermire added the Scope: Modeling Issues targeted at development of OSCAL formats label Sep 11, 2020
@david-waltermire
Copy link
Contributor

@wendellpiez We need to design an approach and discuss this with the model review.

We should consider bumping this to OSCAL 1.1, unless this can be handled completely using link and prop.

@david-waltermire david-waltermire removed the model-refactor Used to mark issues related to model refactoring for the Metaschema v4 transition. label Apr 13, 2021
@wendellpiez
Copy link
Contributor Author

Agreed.

@wendellpiez wendellpiez added Scope: Tooling and APIs Issues targeted at development of tooling and APIs to support OSCAL content creation and use. and removed Scope: Modeling Issues targeted at development of OSCAL formats labels Feb 7, 2022
@wendellpiez
Copy link
Contributor Author

Let's revisit with current work on #954 #1076 #1086. There is now language in the spec to address this requirement (albeit without the more cumbersome resource apparatus suggested here).

@david-waltermire david-waltermire removed their assignment Mar 21, 2022
@aj-stein-nist
Copy link
Contributor

This might be closable, @david-waltermire-nist will talk about this when we hop back into triage.

@david-waltermire
Copy link
Contributor

This is addressed by prop[@name="source-profile"].

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
closable enhancement Scope: Tooling and APIs Issues targeted at development of tooling and APIs to support OSCAL content creation and use. User Story
Projects
None yet
Development

No branches or pull requests

3 participants