fix: provide description and meaning to parameters in markdown

Signed-off-by: Alejandro Jose Leiva Palomo <alejandro.leiva.palomo@ibm.com>
oscal-compass · Jul 6, 2023 · 7607153 · 7607153
1 parent 7b8cad0
commit 7607153
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/trestle/common/const.py b/trestle/common/const.py
@@ -441,6 +441,8 @@
 
 VALUES = 'values'
 
+GUIDELINES = 'guidelines'
+
 SECTIONS_TAG = TRESTLE_TAG + 'sections'
 
 EDITABLE_CONTENT = 'Editable Content'

diff --git a/trestle/common/model_utils.py b/trestle/common/model_utils.py
@@ -536,7 +536,7 @@ def _parameter_to_dict_recurse(obj: Union[OscalBaseModel, str], partial: bool) -
         Returns:
             The converted parameter as dictionary
         """
-        main_fields = ['id', 'label', 'values', 'select', 'choice', 'how_many']
+        main_fields = ['id', 'label', 'values', 'select', 'choice', 'how_many', 'guidelines', 'prose']
         if isinstance(obj, common.Remarks):
             return obj.__root__
         if isinstance(obj, common.HowMany):

diff --git a/trestle/core/catalog/catalog_writer.py b/trestle/core/catalog/catalog_writer.py
@@ -173,7 +173,7 @@ def _construct_set_parameters_dict(
                     # pull only the values from the actual control dict
                     # all the other elements are from the profile set_param
                     new_dict[const.VALUES] = orig_dict.get(const.VALUES, None)
-            else:
+                    new_dict[const.GUIDELINES] = orig_dict.get(const.GUIDELINES, None)
                 # if the profile doesnt change this param at all, show it in the header with values
                 tmp_dict = ModelUtils.parameter_to_dict(param_dict, True)
                 values = tmp_dict.get('values', None)