Skip to content
Registry StackDocsDevelopment (unreleased)

evidencectl source suggest command reference

View as Markdown

Suggest source configuration from an OpenAPI document.

This page is generated from the public Clap command tree. Hidden implementation commands are omitted.

evidencectl source suggest [OPTIONS] <--openapi <OPENAPI>|--project <PROJECT>>
ConditionRequirement
Command invocationExactly one of --openapi <OPENAPI>, --project <PROJECT> is required.
OptionAlways requiredRepeatableDefaultValuesEnvironmentDescription
--openapi <OPENAPI>NoNon/an/an/aOpenAPI 3.0 or 3.1 document for a print-only draft. With —project, the retained source.openapi.yaml is used instead
--operation <OPERATION>NoNon/an/an/aOperation as “METHOD /path/template”; interactive selection if absent
--status <STATUS>NoNo200n/an/aResponse status code to read the schema from
--media-type <MEDIA_TYPE>NoNoapplication/jsonn/an/aResponse media type to read the schema from
--select <SELECTION>NoYesn/an/an/aProjection pointer to select; repeat once per leaf. Interactive selection if absent
--sample <SAMPLE>NoNon/an/an/aSample response JSON file used to suggest bounds. Read only; nothing from it is copied into any artifact except derived bounds
--source-id <SOURCE_ID>NoNon/an/an/aSource identifier for the generated artifacts
--base-url <BASE_URL>NoNon/an/an/aReviewed source origin to write into a newly created source draft
--project <PROJECT>NoNon/an/an/aDeployment project to write the draft into; print-only if absent
-h, --helpNoNon/an/an/aPrint help

Run npm run generate from docs/site after changing a public command, argument, option, default, environment binding, or help description.