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

Updating catalog and profile schemas to new modularity design #327

Closed
wendellpiez opened this issue Mar 18, 2019 · 10 comments
Closed

Updating catalog and profile schemas to new modularity design #327

wendellpiez opened this issue Mar 18, 2019 · 10 comments
Assignees

Comments

@wendellpiez
Copy link
Contributor

wendellpiez commented Mar 18, 2019

User Story:

With work responding to Issue #316 we have a new, simpler metaschema modularity model. At least catalog and profile metaschemas need to be updated to this model.

Goals:

  • Implement the modularity approach defined in the notes of Develop OSCAL Modular Approach Strategy #316,
  • Bring metaschemas to a stable point with the new modularization mechanism.
  • Complete implementation wrt docs production, integrating definitions from imported modules
  • Test all components using the new metaschemas
  • Confirm that documents are (still) valid to their schemas

Dependencies:

#325 is a dependency.

Acceptance Criteria

  • Catalog and profile metaschemas are valid to the new metaschema schema and Schematron?
  • Production pipelines are correctly integrating schema modules in production of artifacts, including:
    • XML and JSON schemas (to which examples must be valid)
    • Conversion utilities (XSLTs) supporting XML<->JSON conversion
    • Docs production
  • A PR has been submitted and reviewed with all the metaschema changes.

NB: Correcting newly found bugs is not an acceptance criterion.

@wendellpiez
Copy link
Contributor Author

NB: agreed in Sprint Review meeting March 18 that we will exclude the declarations element and support for it from the RC catalog and profile models. It can be commented out as a tbd.

@wendellpiez
Copy link
Contributor Author

Sprint Progress March 21 2019

Not much progress on this, but about to turn back to it now that documentation is more stable.

@iMichaela
Copy link
Contributor

03/21/2019

@wendellpiez will get back to this issue on Monday next week.

@howieavp76
Copy link

Latest version posted to S3:

http://nist-oscal.s3-website-us-east-1.amazonaws.com/

@wendellpiez
Copy link
Contributor Author

Sprint 19 Progress March 28 2019

Drafts of the new schemas are available in my branch, here: https://github.com/wendellpiez/OSCAL/tree/feature-metaschema-d3/schema/metaschema

There are revised, stable versions of catalog and profile schemas along with WIP for a new "resources" module providing structures for references, attachments and other resources.

Small adjustments have also been made to catalogs and profiles in this branch to keep them in line.

Also, both docs and tools generation as well as schema generation must be refreshed when this is stable.

@iMichaela
Copy link
Contributor

03/28/2019

See @wendellpiez 's note above. Feedback from @david-waltermire-nist, @brianrufgsa @anweiss, and @redhatrises is needed.

@brian-ruf
Copy link
Contributor

brian-ruf commented Apr 4, 2019

4/4/2019 - @wendellpiez has completed work, and needs to create a PR for review and acceptance. Also, see comment in Issue #314. PR expected by COB Tuesday 4/9.

@wendellpiez
Copy link
Contributor Author

Made a PR, then closed it for wonkiness. Too many commits, hard to trace.

@anweiss has helped me clean up; trying again tomorrow.

wendellpiez added a commit to wendellpiez/OSCAL that referenced this issue Apr 10, 2019
@iMichaela
Copy link
Contributor

iMichaela commented Apr 11, 2019

04/11/2019

Ready for review from @david-waltermire-nist and the rest of the team.

david-waltermire pushed a commit that referenced this issue Apr 19, 2019
* Improvements to metaschema design and processing infrastructure #327, with updates to sample catalogs and profiles.
@david-waltermire
Copy link
Contributor

4-19-19

This work looks good and has been reviewed.

The following follow-on work is needed:

  • Refactor the meta model to allow attachments to be referenced from references.
  • Make meta required in all models, and @title required in meta.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants