Json schema for include-control
in assessment plan is inconsistent with website documentation
#769
Labels
bug
closable
model-refactor
Used to mark issues related to model refactoring for the Metaschema v4 transition.
Scope: Modeling
Issues targeted at development of OSCAL formats
Scope: Website
Issues targeted at the OSCAL project website.
Milestone
Describe the bug
Current website documentation for assessment plan - specifically the json schema map here: https://pages.nist.gov/OSCAL/documentation/schema/assessment-layer/assessment-plan/json-model-map/
states that the STRVALUE within the
include-control
object is optional. Underlying json schema (e.g. https://github.com/usnistgov/OSCAL/blob/master/json/schema/oscal_assessment-plan_schema.json) has the field as required:Who is the bug affecting?
Users of the documentation & assessment plan
What is affected by this bug?
Users reading the document will face unexpected errors when validating.
When does this occur?
When validating assessment plans where user has chosen not to set at
STRVALUE
for ainclude-control
based on viewing the json schema mapHow do we replicate the issue?
Create an assessment plan with one
include-control
. Do not set STRVALUE, and run arv over the json file with the current schema.Expected behavior (i.e. solution)
It appears on first inspection that the STRVALUE should not be required. I'm not sure whether this is a metaschema generation issue. Appears to be linked to #388
Other Comments
External linked issue: oscal-compass/compliance-trestle#150
The text was updated successfully, but these errors were encountered: