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

Profile Resolution 1.0.2 Updates #1172

Merged
merged 4 commits into from
Mar 17, 2022

Conversation

stephenbanghart
Copy link
Contributor

Addresses:

#1141
Enhanced prose around Group handling, especially around expected behavior of the "keep always" prop.

#1142
Core issue obsoleted by general OSCAL requirements on valid OSCAL documents. Cleaned up prose in the formats section.

#1155
Fixed incorrect notation in metadata section: props are now properly refereed to as such, rather than using the value of their "name" field.

#1140
Significant improvements around resolution of internal references. Behavior is now defined for resolving resources with different combinations of "rlink" and "base64". As these /should/ all be equal to one another, there is no standardized order or priority given in the specification at this time.

#1152
Added Metaschema entries for the new Mapping assembly and it's associated fields/flags. Verified the veracity of existing Profile documentation, making minor-moderate edits to bring documentation up to speed with the current specification.

Copy link
Contributor

@aj-stein-nist aj-stein-nist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry it took a while to get around to this.

Most of them are minor typos, but I had one or two substantive questions about media-types and other things. Other than that, the draft is very good!

src/metaschema/oscal_profile_metaschema.xml Outdated Show resolved Hide resolved
src/metaschema/oscal_profile_metaschema.xml Outdated Show resolved Hide resolved
src/metaschema/oscal_profile_metaschema.xml Outdated Show resolved Hide resolved
<li><p><req level="must" id="req-internal-resolve3">When a <src>rlink</src> is encountered and is to be resolved, it MUST be resolved by using a HTTP Client request to retrieve a Byte Stream. </req></p> </li>
<li><p><req level="must" id="req-internal-resolve4">When a <src>base64</src> is encountered and is to be resolved, it MUST be considered a Byte Stream.</req> </p> </li>
<li><p><req level="must" id="req-internal-resolve5">Regardless of its source, the Byte Stream MUST be decoded based on the algorithm defined in <a href="https://datatracker.ietf.org/doc/html/rfc4648"> Section 4 RFC 4648</a>. </req></p> </li>
</ul>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are wonderful additions, thanks Stephen! One that was discussed in general discussion of this work during the weekly Thursday status meeting was how explicit to be about processing the @media-type of the back-matter resource. Did you, Dave, and Wendell decide it was best to leave this out of the spec?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Providing strict requirements around it may be difficult, but some prose giving recommendations would probably be valuable.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm cool either way, I didn't know it was important to the requirements of the spec around the requirements, explicit or implict, for #1140. Since we will talk this over in the meeting in a few minutes, I am definitely ok with resolving and withdrawing the question.

I know it came up last week around this point: I didn't know what the result of the conversation about it was. I defer to Dave and Wendell about not being explicit.

Copy link
Contributor

@wendellpiez wendellpiez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work on the asymptotic ascent! 🚀 (we have more stages to go)

Copy link
Contributor

@aj-stein-nist aj-stein-nist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had an outstanding question re feedback, but I am good with the document as-is. :-)

@stephenbanghart stephenbanghart marked this pull request as ready for review March 17, 2022 18:16
Copy link
Contributor

@david-waltermire david-waltermire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good with the adjustments requested by AJ. Thanks!

@david-waltermire david-waltermire merged commit 4720c14 into usnistgov:release-1.0 Mar 17, 2022
@david-waltermire david-waltermire added this to the OSCAL 1.0.2 milestone Mar 18, 2022
david-waltermire pushed a commit that referenced this pull request Mar 18, 2022
* Specification changes, #1141 #1142 #1155
* Mapping documentation, UUID RFC reference
* Apply suggestions from AJ's review

Co-authored-by: Stephen Banghart <[email protected]>
Co-authored-by: Alexander Stein <[email protected]>
iMichaela pushed a commit to iMichaela/OSCAL that referenced this pull request Apr 7, 2022
* Specification changes, usnistgov#1141 usnistgov#1142 usnistgov#1155
* Mapping documentation, UUID RFC reference
* Apply suggestions from AJ's review

Co-authored-by: Stephen Banghart <[email protected]>
Co-authored-by: Alexander Stein <[email protected]>
Rene2mt pushed a commit to Rene2mt/OSCAL that referenced this pull request May 17, 2022
* Specification changes, usnistgov#1141 usnistgov#1142 usnistgov#1155
* Mapping documentation, UUID RFC reference
* Apply suggestions from AJ's review

Co-authored-by: Stephen Banghart <[email protected]>
Co-authored-by: Alexander Stein <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants