References specific to a component's "satisfies" are not rendered

[aegershman]

The opencontrol schema 3.1.0 appears to accept references in the context of one of a component's satisfies block for specific controls (https://github.com/opencontrol/schemas/blob/5b3090c911a34dfec1cf9b2b27421651bcea5aa9/kwalify/component/v3.1.0.yaml#L75)

However it looks like those references aren't rendered to the page in the context of a specific control as per this code here (

compliance-masonry/pkg/cli/docs/gitbook/gitbookCertification.go

Lines 97 to 125 in 70bb337

	key := masonryutil.FileNameHandler(fmt.Sprintf("%s-%s", control.standardKey, control.controlKey))
	text := fmt.Sprintf("# %s\n## %s\n", key, control.GetName())
	if len(control.GetDescription()) > 0 {
	text += "#### Description\n"
	text += control.GetDescription()
	}
	selectJustifications := openControl.GetAllVerificationsWith(control.standardKey, control.controlKey)
	// In the case that no information was found period for the standard and control
	if len(selectJustifications) == 0 {
	errorText := fmt.Sprintf("No information found for the combination of standard %s and control %s", control.standardKey, control.controlKey)
	text = fmt.Sprintf("%s\n%s\n", text, errorText)
	}
	for _, justification := range selectJustifications {
	component, found := openControl.GetComponent(justification.ComponentKey)
	if !found {
	continue
	}
	text = fmt.Sprintf("%s\n#### %s\n", text, component.GetName())
	text = openControl.getResponsibleRole(text, component)
	text = openControl.getParameters(text, justification.SatisfiesData.GetParameters())
	text = openControl.getControlOrigin(text, justification.SatisfiesData.GetControlOrigin())
	text = openControl.getNarratives(justification.SatisfiesData.GetNarratives(), text, control)
	text = openControl.getCoveredBy(text, justification)
	}
	return filepath.Join(control.exportPath, key+".md"), text

)

general references at the root of a component document appear to be rendered when looking at the overall component page, but not when looking at a specific control

👍 just logging for potential backlog consideration

see also:

• The component "satisfies" map type should accept a "references" property that accepts a sequence of URLs, etc schemas#64
• Add a "references" section in each "satisfies" entry schemas#70
• potentially Schema models are version-aware, but CLI tool is not #263