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

Adjust direction prop constraint and other related constraints for interconnection and other network components #2077

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from

Conversation

aj-stein-gsa
Copy link

@aj-stein-gsa aj-stein-gsa commented Nov 19, 2024

Committer Notes

Closes #1913.

All Submissions:

By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.

(For reviewers: The wiki has guidance on code review and overall issue review for completeness.)

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you included examples of how to use your new feature(s)?
  • Have you updated all OSCAL website and readme documentation affected by the changes you made? Changes to the OSCAL website can be made in the docs/content directory of your branch.

The information appears to repeat information about a related prop name
regarding IPv6 connectivity.
This adds the prop constraint as requested in usnistgov#1913 feedback. Also align
enum doc strings to be consistent in the props for future refactoring
entity file refactoring in the following commit.
As there will duplicate values when they really need to be identical and
the enum documentation strings were previously aligned, it is prudent to
refactor the reused enum values and doc strings using the shared entity
file pattern per other shared allowed-values enum sets in this model
definition and others.
@aj-stein-gsa aj-stein-gsa requested a review from a team as a code owner November 19, 2024 04:16
</allowed-values>
<allowed-values target="[@type=('service', 'software')]/prop[has-oscal-namespace('http://csrc.nist.gov/ns/oscal')]/@name">
Copy link
Author

Choose a reason for hiding this comment

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

Per discussion in #1913 and refining the issue as posed by the comment in #1913 (comment), I am not sure why leveraged system typed components would not have similar need for like software and service, but I wanted to leave that open to interpretation here during the PR review.

Suggested change
<allowed-values target="[@type=('service', 'software')]/prop[has-oscal-namespace('http://csrc.nist.gov/ns/oscal')]/@name">
<allowed-values target="[@type=('service', 'software', 'system')]/prop[has-oscal-namespace('http://csrc.nist.gov/ns/oscal')]/@name">

@@ -213,6 +215,7 @@
<matches target="prop[has-oscal-namespace('http://csrc.nist.gov/ns/oscal') and @name='isa-date']/@value" datatype="date-time"/>
<matches target="prop[has-oscal-namespace('http://csrc.nist.gov/ns/oscal') and @name='ipv4-address']/@value" datatype="ip-v4-address" />
<matches target="prop[has-oscal-namespace('http://csrc.nist.gov/ns/oscal') and @name='ipv6-address']/@value" datatype="ip-v6-address" />
<matches target="prop[has-oscal-namespace('http://csrc.nist.gov/ns/oscal') and @name='uri']/@value" datatype="uri" />
Copy link
Author

Choose a reason for hiding this comment

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

This was not explicitly requested in #1913 (comment), but it standards to reason we make sure it is a URI, not just a string value for a prop with the .[@name="uri"]. Open question: the documentation string defines this as a URI, we are sure we do not mean a URL to access the interconnect with a given scheme/authority, host, path, or is it really just an identifier. I think some (Brian and Michaela know this detail), but URIs and URLs are related in terms of type signature. In Metaschema, they would use the same type.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant