Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.15.2.
evidencectl source suggest command reference
Suggest source configuration from an OpenAPI document.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree. Hidden implementation commands are omitted.
evidencectl source suggest [OPTIONS] <--openapi <OPENAPI>|--project <PROJECT>>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
| Command invocation | Exactly one of --openapi <OPENAPI>, --project <PROJECT> is required. |
Options
Section titled “Options”| Option | Always required | Repeatable | Default | Values | Environment | Description |
|---|---|---|---|---|---|---|
--openapi <OPENAPI> | No | No | n/a | n/a | n/a | OpenAPI 3.0 or 3.1 document for a print-only draft. With —project, the retained source.openapi.yaml is used instead |
--operation <OPERATION> | No | No | n/a | n/a | n/a | Operation as “METHOD /path/template”; interactive selection if absent |
--status <STATUS> | No | No | 200 | n/a | n/a | Response status code to read the schema from |
--media-type <MEDIA_TYPE> | No | No | application/json | n/a | n/a | Response media type to read the schema from |
--select <SELECTION> | No | Yes | n/a | n/a | n/a | Projection pointer to select; repeat once per leaf. Interactive selection if absent |
--sample <SAMPLE> | No | No | n/a | n/a | n/a | Sample response JSON file used to suggest bounds. Read only; nothing from it is copied into any artifact except derived bounds |
--source-id <SOURCE_ID> | No | No | n/a | n/a | n/a | Source identifier for the generated artifacts |
--base-url <BASE_URL> | No | No | n/a | n/a | n/a | Reviewed source origin to write into a newly created source draft |
--project <PROJECT> | No | No | n/a | n/a | n/a | Deployment project to write the draft into; print-only if absent |
-h, --help | No | No | n/a | n/a | n/a | Print help |
Generation contract
Section titled “Generation contract”Run npm run generate from docs/site after changing a public command, argument, option, default, environment binding, or help description.