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.

Sign up for GitHub

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

Jump to bottom

Additional Metaschema Details in Schema #448

Closed
4 tasks done
brian-ruf opened this issue Jun 27, 2019 · 4 comments
Closed
4 tasks done

Additional Metaschema Details in Schema #448

brian-ruf opened this issue Jun 27, 2019 · 4 comments
Assignees
@wendellpiez
Labels
enhancement Scope: Metaschema Issues targeted at the metaschema pipeline Scope: Modeling Issues targeted at development of OSCAL formats User Story
Milestone
OSCAL 1.0 Milesto...

Comments

@brian-ruf
Copy link
Contributor

brian-ruf commented Jun 27, 2019 •
edited by david-waltermire
Loading

User Story:

As an OSCAL developer, I would prefer to use the schema rather than the "complete" metaschema for form generation, and to programmatically "know" where to insert new data in the OSCAL structure.

Most of the metaschema content is available in the generated schema files for this; however, a few additional items are helpful. In particular, it would be very helpful if the schema file provided the following in a machine-readable format:

  • clear identification of the OSCAL root element (catalog, profile, ssp, component, etc.)
  • the metaschema file description, which is currently only reflected in the schema file as a comment
  • separate "formal names" for each field, rather than (or in addition to) being bundled with its description in the "description" field.
  • separate "description" for each field rather than (or in addition to) being bundled with the formal name in the "description" field.

Goals:

Ensure the requested data elements are generated from the meatadata as machine readable content in the schema files.

Dependencies:

None.

Acceptance Criteria

  • The OSCAL root element is consistently represented in the generated schema in a machine-readable format
  • The metadata file description is consistently represented in the generated schema in a machine-readable format
  • Each field's formal name is consistently represented in the generated schema in a machine-readable format
  • Each field's description is consistently represented in the generated schema in a machine-readable format
wendellpiez added a commit to wendellpiez/OSCAL that referenced this issue Jun 27, 2019
@wendellpiez
Updating schemas to current model (transitional); updated docs in res…
9cf437d 
…ulting XSD per usnistgov#448; some updates to markdown documentation
wendellpiez added a commit to wendellpiez/OSCAL that referenced this issue Jun 27, 2019
@wendellpiez
Revisiting usnistgov#448 (inserting more documentation into XSD): it …
a5d0705 
…actually works now
@wendellpiez
Copy link
Contributor

Addressed in my sprint22-metaschema branch, PR to come.

To review, look at the latest schemas produced from the XSD pipeline.

Follow-on work could include enhancing the documentation injection into the JSON Schema as well. @davidwaltermire and @anweiss any ideas?

@wendellpiez wendellpiez added this to the OSCAL 1.0 Milestone 2 milestone Jun 27, 2019
@wendellpiez wendellpiez mentioned this issue Jun 27, 2019
Closed
6 tasks
@david-waltermire david-waltermire added Scope: Modeling Issues targeted at development of OSCAL formats Scope: Metaschema Issues targeted at the metaschema pipeline labels Jul 2, 2019
@iMichaela iMichaela mentioned this issue Jul 11, 2019
Closed
9 tasks
@iMichaela
Copy link
Contributor

7/11/2019

This issue and the related ones (noted in #435 ) for the metaschema need to be reviewed together and unitested. However, more unit tests need to be created for the other features.

wendellpiez added a commit to wendellpiez/OSCAL that referenced this issue Jul 18, 2019
@wendellpiez
Updating schemas to current model (transitional); updated docs in res…
d9d39e1 
…ulting XSD per usnistgov#448; some updates to markdown documentation
wendellpiez added a commit to wendellpiez/OSCAL that referenced this issue Jul 18, 2019
@wendellpiez
Revisiting usnistgov#448 (inserting more documentation into XSD): it …
893ddde 
…actually works now
@david-waltermire
Copy link
Contributor

This will be closed once PR #464 is pulled.

david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue Aug 16, 2019
@wendellpiez @david-waltermire
Updating schemas to current model (transitional); updated docs in res…
0080d0d 
…ulting XSD per usnistgov#448; some updates to markdown documentation
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue Aug 16, 2019
@wendellpiez @david-waltermire
Revisiting usnistgov#448 (inserting more documentation into XSD): it …
6a97faa 
…actually works now
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue Aug 16, 2019
@wendellpiez @david-waltermire
Updating schemas to current model (transitional); updated docs in res…
49c0aa5 
…ulting XSD per usnistgov#448; some updates to markdown documentation
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue Aug 16, 2019
@wendellpiez @david-waltermire
Revisiting usnistgov#448 (inserting more documentation into XSD): it …
a5de6a0 
…actually works now
david-waltermire added a commit that referenced this issue Aug 22, 2019
@david-waltermire
Implementation refactor plus sprint22 metaschema (#464)
62a28fe 
* Supporting enumerated value lists on flags in XSD and JSON Schema #437
* Metaschema improvements and remodeling flags support (local definitions; moving w/in the model; valid values)
* More Metaschema syntax remodeling: now using max-occurs and min-occurs for cardinality indicators #441
* Updating schemas to current model (transitional); updated docs in resulting XSD per #448; some updates to markdown documentation
* Small updates to authoring CSS.
* Added design notes on JSON schema bindings.
* Including an initial set of unit tests for group-by, some data types, etc.
* Updated to new design (#436): Metaschema schema, Schematron, metaschema update XSLT - will break the build for now
* Work on datatyping #436 including support in XML and JSON Schema
* Addressed #451: parameter insertion syntax in Markdown
* Schema documentation improvements #423 #424 #428
* Addressed feature request #438
* Improving handling of JSON 'key' and 'value-key' settings in docs #428
* Now producing XML and JSON model maps from metaschemas.
* Now escaping {{ for Jekyll
* Updated component metaschema based on design notes
* Fixed schematron assertions to properly work with @ref.
* Refactoring of component and SSP metachema.
* Fixed website side navigation. Added component and SSP metaschema to site generation process.
* Addressed comments in issue #445
* Added site content generation to runall.sh
* Started documenting model changes in release notes. More work is still needed to complete this.
david-waltermire added a commit to david-waltermire/OSCAL that referenced this issue Aug 26, 2019
@david-waltermire
Implementation refactor plus sprint22 metaschema (usnistgov#464)
2d8c2ba 
* Supporting enumerated value lists on flags in XSD and JSON Schema usnistgov#437
* Metaschema improvements and remodeling flags support (local definitions; moving w/in the model; valid values)
* More Metaschema syntax remodeling: now using max-occurs and min-occurs for cardinality indicators usnistgov#441
* Updating schemas to current model (transitional); updated docs in resulting XSD per usnistgov#448; some updates to markdown documentation
* Small updates to authoring CSS.
* Added design notes on JSON schema bindings.
* Including an initial set of unit tests for group-by, some data types, etc.
* Updated to new design (usnistgov#436): Metaschema schema, Schematron, metaschema update XSLT - will break the build for now
* Work on datatyping usnistgov#436 including support in XML and JSON Schema
* Addressed usnistgov#451: parameter insertion syntax in Markdown
* Schema documentation improvements usnistgov#423 usnistgov#424 usnistgov#428
* Addressed feature request usnistgov#438
* Improving handling of JSON 'key' and 'value-key' settings in docs usnistgov#428
* Now producing XML and JSON model maps from metaschemas.
* Now escaping {{ for Jekyll
* Updated component metaschema based on design notes
* Fixed schematron assertions to properly work with @ref.
* Refactoring of component and SSP metachema.
* Fixed website side navigation. Added component and SSP metaschema to site generation process.
* Addressed comments in issue usnistgov#445
* Added site content generation to runall.sh
* Started documenting model changes in release notes. More work is still needed to complete this.
@david-waltermire
Copy link
Contributor

This has been completed in PR #464.

bradh pushed a commit to bradh/OSCAL that referenced this issue Dec 4, 2019
@david-waltermire @bradh
Implementation refactor plus sprint22 metaschema (usnistgov#464)
3d5bd57 
* Supporting enumerated value lists on flags in XSD and JSON Schema usnistgov#437
* Metaschema improvements and remodeling flags support (local definitions; moving w/in the model; valid values)
* More Metaschema syntax remodeling: now using max-occurs and min-occurs for cardinality indicators usnistgov#441
* Updating schemas to current model (transitional); updated docs in resulting XSD per usnistgov#448; some updates to markdown documentation
* Small updates to authoring CSS.
* Added design notes on JSON schema bindings.
* Including an initial set of unit tests for group-by, some data types, etc.
* Updated to new design (usnistgov#436): Metaschema schema, Schematron, metaschema update XSLT - will break the build for now
* Work on datatyping usnistgov#436 including support in XML and JSON Schema
* Addressed usnistgov#451: parameter insertion syntax in Markdown
* Schema documentation improvements usnistgov#423 usnistgov#424 usnistgov#428
* Addressed feature request usnistgov#438
* Improving handling of JSON 'key' and 'value-key' settings in docs usnistgov#428
* Now producing XML and JSON model maps from metaschemas.
* Now escaping {{ for Jekyll
* Updated component metaschema based on design notes
* Fixed schematron assertions to properly work with @ref.
* Refactoring of component and SSP metachema.
* Fixed website side navigation. Added component and SSP metaschema to site generation process.
* Addressed comments in issue usnistgov#445
* Added site content generation to runall.sh
* Started documenting model changes in release notes. More work is still needed to complete this.
aj-stein-nist pushed a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jan 25, 2023
@david-waltermire
Implementation refactor plus sprint22 metaschema (usnistgov#464)
662c7bc 
* Supporting enumerated value lists on flags in XSD and JSON Schema usnistgov#437
* Metaschema improvements and remodeling flags support (local definitions; moving w/in the model; valid values)
* More Metaschema syntax remodeling: now using max-occurs and min-occurs for cardinality indicators usnistgov#441
* Updating schemas to current model (transitional); updated docs in resulting XSD per usnistgov#448; some updates to markdown documentation
* Small updates to authoring CSS.
* Added design notes on JSON schema bindings.
* Including an initial set of unit tests for group-by, some data types, etc.
* Updated to new design (usnistgov#436): Metaschema schema, Schematron, metaschema update XSLT - will break the build for now
* Work on datatyping usnistgov#436 including support in XML and JSON Schema
* Addressed usnistgov#451: parameter insertion syntax in Markdown
* Schema documentation improvements usnistgov#423 usnistgov#424 usnistgov#428
* Addressed feature request usnistgov#438
* Improving handling of JSON 'key' and 'value-key' settings in docs usnistgov#428
* Now producing XML and JSON model maps from metaschemas.
* Now escaping {{ for Jekyll
* Updated component metaschema based on design notes
* Fixed schematron assertions to properly work with @ref.
* Refactoring of component and SSP metachema.
* Fixed website side navigation. Added component and SSP metaschema to site generation process.
* Addressed comments in issue usnistgov#445
* Added site content generation to runall.sh
* Started documenting model changes in release notes. More work is still needed to complete this.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@wendellpiez wendellpiez

Labels
enhancement Scope: Metaschema Issues targeted at the metaschema pipeline Scope: Modeling Issues targeted at development of OSCAL formats User Story
Projects
None yet
Milestone
OSCAL 1.0 Milestone 2
Development

No branches or pull requests
4 participants
@wendellpiez @david-waltermire @iMichaela @brian-ruf