Skip to content
ReqSeq

Record evidence

Write a manual verification or validation record (Markdown, evidence-record.schema.json) into an evidence folder of the workspace; the element’s UUID and current version are filled in. A verification names a requirement, a validation a need or a requirement (D-012). Never replaces a file: a name that is taken gets -2, -3, …

Command evidence.record. Writes files in the working tree, never to Git. It is refused while the workspace is read-only. Fills in the current version of the element, which depends on the metamodel (which properties count).

Input

Section titled “Input”
Field Type Required Description
ref elementRef yes The element the record is about. Its UUID and current version are written into the record; neither is an input (D-026).
kind one of "verification", "validation" yes Verification (Nachweis) of a requirement, or validation of a need or a requirement (D-007, D-012). A validation record counts for the validation status only (SR-030 AK3).
method one of "test", "analysis", "inspection", "demonstration" no Required for verification.
result one of "passed", "failed" yes
item item no The item under test (Prüfling), for example the build or sample. Required for verification. No white space at either end and no control characters other than tab, line feed and carriage return.
variant elementRef no A variant the element applies in (an element whose type has the meaning variant); the record holds for it. Absent: the core. Verification only: a variant with kind validation is input.invalid with details.reason validation-with-variant (SR-038 AK4, D-007); core is allowed. A variant the element is not in is input.invalid with details.reason not-valid-in-variant, or excluded-in-variant or replaced-in-variant when the variant excludes or replaces the requirement (SR-047 AK4).
date dateTime no When the check was done. Default: the time of the call, UTC, whole seconds. Its first ten characters (the day in its own offset) start the file name.
evidence string no Where the Beleg is: a path relative to the record file, a file URL or any URI. Written as given; ReqSeq never opens it (D-007).
testCase string no Optional test case name or ID (test-case in the file, SR-033).
folder string no The folder to write into: an evidence location of the workspace file or a folder below one, relative to the workspace root (the folder of the main repository) with /, for example evidence/manual or ../tests/evidence. Missing folders below the location are created. Default: the first evidence location whose repository is on this machine.

Output

Section titled “Output”
Field Type Required Description
files array of string yes
record evidenceRecord yes The record as the Markdown reader reads it back from the written file (source: markdown, its repository and file, line 1), with the UUID and current version of the element.
problems array of problem no

App

Section titled “App”

In the command prompt (Ctrl+Shift+P, macOS ⌘⇧P): the command Record evidence.

CLI

Section titled “CLI”

reqseq evidence record, with --json for the output as JSON. Its help:

Usage: reqseq evidence record <ref> <kind> <result> [options]


Write a manual verification or validation record (Markdown,
evidence-record.schema.json) into an evidence folder of the workspace; the
element's UUID and current version are filled in. A verification names a
requirement, a validation a need or a requirement (D-012). Never replaces a
file: a name that is taken gets -2, -3, ...


Arguments:
  ref                     The element the record is about. Its UUID and current
                          version are written into the record; neither is an
                          input (D-026).
  kind                    Verification (Nachweis) of a requirement, or
                          validation of a need or a requirement (D-007, D-012).
                          A validation record counts for the validation status
                          only (SR-030 AK3). one of: verification, validation
  result                  one of: passed, failed


Options:
  --ref <value>           instead of the argument <ref>
  --kind <value>          instead of the argument <kind>
  --result <value>        instead of the argument <result>
  --method <value>        Required for verification. one of: test, analysis,
                          inspection, demonstration
  --item <value>          The item under test (Prüfling), for example the build
                          or sample. Required for verification. No white space
                          at either end and no control characters other than
                          tab, line feed and carriage return.
  --variant <value>       A variant the element applies in (an element whose
                          type has the meaning variant); the record holds for
                          it. Absent: the core. Verification only: a variant
                          with `kind` validation is `input.invalid` with
                          `details.reason` `validation-with-variant` (SR-038
                          AK4, D-007); `core` is allowed. A variant the element
                          is not in is `input.invalid` with `details.reason`
                          `not-valid-in-variant`, or `excluded-in-variant` or
                          `replaced-in-variant` when the variant excludes or
                          replaces the requirement (SR-047 AK4).
  --date <value>          When the check was done. Default: the time of the
                          call, UTC, whole seconds. Its first ten characters
                          (the day in its own offset) start the file name.
  --evidence <value>      Where the Beleg is: a path relative to the record
                          file, a file URL or any URI. Written as given; ReqSeq
                          never opens it (D-007).
  --test-case <value>     Optional test case name or ID (`test-case` in the
                          file, SR-033).
  --folder <value>        The folder to write into: an evidence location of the
                          workspace file or a folder below one, relative to the
                          workspace root (the folder of the main repository)
                          with `/`, for example `evidence/manual` or
                          `../tests/evidence`. Missing folders below the
                          location are created. Default: the first evidence
                          location whose repository is on this machine.
  --input <json|@file|->  command input as JSON: inline, from a file, or from
                          standard input
  --workspace <path>      workspace root (default: nearest folder upwards with
                          reqseq-workspace.yaml)
  --json                  print exactly the command output as JSON
  --yaml                  print the whole command output as YAML, problems one
                          per line
  -h, --help              show help

API

Section titled “API”

POST /v1/commands/evidence.record on the local API (reqseq serve api), with the input as the JSON body; the answer is the output.

MCP

Section titled “MCP”

Tool evidence_record of the MCP server (reqseq mcp), with the input as its arguments.