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

Add actions assembly to encode an action (i.e. approval) and its role, party, and approval date. #1052

Merged
merged 2 commits into from
Aug 25, 2022
Merged

Add actions assembly to encode an action (i.e. approval) and its role, party, and approval date. #1052

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d33bf3
Create actions assembly in OSCAL metadata model.
xee5ch Nov 12, 2021
1c6be8a
Address PR feedback to wrap up.
xee5ch Aug 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions src/metaschema/oscal_metadata_metaschema.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@
<assembly ref="responsible-party" max-occurs="unbounded">
<group-as name="responsible-parties" in-json="ARRAY"/>
</assembly>
<assembly ref="action" max-occurs="unbounded">
<group-as name="actions" in-json="ARRAY"/>
</assembly>
<field ref="remarks" in-xml="WITH_WRAPPER"/>
</model>
<constraint>
Expand Down Expand Up @@ -759,6 +762,59 @@
</index-has-key>
</constraint>
</define-assembly>

<define-assembly name="action">
<formal-name>Action</formal-name>
<description>An action applied by a role within a given party to the content.</description>
<define-flag name="uuid" as-type="uuid" required="yes">
<formal-name>Action Universally Unique Identifier</formal-name>
<description>A unique identifier that can be used to reference this defined action elsewhere in an OSCAL document. A UUID should be consistently used for a given location across revisions of the document.</description>
</define-flag>
<define-flag name="date" as-type="dateTime-with-timezone">
<formal-name>Action Occurrence Date</formal-name>
<description>The date and time when the action occurred.</description>
</define-flag>
<define-flag name="type" as-type="token" required="yes">
<formal-name>Action Type</formal-name>
<description>The type of action documented by the assembly, such as an approval.</description>
</define-flag>
xee5ch marked this conversation as resolved.
Show resolved Hide resolved
<define-flag name="system" as-type="uri" required="yes">
<formal-name>Action Type System</formal-name>
<description>Specifies the action type system used.</description>
xee5ch marked this conversation as resolved.
Show resolved Hide resolved
<remarks>
<p>Provides a means to segment the value space for the <code>type</code>, so that different organizations and individuals can assert control over the allowed <code>action</code>'s <code>type</code>. This allows the semantics associated with a given <code>type</code> to be defined on an organization-by-organization basis.</p>
<p>An organization MUST use a URI that they have control over. e.g., a domain registered to the organization in a URI, a registered uniform resource names (URN) namespace.</p>
</remarks>
</define-flag>
<model>
<assembly ref="property" max-occurs="unbounded">
<group-as name="props" in-json="ARRAY"/>
</assembly>
<assembly ref="link" max-occurs="unbounded">
<group-as name="links" in-json="ARRAY"/>
</assembly>
<assembly ref="responsible-party" max-occurs="unbounded">
<group-as name="responsible-parties" in-json="ARRAY"/>
</assembly>
<field ref="remarks" in-xml="WITH_WRAPPER"/>
</model>
<constraint>
<index-has-key name="index-metadata-role-id" target="responsible-party">
<key-field target="@role-id"/>
</index-has-key>
<index-has-key name="index-metadata-party-uuid" target="responsible-party">
<key-field target="party-uuid"/>
</index-has-key>
<allowed-values target="./system/@value" allow-other="yes">
<enum value="http://csrc.nist.gov/ns/oscal">This value identifies action types defined in the NIST OSCAL namespace.</enum>
</allowed-values>
<allowed-values target="./type[has-oscal-namespace('http://csrc.nist.gov/ns/oscal')]/@value">
<enum value="approval">An approval of a document instance's content.</enum>
<enum value="request-changes">A request from the responisble party or parties to change the content.</enum>
</allowed-values>
</constraint>
</define-assembly>

<define-assembly name="responsible-role">
<formal-name>Responsible Role</formal-name>
<description>A reference to one or more roles with responsibility for performing a function relative to the containing object.</description>
Expand Down