# _diagnostic_renderers

URL: /kida/api/_diagnostic_renderers/
Section: api
Description: Private text, JSON, and SARIF renderers for ``kida check`` results.

---

> For a complete page index, fetch /kida/llms.txt.

Open LLM text
(/kida/api/_diagnostic_renderers/index.txt)

Share with AI

Ask Claude
(https://claude.ai/new?q=Please%20help%20me%20understand%20this%20documentation%3A%20%2Fkida%2Fapi%2F_diagnostic_renderers%2Findex.txt)

Ask ChatGPT
(https://chatgpt.com/?q=Please%20help%20me%20understand%20this%20documentation%3A%20%2Fkida%2Fapi%2F_diagnostic_renderers%2Findex.txt)

Ask Gemini
(https://gemini.google.com/app?q=Please%20help%20me%20understand%20this%20documentation%3A%20%2Fkida%2Fapi%2F_diagnostic_renderers%2Findex.txt)

Ask Copilot
(https://copilot.microsoft.com/?q=Please%20help%20me%20understand%20this%20documentation%3A%20%2Fkida%2Fapi%2F_diagnostic_renderers%2Findex.txt)

Module

#
`_diagnostic_renderers`

Private text, JSON, and SARIF renderers for`kida check`results.

6Functions

## Functions

`render_check_text`

1

`str`

▼

Render compatibility text in the collector's deterministic event order.

`def render_check_text(result: CheckResult) -> str`

##### Parameters

Name
Type
Description

`result`
`CheckResult`

##### Returns

`str`

`diagnostic_to_dict`

1

`dict[str, object]`

▼

Return the versioned JSON fact shape for one diagnostic.

`def diagnostic_to_dict(diagnostic: Diagnostic) -> dict[str, object]`

##### Parameters

Name
Type
Description

`diagnostic`
`Diagnostic`

##### Returns

`dict[str, object]`

`check_json_payload`

1

`dict[str, object]`

▼

Return the diagnostics JSON v1 envelope.

`def check_json_payload(result: CheckResult) -> dict[str, object]`

##### Parameters

Name
Type
Description

`result`
`CheckResult`

##### Returns

`dict[str, object]`

`render_check_json`

1

`str`

▼

Render the diagnostics JSON v1 envelope.

`def render_check_json(result: CheckResult) -> str`

##### Parameters

Name
Type
Description

`result`
`CheckResult`

##### Returns

`str`

`check_sarif_payload`

1

`dict[str, object]`

▼

Return a SARIF 2.1.0 log for the canonical diagnostic collection.

`def check_sarif_payload(result: CheckResult) -> dict[str, object]`

##### Parameters

Name
Type
Description

`result`
`CheckResult`

##### Returns

`dict[str, object]`

`render_check_sarif`

1

`str`

▼

Render the canonical collection as SARIF 2.1.0 JSON.

`def render_check_sarif(result: CheckResult) -> str`

##### Parameters

Name
Type
Description

`result`
`CheckResult`

##### Returns

`str`