Skip to content

Commit dfb56e0

Browse files
wendellpiezDavid Waltermire
authored andcommitted
Profile Resolution spec: updated names of 'remove' directives (#1381)
* Profile Resolution spec: updated names of 'remove' directives * Resolves #1246. Also repairs a few errors in surrounding copy. * Adding swap space to address Hugo memory exhaustion. Co-authored-by: David Waltermire <david.waltermire@nist.gov>
1 parent 0dcc243 commit dfb56e0

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

.github/workflows/workflow-generate-website.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,11 @@ jobs:
9797
cd "${BUILD_PATH}"
9898
mkdir -p "${JAVA_CLASSPATH}"
9999
mvn dependency:copy-dependencies -DoutputDirectory="${JAVA_CLASSPATH}"
100+
- name: Setup Swap Space
101+
# Since Hugo is requiring more memory
102+
uses: pierotofy/set-swap-space@49819abfb41bd9b44fb781159c033dba90353a7c
103+
with:
104+
swap-size-gb: 10
100105
# Build Artifacts
101106
# ---------------
102107
- name: Generate specification documentation

src/specifications/profile-resolution/profile-resolution-specml.xml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1325,27 +1325,28 @@ control:
13251325
<ul>
13261326
<li>
13271327
<p>
1328-
<req level="must" id="req-modify-alter-remove-by-id">The remove directive criteria <src>by-id</src> MUST match an object if and only if its value is identical to the <src>id</src> value of that object.</req> Because
1329-
<src>id</src> values are unique, this criteria will result in the remove directive removing only a single object.
1328+
<req level="must" id="req-modify-alter-remove-by-id">The remove directive criterion <src>by-id</src> MUST match an object if and only if its value is identical to the <src>id</src> value of that object.</req> Because
1329+
<src>id</src> values are unique, this criterion has the effect of removing a single object.
13301330
</p>
13311331
</li>
13321332
<li>
13331333
<p>
1334-
<req level="must" id="req-modify-alter-remove-name-ref">The remove directive criteria <src>name-ref</src> MUST match an object if and only if its value is identical to the value of that object's <src>name</src> child.</req>
1334+
<req level="must" id="req-modify-alter-remove-name-ref">The remove directive criterion <src>by-name</src> MUST match an object if and only if its value is identical to the value of that object's <src>name</src> child.</req>
13351335
</p>
13361336
</li>
13371337
<li>
1338-
<p><req level="must" id="req-modify-alter-remove-ns-ref">The remove directive criteria <src>ns-ref</src> MUST match an object if and only if its value is identical to the value of that object's <src>ns</src> child.</req></p>
1338+
<p><req level="must" id="req-modify-alter-remove-ns-ref">The remove directive criterion <src>by-ns</src> MUST match an object if and only if its value is identical to the value of that object's <src>ns</src> child. This directive
1339+
is intended to be used in combination with <src>by-name</src> but may also be used to match all objects assigned to a given namespace (<src>ns</src>). Note that <src>by-ns="http://csrc.nist.gov/ns/oscal"</src> will address objects assigned to that namespace by default (where no explicit <src>ns</src> is given).</req></p>
13391340
</li>
13401341
<li>
1341-
<p><req level="must" id="req-modify-alter-remove-class-ref">The remove directive criteria <src>class-ref</src> MUST match an object if and only if its value is identical to the value of that object's <src>class</src> child.</req></p>
1342+
<p><req level="must" id="req-modify-alter-remove-class-ref">The remove directive criterion <src>by-class</src> MUST match an object if and only if its value is identical to the value of that object's <src>class</src> child.</req></p>
13421343
</li>
13431344
<li>
1344-
<p><req level="must" id="req-modify-alter-remove-item-name">The remove directive criteria <src>item-name</src> MUST match an object if and only if its value is identical to the value of that object's serialized name.</req> For example,
1345-
<code>remove:item-name:prop</code> has the effect of removing all
1346-
<src>prop</src>objects from inside the control.
1345+
<p><req level="must" id="req-modify-alter-remove-item-name">The remove directive criterion <src>by-item-name</src> MUST match an object if and only if its value is identical to the value of that object's serialized name.</req> For example,
1346+
<code>remove.by-item-name: "prop"</code> has the effect of removing all
1347+
<src>prop</src> objects from inside the control.
13471348
</p>
1348-
<p><req level="must" id="req-modify-alter-remove-item-name-array">In serialization formats that use arrays of objects in the OSCAL model, an object's name MUST be referenced as singular form of its containing parent array. </req> For example, in the JSON format, remove:item-name:link would remove all of the objects inside of the <src>links</src> array. </p>
1349+
<p><req level="must" id="req-modify-alter-remove-item-name-array">In serialization formats that represent objects as (unlabeled) members of arrays, an object's name MUST be referenced in its (implicit) singular form, not the name of its containing array.</req> For example, in the JSON format, <src>remove.item-name: "link"</src> would remove all members of the <src>links</src> array, along with the array itself (as being empty it would no longer be valid). </p>
13491350
</li>
13501351
</ul>
13511352
</section>

0 commit comments

Comments
 (0)