Skip to content

Commit

Permalink
Add actions assembly to encode an action (i.e. approval) and its role…
Browse files Browse the repository at this point in the history
…, party, and approval date. (usnistgov#1052) (usnistgov#1429)

* Create actions assembly in OSCAL metadata model.
* Address PR feedback to wrap up.

usnistgov#1052 (review)
usnistgov#1052 (comment)

Co-authored-by: Al S <[email protected]>
  • Loading branch information
aj-stein-nist and xee5ch committed Feb 6, 2023
1 parent 51bf106 commit 47525f0
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions src/metaschema/oscal_metadata_metaschema.xml
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>
<define-flag name="system" as-type="uri" required="yes">
<formal-name>Action Type System</formal-name>
<description>Specifies the action type system used.</description>
<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

0 comments on commit 47525f0

Please sign in to comment.