# `VulnCheck.Report.OpenVEX`
[🔗](https://github.com/Voskan/vulncheck/blob/v1.0.1/lib/vulncheck/report/openvex.ex#L1)

OpenVEX v0.2.0 document (`--vex` or `--format openvex`).

One statement per advisory and package. The status follows the
reachability verdict:

| Verdict and reason | `status` | `justification` |
| :--- | :--- | :--- |
| reachable | `affected` (with `action_statement`) | — |
| potentially reachable | `under_investigation` | — |
| unreachable: function not called, module not loaded, adapter not configured, OTP application not started | `not_affected` | `vulnerable_code_not_in_execute_path` |
| unreachable: build-time only dependency (`runtime: false`) | `not_affected` | `vulnerable_code_not_in_execute_path` |
| unreachable: development or test dependency | `not_affected` | `component_not_present` |
| unreachable: OTP version unaffected | `not_affected` | OTP constraint in `impact_statement` |

Retired releases are left out. With zero statements, no OpenVEX document
is available. The document `@id` is derived from its content.

# `document`

```elixir
@spec document(VulnCheck.Types.ScanReport.t(), VulnCheck.Config.t(), keyword()) ::
  map() | nil
```

The VEX document as plain maps, or nil when there are no statements.

# `encode`

```elixir
@spec encode(VulnCheck.Types.ScanReport.t(), VulnCheck.Config.t(), keyword()) ::
  String.t()
```

Encodes the VEX document, or returns an empty string when there are no statements.

# `status`

```elixir
@spec status(VulnCheck.Types.Finding.t()) :: map()
```

Status fields of the statement for a finding.

---

*Consult [api-reference.md](api-reference.md) for complete listing*
