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

Renamed `json-behavior' and 'xml-behavior' #467

Closed
wendellpiez opened this issue Aug 15, 2019 · 3 comments
Closed

Renamed `json-behavior' and 'xml-behavior' #467

wendellpiez opened this issue Aug 15, 2019 · 3 comments
Assignees
Labels
bug Scope: Metaschema Issues targeted at the metaschema pipeline Scope: Modeling Issues targeted at development of OSCAL formats

Comments

@wendellpiez
Copy link
Contributor

wendellpiez commented Aug 15, 2019

Describe the bug

Presently the metaschema has attributes defined on group-as named json-behavior and xml-behavior. This would be fine except names starting with the characters 'x','m','l' (lower or upper case) are reserved by the XML Recommendation (both version 1.0 and 1.1):

https://www.w3.org/TR/xml/#sec-common-syn
https://www.w3.org/TR/xml11/#sec-common-syn

Effectively, this means the name xml-behavior is illegal (like xml-is-the-best).

Who is the bug affecting?

Potentially anyone using XML tools with strict conformance will hit an error processing any metaschema using this attribute.

What is affected by this bug?

Potentially a conformant processor could refuse to process such a document (Draconian error handling). This would not be good.

When does this occur?

Many tools today appear to ignore this rule but it is still in the formal specifications, so it could emerge unexpectedly.

Expected behavior (i.e. solution)

Preventing this issue requires renaming xml-behavior. For symmetry, renaming json-behavior as well.

Potential names include configure-xml and configure-json.

@david-waltermire david-waltermire added this to the OSCAL 1.0 Milestone 2 milestone Sep 4, 2019
@david-waltermire david-waltermire added Scope: Modeling Issues targeted at development of OSCAL formats Scope: Metaschema Issues targeted at the metaschema pipeline labels Sep 4, 2019
@iMichaela
Copy link
Contributor

9/5/2019

Issue was implemented and is part of PR #484. It is waiting for review and approval.

@wendellpiez
Copy link
Contributor Author

For names, we settled on @in-xml and @in-json, as in <group-as in-xml="GROUPED"/>.

@david-waltermire
Copy link
Contributor

This was completed in PR #492.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Scope: Metaschema Issues targeted at the metaschema pipeline Scope: Modeling Issues targeted at development of OSCAL formats
Projects
None yet
Development

No branches or pull requests

3 participants