-
Notifications
You must be signed in to change notification settings - Fork 235
Enhancing 'link' to indicate internal targets in a 'resource' #756
Copy link
Copy link
Closed
Labels
Discussion NeededThis issues needs to be reviewed by the OSCAL development team.This issues needs to be reviewed by the OSCAL development team.Model EngineeringAn issue to be discussed during the bi-weekly Model Engineering MeetingAn issue to be discussed during the bi-weekly Model Engineering MeetingScope: ModelingIssues targeted at development of OSCAL formatsIssues targeted at development of OSCAL formatsUser Storyenhancementmodel-refactorUsed to mark issues related to model refactoring for the Metaschema v4 transition.Used to mark issues related to model refactoring for the Metaschema v4 transition.
Milestone
Metadata
Metadata
Assignees
Labels
Discussion NeededThis issues needs to be reviewed by the OSCAL development team.This issues needs to be reviewed by the OSCAL development team.Model EngineeringAn issue to be discussed during the bi-weekly Model Engineering MeetingAn issue to be discussed during the bi-weekly Model Engineering MeetingScope: ModelingIssues targeted at development of OSCAL formatsIssues targeted at development of OSCAL formatsUser Storyenhancementmodel-refactorUsed to mark issues related to model refactoring for the Metaschema v4 transition.Used to mark issues related to model refactoring for the Metaschema v4 transition.
Type
Projects
Status
Done
User Story:
Sometimes I need my data to point not just to a document, but to a location inside that document, as in
<link href="target.xml#id1"/>to point to an element withid="id1"in a document found attarget.xml.This doesn't work, however, when using an indirect link via
resourceinside an OSCAL file:By OSCAL link traversal, a link to a
resourceresolves into a link to the resource itself. However, this does not help us to target an identified location inside that resource.Goals:
One simple solution would be to provide
linkwith a new flag such asref-id, to indicate the ID of a target within a linked resource.@ref-idwould effectively alias the href#fragment identifier syntax inside@hrefvalues, but would also work on targets indicated by reference toresourceelements.If "ref-id" is too ambiguous (it should not be the ID of the resource but a string representing an ID inside the document it references) we could come up with another name.
This idea would be much easier for developers to support than the proposal outlined in #567 addressing the same requirement.
Dependencies:
This proposal addresses the requirement described in Issue #567, albeit with a different mechanism. (Instead of extending the W3C-defined href linking syntax, we use OSCAL). If this proposal is adopted, we can close #567 and spin part of its effort (describing / documenting link construction) into a separate one.
Additionally, this Issue could be included in the work for #597 (an epic covering model enhancements).
Also, update the document, model, or constraint additions with changes in PR associated with #1023 following its approval and merge in the context of this work, although not an explicit dependency. See #1023 (comment) for more details.
Acceptance Criteria