Skip to content

Commit

Permalink
Merge branch 'develop' into release-1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@david-waltermire
david-waltermire committed Jun 8, 2021
2 parents 5a65bd8 + 2257a4a commit 67a9b70
Show file tree
Hide file tree
Showing 34 changed files with 1,094 additions and 696 deletions.
20 changes: 10 additions & 10 deletions .github/workflows/website.yml → .github/workflows/website-deploy.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@ on:
push:
branches:
- main
- develop
paths:
- 'docs/**'
- '.github/workflows/website.yml'
- '.github/workflows/website-deploy.yml'
- 'xml'
- 'json'
workflow_dispatch:
branches:
- main
- develop
name: Build and Publish Website
env:
# the name of the repo
HOME_REPO: usnistgov/OSCAL
HOME_BRANCH: develop
HOME_BRANCH: main
# dependency versions
HUGO_VERSION: 0.83.1
# build-specific environment
Expand Down Expand Up @@ -75,9 +75,9 @@ jobs:
# run: |
# cd "${OSCAL_WEBSITE_PATH}"
# bundle exec htmlproofer public/ --check-external-hash --url-swap "https\://pages.nist.gov/OSCAL/:/" --assume-extension --log-level :debug --url-ignore "\/reference\//,/pages.nist.gov\/(?:nist-header-footer|leaveNotice)\/.+/"
# - name: Run deploy script
# if: ${{ github.repository == env.HOME_REPO && github.ref == format('refs/heads/{0}',env.HOME_BRANCH) }}
# run: |
# cd "$OSCAL_WEBSITE_PATH"
# git config user.name "Deployment Bot"
# bash ./deploy.sh --push-only -v -m "Deploying website [ci deploy skip]"
- name: Run deploy script
if: ${{ github.repository == env.HOME_REPO && github.ref == format('refs/heads/{0}',env.HOME_BRANCH) }}
run: |
cd "$OSCAL_WEBSITE_PATH"
git config user.name "Deployment Bot"
bash ./deploy.sh --push-only -v -m "Deploying website [ci deploy skip]"
2 changes: 1 addition & 1 deletion build/metaschema
Submodule metaschema updated 8 files
+3 −1 toolchains/xslt-M4/compose/make-model-map.xsl
+2 −4 toolchains/xslt-M4/converter-gen/produce-json-converter.xsl
+1 −1 toolchains/xslt-M4/converter-gen/produce-xml-converter.xsl
+2 −1 toolchains/xslt-M4/document/json/object-reference-html.xsl
+2 −0 toolchains/xslt-M4/document/json/object-tree.xsl
+67 −4 toolchains/xslt-M4/document/xml/element-reference-html.xsl
+80 −54 toolchains/xslt-M4/metapath/metapath-jsonizing-result.html
+6 −0 toolchains/xslt-M4/metapath/metapath-jsonizing.xspec
7 changes: 7 additions & 0 deletions docs/assets/scss/schema-docs.scss
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,13 @@
}
}
}
&:not([open]) {
summary {
.show-closed {
display: initial;
}
}
}
summary {
cursor: pointer;
list-style-position: outside;
Expand Down
2 changes: 1 addition & 1 deletion docs/content/_index.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "OSCAL"
---
{{% usa-hero image="automation-hero.png" calloutText="Automated" calloutAltText="Control-Based Assessment" buttonURL="/about/" buttonText="Learn More" %}}
{{% usa-hero image="/automation-hero.png" calloutText="Automated" calloutAltText="Control-Based Assessment" buttonURL="/about/" buttonText="Learn More" %}}
Supporting Control-Based<br/>
Risk Management with<br/>
Standardized Formats
Expand Down
136 changes: 82 additions & 54 deletions docs/content/reference/develop/assessment-plan/json-definitions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3101,7 +3101,7 @@ The following is a reference for the JSON object definitions derived from this m
<p class="description"><span class="usa-tag">description</span> Captures an assessor's conclusions regarding the degree to which an objective is
satisfied.</p>
<details open="open">
<summary>Properties (10)</summary>
<summary>Properties (9)</summary>
<div class="model assembly-model">
<div class="model-entry definition define-flag">
<div class="instance-header">
Expand Down Expand Up @@ -3231,68 +3231,96 @@ The following is a reference for the JSON object definitions derived from this m
<p class="definition-link"><a href="#/assembly/oscal-metadata/link">See definition</a></p>
</div>
</div>
<div class="model-entry definition define-field">
<div class="model-entry definition define-assembly">
<div class="instance-header">
<h2 id="/assembly/oscal-assessment-common/finding-target/status" class="toc2 name">status</h2>
<p class="type"><a href="/reference/datatypes/#token">token</a></p>
<p class="type">assembly<br class="br" /> </p>
<p class="occurrence">[1]</p>
<div class="crosslink"><a class="usa-button" href="../xml-definitions/#/assembly/oscal-assessment-common/finding-target/status">Switch to XML</a></div>
<p class="formal-name">Objective Status</p>
</div>
<div class="body">
<p class="description"><span class="usa-tag">description</span> A brief indication as to whether the objective is satisfied or not within a given
system.</p>
<details>
<summary>Constraint (1)</summary>

<div class="constraint">
<p><span class="usa-tag">allowed values</span></p>
<p>The value <b>must</b> be one of the following:</p>
<ul>

<li><strong>satisfied</strong>: The objective has been completely satisfied.</li>

<li><strong>not-satisfied</strong>: The objective has not been completely satisfied, but may be partially satisfied.</li>
</ul>
</div>
</details>
</div>
</div>
<div class="model-entry definition define-field">
<div class="instance-header">
<h2 id="/assembly/oscal-assessment-common/finding-target/reason" class="toc2 name">reason</h2>
<p class="type"><a href="/reference/datatypes/#ncname">NCName</a></p>
<p class="occurrence">[0 to ∞]</p>
<div class="crosslink"><a class="usa-button" href="../xml-definitions/#/assembly/oscal-assessment-common/finding-target/reason">Switch to XML</a></div>
<p class="formal-name">Objective Status Reason</p>
</div>
<div class="body">
<p class="description"><span class="usa-tag">description</span> The reason the objective was given it's status.</p>
<div class="remarks-group usa-prose">
<details open="open">
<summary class="subhead">Remarks</summary>
<div class="remarks">
<p>Reason may contain any value, and should be used to communicate additional information
regarding the status.</p>
<p class="description"><span class="usa-tag">description</span> A determination of if the objective is satisfied or not within a given system.</p>
<details open="open">
<summary>Properties (3)</summary>
<div class="model assembly-model">
<div class="model-entry definition define-flag">
<div class="instance-header">
<h3 id="/assembly/oscal-assessment-common/finding-target/status/state" class="toc3 name">state</h3>
<p class="type"><a href="/reference/datatypes/#token">token</a></p>
<p class="occurrence">[0 or 1]</p>
<div class="crosslink"><a class="usa-button" href="../xml-definitions/#/assembly/oscal-assessment-common/finding-target/status/state">Switch to XML</a></div>
<p class="formal-name">Objective Status State</p>
</div>
<div class="body">
<p class="description"><span class="usa-tag">description</span> An indication as to whether the objective is satisfied or not.</p>
<details>
<summary>Constraint (1)</summary>

<div class="constraint">
<p><span class="usa-tag">allowed values</span></p>
<p>The value <b>must</b> be one of the following:</p>
<ul>

<li><strong>satisfied</strong>: The objective has been completely satisfied.</li>

<li><strong>not-satisfied</strong>: The objective has not been completely satisfied, but may be partially satisfied.</li>
</ul>
</div>
</details>
</div>
</div>
<div class="model-entry definition define-flag">
<div class="instance-header">
<h3 id="/assembly/oscal-assessment-common/finding-target/status/reason" class="toc3 name">reason</h3>
<p class="type"><a href="/reference/datatypes/#token">token</a></p>
<p class="occurrence">[0 or 1]</p>
<div class="crosslink"><a class="usa-button" href="../xml-definitions/#/assembly/oscal-assessment-common/finding-target/status/reason">Switch to XML</a></div>
<p class="formal-name">Objective Status Reason</p>
</div>
<div class="body">
<p class="description"><span class="usa-tag">description</span> The reason the objective was given it's status.</p>
<div class="remarks-group usa-prose">
<details open="open">
<summary class="subhead">Remarks</summary>
<div class="remarks">
<p>Reason may contain any value, and should be used to communicate additional information
regarding the status.</p>
</div>
</details>
</div>
<details>
<summary>Constraint (1)</summary>

<div class="constraint">
<p><span class="usa-tag">allowed values</span></p>
<p>The value <b>may be locally defined</b>, or one of the following:</p>
<ul>

<li><strong>pass</strong>: The target system or system component satisfied all the conditions.</li>

<li><strong>fail</strong>: The target system or system component did not satisfy all the conditions.</li>

<li><strong>other</strong>: Some other event took place that is not a pass or a fail. </li>
</ul>
</div>
</details>
</div>
</div>
<div class="model-entry definition field">
<div class="instance-header">
<h3 id="/assembly/oscal-assessment-common/finding-target/status/remarks" class="toc3 name">remarks</h3>
<p class="type"><a href="/reference/datatypes/#markup-multiline">markup-multiline</a></p>
<p class="occurrence">[0 or 1]</p>
<div class="crosslink"><a class="usa-button" href="../xml-definitions/#/assembly/oscal-assessment-common/finding-target/status/remarks">Switch to XML</a></div>
<p class="formal-name">Remarks</p>
</div>
<div class="body">
<p class="definition-link"><a href="#/field/oscal-metadata/remarks">See definition</a></p>
</div>
</div>
</details>
</div>
<details>
<summary>Constraint (1)</summary>

<div class="constraint">
<p><span class="usa-tag">allowed values</span></p>
<p>The value <b>may be locally defined</b>, or one of the following:</p>
<ul>

<li><strong>pass</strong>: The target system or system component satisfied all the conditions.</li>

<li><strong>fail</strong>: The target system or system component did not satisfy all the conditions.</li>

<li><strong>other</strong>: Some other event took place that is not a pass or a fail. </li>
</ul>
</div>
</details>
</details>
</div>
</div>
<div class="model-entry definition assembly">
Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/develop/assessment-plan/json-reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The following is the JSON format reference for this model, which is organized hi
<p><span class="usa-tag">Schema version:</span> 1.0.0</p>
<p><span class="usa-tag">JSON Base URI</span> <code>http://csrc.nist.gov/ns/oscal</code></p>
<p><span class="usa-tag">JSON Schema</span> <a href="/artifacts/json/schema/oscal_assessment-plan_schema.json">oscal_assessment-plan_schema.json</a></p>
<p><span class="usa-tag">XML to JSON converter</span> <a href="/artifacts/json/convert/oscal_assessment-plan_xml-to-json-converter.xsl">oscal_assessment-plan_xml-to-json-converter.xsl</a><a href="https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json">(How do I use the converter to convert OSCAL XML to JSON?)</a></p>
<p><span class="usa-tag">XML to JSON converter</span> <a href="/artifacts/json/convert/oscal_assessment-plan_xml-to-json-converter.xsl">oscal_assessment-plan_xml-to-json-converter.xsl</a> <a href="https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json">(How do I use the converter to convert OSCAL XML to JSON?)</a></p>
<div class="remarks">The OSCAL assessment plan format is used to describe the information typically provided
by an assessor during the preparation for an assessment.The root of the OSCAL assessment
plan format is assessment-plan. </div>
Expand Down
Loading

0 comments on commit 67a9b70

Please sign in to comment.