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

Provide guidance around relative URI handling for href instances #1249

Closed
5 tasks done
david-waltermire opened this issue May 10, 2022 · 3 comments · Fixed by #1263
Closed
5 tasks done

Provide guidance around relative URI handling for href instances #1249

david-waltermire opened this issue May 10, 2022 · 3 comments · Fixed by #1263
Assignees
@david-waltermire
Labels
enhancement Scope: Documentation This issue relates to OSCAL documentation. Scope: Metaschema Issues targeted at the metaschema pipeline User Story
Milestone
v1.1.0

Comments

@david-waltermire
Copy link
Contributor

david-waltermire commented May 10, 2022 •
edited
Loading

User Story:

As an OSCAL developer, I would like to have consistent guidance around relative URI handling within href in OSCAL.

Goals:

Update the OSCAL docs references with consistent guidance, including /profile/metadata/link/@href and /profile/back-matter/resource/rlink/@href.

  • Ensure each instance of model reference documentation clearly indicates if an href requires a URI reference or an abolute URI.

This issue builds on the work to review the OSCAL models (#1066 #1331).

Dependencies:

none

Acceptance Criteria

  • The guidance addresses when relative URIs are supported and not.
  • 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 enhancement User Story Scope: Metaschema Issues targeted at the metaschema pipeline Scope: Documentation This issue relates to OSCAL documentation. labels May 10, 2022
@david-waltermire david-waltermire added this to the OSCAL 1.0.4 milestone May 10, 2022
@david-waltermire david-waltermire linked a pull request Jul 1, 2022 that will close this issue
Updates to OSCAL Metaschema documentation and constraints #1263
Merged
9 tasks
@aj-stein-nist aj-stein-nist mentioned this issue Jul 22, 2022
Merged
@david-waltermire
Copy link
Contributor Author

Need to address this TODO.

@GaryGapinski
Copy link

Relative URIs should be supported. Are there any scenarios in which they should not be supported?

URIs which are relative may, or may not, have a scheme, as do absolute URIs. An example for a sibling document href="file:sibling" is interpreted as a sibling document relative to the base URI of the containing document. This seems to be a bit at odds with RFC 3986 though it seems commonly supported.

An href which begins with a # is a URI fragment, not a URI.

See RFC 3986 sections 4 and 5 for related information.

david-waltermire added a commit to david-waltermire/OSCAL that referenced this issue Aug 22, 2022
@david-waltermire
Preliminary work on URI documentation to address usnistgov#1249.
0aa0e7a
david-waltermire added a commit to david-waltermire/OSCAL that referenced this issue Aug 23, 2022
@david-waltermire
Preliminary work on URI documentation to address usnistgov#1249.
af386e9
david-waltermire added a commit to david-waltermire/OSCAL that referenced this issue Aug 23, 2022
@david-waltermire
Preliminary work on URI documentation to address usnistgov#1249.
a9fd7a5
david-waltermire added a commit to david-waltermire/OSCAL that referenced this issue Aug 23, 2022
@david-waltermire
Preliminary work on URI documentation to address usnistgov#1249.
2da79fb
david-waltermire added a commit to david-waltermire/OSCAL that referenced this issue Aug 23, 2022
@david-waltermire
Preliminary work on URI documentation to address usnistgov#1249.
9f313fb
david-waltermire added a commit to david-waltermire/OSCAL that referenced this issue Aug 23, 2022
@david-waltermire
Preliminary work on URI documentation to address usnistgov#1249.
0280b40
@david-waltermire david-waltermire moved this from Todo to In Progress in NIST OSCAL Work Board Aug 24, 2022
david-waltermire added a commit to david-waltermire/OSCAL that referenced this issue Aug 25, 2022
@david-waltermire
Updated Metaschema instances of uri and uri-reference data types …
cc4d487 
…to indicate their URI semantics. Resolves usnistgov#1249.
@david-waltermire
Copy link
Contributor Author

@GaryGapinski Check out this comparison which shows all the edits I made to clarify URI handling. Does this address your concerns? If not, please comment here or on PR #1263.

@david-waltermire david-waltermire moved this from In Progress to Under Review in NIST OSCAL Work Board Aug 25, 2022
david-waltermire added a commit to david-waltermire/OSCAL that referenced this issue Sep 26, 2022
@david-waltermire
Preliminary work on URI documentation to address usnistgov#1249.
4b8c028
david-waltermire added a commit to david-waltermire/OSCAL that referenced this issue Sep 26, 2022
@david-waltermire
Preliminary work on URI documentation to address usnistgov#1249.
921bf4b
david-waltermire added a commit to david-waltermire/OSCAL that referenced this issue Sep 26, 2022
@david-waltermire
Updated Metaschema instances of uri and uri-reference data types …
0df675d 
…to indicate their URI semantics. Resolves usnistgov#1249.
david-waltermire added a commit that referenced this issue Sep 27, 2022
@david-waltermire @aj-stein-nist
@wendellpiez @Rene2mt
Updates to OSCAL Metaschema documentation and constraints (#1263)
39477fd 
* completed partial update of the Metadata object documentation.
* adjustments to roles
* adjusted the cardinality of location/address to make address optional.
* Improved documentation and constraints related to location and parties
* addressed the remainder of metadata and control feedback from @Rene2mt.
* Improved the introductory remarks for a profile to better describe what a profile is and what it does.
* Fixed a broken constraint that was not targeting the right node.
* started refining descriptions and adding properties to describe identifier attributes.
* Addressed feedback from AJ during 20220718-20220722. (#48)
* Week 30 feedback on SSP model. (#49)
* Proposed metaschema docs updates (#50)
* Addressed feedback based on #1392
* Adjustments based on model review feedback on 8/12.
* Removed outdated merge phase remarks. Created issue #53 to address this.
* Addressed A.J. Stein's Week 32 Feedback for Model Review (#52)
* Addressed AJ Stein's week 32 feedback for #1331.
* Addressed DRAFT: Update catalog & profile metaschema documentation (#51)
* Update catalog & profile metaschema documentation
* Add props to control identifier
* Fixed broken syntax and addressed consistency in wording within the Profile 'merge' construct.
* Adjustments to alter, moving to to an inline definition
* cleaned up empty remark.
* Removed redundant constraints
* removed some redundant constraints
* Preliminary work on URI documentation to address #1249.
* More work on document URI use in OSCAL
* Updating data types related to usnistgov/metaschema#224.
* Improved consistency of how URI concepts are discussed.
* Added note about party locations
* Updated Metaschema instances of `uri` and `uri-reference` data types to indicate their URI semantics. Resolves #1249.
* Added identifier props to control layer metaschemas (#55)
* Responding to #1066: metaschema edits; CSS enhancement (#56)
* Whitespace cleanup in metadata metaschema
* Apply suggestions from code review

Co-authored-by: Alexander Stein <alexander.stein@nist.gov>
Co-authored-by: Wendell Piez <wapiez@wendellpiez.com>
Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>
Repository owner moved this from Under Review to Done in NIST OSCAL Work Board Sep 27, 2022
aj-stein-nist added a commit that referenced this issue Oct 18, 2022
@david-waltermire @aj-stein-nist
@wendellpiez @Rene2mt
Updates to OSCAL Metaschema documentation and constraints (#1263)
52b81c9 
* completed partial update of the Metadata object documentation.
* adjustments to roles
* adjusted the cardinality of location/address to make address optional.
* Improved documentation and constraints related to location and parties
* addressed the remainder of metadata and control feedback from @Rene2mt.
* Improved the introductory remarks for a profile to better describe what a profile is and what it does.
* Fixed a broken constraint that was not targeting the right node.
* started refining descriptions and adding properties to describe identifier attributes.
* Addressed feedback from AJ during 20220718-20220722. (#48)
* Week 30 feedback on SSP model. (#49)
* Proposed metaschema docs updates (#50)
* Addressed feedback based on #1392
* Adjustments based on model review feedback on 8/12.
* Removed outdated merge phase remarks. Created issue #53 to address this.
* Addressed A.J. Stein's Week 32 Feedback for Model Review (#52)
* Addressed AJ Stein's week 32 feedback for #1331.
* Addressed DRAFT: Update catalog & profile metaschema documentation (#51)
* Update catalog & profile metaschema documentation
* Add props to control identifier
* Fixed broken syntax and addressed consistency in wording within the Profile 'merge' construct.
* Adjustments to alter, moving to to an inline definition
* cleaned up empty remark.
* Removed redundant constraints
* removed some redundant constraints
* Preliminary work on URI documentation to address #1249.
* More work on document URI use in OSCAL
* Updating data types related to usnistgov/metaschema#224.
* Improved consistency of how URI concepts are discussed.
* Added note about party locations
* Updated Metaschema instances of `uri` and `uri-reference` data types to indicate their URI semantics. Resolves #1249.
* Added identifier props to control layer metaschemas (#55)
* Responding to #1066: metaschema edits; CSS enhancement (#56)
* Whitespace cleanup in metadata metaschema
* Apply suggestions from code review

Co-authored-by: Alexander Stein <alexander.stein@nist.gov>
Co-authored-by: Wendell Piez <wapiez@wendellpiez.com>
Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>
david-waltermire added a commit that referenced this issue Oct 31, 2022
@david-waltermire @aj-stein-nist
@wendellpiez @Rene2mt
Updates to OSCAL Metaschema documentation and constraints (#1263)
6f775a4 
* completed partial update of the Metadata object documentation.
* adjustments to roles
* adjusted the cardinality of location/address to make address optional.
* Improved documentation and constraints related to location and parties
* addressed the remainder of metadata and control feedback from @Rene2mt.
* Improved the introductory remarks for a profile to better describe what a profile is and what it does.
* Fixed a broken constraint that was not targeting the right node.
* started refining descriptions and adding properties to describe identifier attributes.
* Addressed feedback from AJ during 20220718-20220722. (#48)
* Week 30 feedback on SSP model. (#49)
* Proposed metaschema docs updates (#50)
* Addressed feedback based on #1392
* Adjustments based on model review feedback on 8/12.
* Removed outdated merge phase remarks. Created issue #53 to address this.
* Addressed A.J. Stein's Week 32 Feedback for Model Review (#52)
* Addressed AJ Stein's week 32 feedback for #1331.
* Addressed DRAFT: Update catalog & profile metaschema documentation (#51)
* Update catalog & profile metaschema documentation
* Add props to control identifier
* Fixed broken syntax and addressed consistency in wording within the Profile 'merge' construct.
* Adjustments to alter, moving to to an inline definition
* cleaned up empty remark.
* Removed redundant constraints
* removed some redundant constraints
* Preliminary work on URI documentation to address #1249.
* More work on document URI use in OSCAL
* Updating data types related to usnistgov/metaschema#224.
* Improved consistency of how URI concepts are discussed.
* Added note about party locations
* Updated Metaschema instances of `uri` and `uri-reference` data types to indicate their URI semantics. Resolves #1249.
* Added identifier props to control layer metaschemas (#55)
* Responding to #1066: metaschema edits; CSS enhancement (#56)
* Whitespace cleanup in metadata metaschema
* Apply suggestions from code review

Co-authored-by: Alexander Stein <alexander.stein@nist.gov>
Co-authored-by: Wendell Piez <wapiez@wendellpiez.com>
Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jan 10, 2023
@david-waltermire @aj-stein-nist
@wendellpiez @Rene2mt
Updates to OSCAL Metaschema documentation and constraints (usnistgov#…
d1902c3 
…1263)

* completed partial update of the Metadata object documentation.
* adjustments to roles
* adjusted the cardinality of location/address to make address optional.
* Improved documentation and constraints related to location and parties
* addressed the remainder of metadata and control feedback from @Rene2mt.
* Improved the introductory remarks for a profile to better describe what a profile is and what it does.
* Fixed a broken constraint that was not targeting the right node.
* started refining descriptions and adding properties to describe identifier attributes.
* Addressed feedback from AJ during 20220718-20220722. (#48)
* Week 30 feedback on SSP model. (#49)
* Proposed metaschema docs updates (#50)
* Addressed feedback based on usnistgov#1392
* Adjustments based on model review feedback on 8/12.
* Removed outdated merge phase remarks. Created issue #53 to address this.
* Addressed A.J. Stein's Week 32 Feedback for Model Review (#52)
* Addressed AJ Stein's week 32 feedback for usnistgov#1331.
* Addressed DRAFT: Update catalog & profile metaschema documentation (#51)
* Update catalog & profile metaschema documentation
* Add props to control identifier
* Fixed broken syntax and addressed consistency in wording within the Profile 'merge' construct.
* Adjustments to alter, moving to to an inline definition
* cleaned up empty remark.
* Removed redundant constraints
* removed some redundant constraints
* Preliminary work on URI documentation to address usnistgov#1249.
* More work on document URI use in OSCAL
* Updating data types related to usnistgov/metaschema#224.
* Improved consistency of how URI concepts are discussed.
* Added note about party locations
* Updated Metaschema instances of `uri` and `uri-reference` data types to indicate their URI semantics. Resolves usnistgov#1249.
* Added identifier props to control layer metaschemas (#55)
* Responding to usnistgov#1066: metaschema edits; CSS enhancement (#56)
* Whitespace cleanup in metadata metaschema
* Apply suggestions from code review

Co-authored-by: Alexander Stein <alexander.stein@nist.gov>
Co-authored-by: Wendell Piez <wapiez@wendellpiez.com>
Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Feb 6, 2023
@david-waltermire @aj-stein-nist
@wendellpiez @Rene2mt
Updates to OSCAL Metaschema documentation and constraints (usnistgov#…
f5a03e7 
…1263)

* completed partial update of the Metadata object documentation.
* adjustments to roles
* adjusted the cardinality of location/address to make address optional.
* Improved documentation and constraints related to location and parties
* addressed the remainder of metadata and control feedback from @Rene2mt.
* Improved the introductory remarks for a profile to better describe what a profile is and what it does.
* Fixed a broken constraint that was not targeting the right node.
* started refining descriptions and adding properties to describe identifier attributes.
* Addressed feedback from AJ during 20220718-20220722. (#48)
* Week 30 feedback on SSP model. (#49)
* Proposed metaschema docs updates (#50)
* Addressed feedback based on usnistgov#1392
* Adjustments based on model review feedback on 8/12.
* Removed outdated merge phase remarks. Created issue #53 to address this.
* Addressed A.J. Stein's Week 32 Feedback for Model Review (#52)
* Addressed AJ Stein's week 32 feedback for usnistgov#1331.
* Addressed DRAFT: Update catalog & profile metaschema documentation (#51)
* Update catalog & profile metaschema documentation
* Add props to control identifier
* Fixed broken syntax and addressed consistency in wording within the Profile 'merge' construct.
* Adjustments to alter, moving to to an inline definition
* cleaned up empty remark.
* Removed redundant constraints
* removed some redundant constraints
* Preliminary work on URI documentation to address usnistgov#1249.
* More work on document URI use in OSCAL
* Updating data types related to usnistgov/metaschema#224.
* Improved consistency of how URI concepts are discussed.
* Added note about party locations
* Updated Metaschema instances of `uri` and `uri-reference` data types to indicate their URI semantics. Resolves usnistgov#1249.
* Added identifier props to control layer metaschemas (#55)
* Responding to usnistgov#1066: metaschema edits; CSS enhancement (#56)
* Whitespace cleanup in metadata metaschema
* Apply suggestions from code review

Co-authored-by: Alexander Stein <alexander.stein@nist.gov>
Co-authored-by: Wendell Piez <wapiez@wendellpiez.com>
Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jun 29, 2023
@david-waltermire @aj-stein-nist
@wendellpiez @Rene2mt
Updates to OSCAL Metaschema documentation and constraints (usnistgov#…
ffd5032 
…1263)

* completed partial update of the Metadata object documentation.
* adjustments to roles
* adjusted the cardinality of location/address to make address optional.
* Improved documentation and constraints related to location and parties
* addressed the remainder of metadata and control feedback from @Rene2mt.
* Improved the introductory remarks for a profile to better describe what a profile is and what it does.
* Fixed a broken constraint that was not targeting the right node.
* started refining descriptions and adding properties to describe identifier attributes.
* Addressed feedback from AJ during 20220718-20220722. (#48)
* Week 30 feedback on SSP model. (#49)
* Proposed metaschema docs updates (#50)
* Addressed feedback based on usnistgov#1392
* Adjustments based on model review feedback on 8/12.
* Removed outdated merge phase remarks. Created issue #53 to address this.
* Addressed A.J. Stein's Week 32 Feedback for Model Review (#52)
* Addressed AJ Stein's week 32 feedback for usnistgov#1331.
* Addressed DRAFT: Update catalog & profile metaschema documentation (#51)
* Update catalog & profile metaschema documentation
* Add props to control identifier
* Fixed broken syntax and addressed consistency in wording within the Profile 'merge' construct.
* Adjustments to alter, moving to to an inline definition
* cleaned up empty remark.
* Removed redundant constraints
* removed some redundant constraints
* Preliminary work on URI documentation to address usnistgov#1249.
* More work on document URI use in OSCAL
* Updating data types related to usnistgov/metaschema#224.
* Improved consistency of how URI concepts are discussed.
* Added note about party locations
* Updated Metaschema instances of `uri` and `uri-reference` data types to indicate their URI semantics. Resolves usnistgov#1249.
* Added identifier props to control layer metaschemas (#55)
* Responding to usnistgov#1066: metaschema edits; CSS enhancement (#56)
* Whitespace cleanup in metadata metaschema
* Apply suggestions from code review

Co-authored-by: Alexander Stein <alexander.stein@nist.gov>
Co-authored-by: Wendell Piez <wapiez@wendellpiez.com>
Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jul 10, 2023
@david-waltermire @aj-stein-nist
@wendellpiez @Rene2mt
Updates to OSCAL Metaschema documentation and constraints (usnistgov#…
988817c 
…1263)

* completed partial update of the Metadata object documentation.
* adjustments to roles
* adjusted the cardinality of location/address to make address optional.
* Improved documentation and constraints related to location and parties
* addressed the remainder of metadata and control feedback from @Rene2mt.
* Improved the introductory remarks for a profile to better describe what a profile is and what it does.
* Fixed a broken constraint that was not targeting the right node.
* started refining descriptions and adding properties to describe identifier attributes.
* Addressed feedback from AJ during 20220718-20220722. (#48)
* Week 30 feedback on SSP model. (#49)
* Proposed metaschema docs updates (#50)
* Addressed feedback based on usnistgov#1392
* Adjustments based on model review feedback on 8/12.
* Removed outdated merge phase remarks. Created issue #53 to address this.
* Addressed A.J. Stein's Week 32 Feedback for Model Review (#52)
* Addressed AJ Stein's week 32 feedback for usnistgov#1331.
* Addressed DRAFT: Update catalog & profile metaschema documentation (#51)
* Update catalog & profile metaschema documentation
* Add props to control identifier
* Fixed broken syntax and addressed consistency in wording within the Profile 'merge' construct.
* Adjustments to alter, moving to to an inline definition
* cleaned up empty remark.
* Removed redundant constraints
* removed some redundant constraints
* Preliminary work on URI documentation to address usnistgov#1249.
* More work on document URI use in OSCAL
* Updating data types related to usnistgov/metaschema#224.
* Improved consistency of how URI concepts are discussed.
* Added note about party locations
* Updated Metaschema instances of `uri` and `uri-reference` data types to indicate their URI semantics. Resolves usnistgov#1249.
* Added identifier props to control layer metaschemas (#55)
* Responding to usnistgov#1066: metaschema edits; CSS enhancement (#56)
* Whitespace cleanup in metadata metaschema
* Apply suggestions from code review

Co-authored-by: Alexander Stein <alexander.stein@nist.gov>
Co-authored-by: Wendell Piez <wapiez@wendellpiez.com>
Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>
aj-stein-nist added a commit to galtm/OSCAL that referenced this issue Sep 28, 2023
@david-waltermire @aj-stein-nist
@wendellpiez @Rene2mt
Updates to OSCAL Metaschema documentation and constraints (usnistgov#…
947048d 
…1263)

* completed partial update of the Metadata object documentation.
* adjustments to roles
* adjusted the cardinality of location/address to make address optional.
* Improved documentation and constraints related to location and parties
* addressed the remainder of metadata and control feedback from @Rene2mt.
* Improved the introductory remarks for a profile to better describe what a profile is and what it does.
* Fixed a broken constraint that was not targeting the right node.
* started refining descriptions and adding properties to describe identifier attributes.
* Addressed feedback from AJ during 20220718-20220722. (#48)
* Week 30 feedback on SSP model. (#49)
* Proposed metaschema docs updates (#50)
* Addressed feedback based on usnistgov#1392
* Adjustments based on model review feedback on 8/12.
* Removed outdated merge phase remarks. Created issue #53 to address this.
* Addressed A.J. Stein's Week 32 Feedback for Model Review (#52)
* Addressed AJ Stein's week 32 feedback for usnistgov#1331.
* Addressed DRAFT: Update catalog & profile metaschema documentation (#51)
* Update catalog & profile metaschema documentation
* Add props to control identifier
* Fixed broken syntax and addressed consistency in wording within the Profile 'merge' construct.
* Adjustments to alter, moving to to an inline definition
* cleaned up empty remark.
* Removed redundant constraints
* removed some redundant constraints
* Preliminary work on URI documentation to address usnistgov#1249.
* More work on document URI use in OSCAL
* Updating data types related to usnistgov/metaschema#224.
* Improved consistency of how URI concepts are discussed.
* Added note about party locations
* Updated Metaschema instances of `uri` and `uri-reference` data types to indicate their URI semantics. Resolves usnistgov#1249.
* Added identifier props to control layer metaschemas (#55)
* Responding to usnistgov#1066: metaschema edits; CSS enhancement (#56)
* Whitespace cleanup in metadata metaschema
* Apply suggestions from code review

Co-authored-by: Alexander Stein <alexander.stein@nist.gov>
Co-authored-by: Wendell Piez <wapiez@wendellpiez.com>
Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@david-waltermire david-waltermire

Labels
enhancement Scope: Documentation This issue relates to OSCAL documentation. Scope: Metaschema Issues targeted at the metaschema pipeline User Story
Projects
NIST OSCAL Work Board
Status: Done
Milestone
v1.1.0
Development

Successfully merging a pull request may close this issue.

Updates to OSCAL Metaschema documentation and constraints david-waltermire/OSCAL
2 participants
@GaryGapinski @david-waltermire