Explain shows the declarative schema for a supported resource type or field path.
Run kongctl explain without a path to list every available declarative
resource path. Use text output for human-readable field summaries. Use JSON or
YAML to retrieve the same machine-readable schema.
Lower-maturity resources and operations include a maturity label. Unlabeled
resources are GA. JSON and YAML schema output exposes maturity through
x-kongctl-maturity.
Usage:
kongctl explain <resource-path> [flags]
Examples:
# Explain the declarative API resource
kongctl explain api
# Explain a child resource in nested form
kongctl explain api.versions
# Explain a specific field
kongctl explain api.publications.portal_id
# Explain analytics dashboard tiles and valid discriminator values
kongctl explain analytics.dashboards --extended
# Retrieve the machine-readable schema as JSON Schema
kongctl explain api --output json
# Retrieve the same schema serialized as YAML
kongctl explain api --output yaml
Flags:
--color-theme string Configures the CLI UI/theme (prompt, tables, TUI elements).
- Config path: [ color-theme ]
- Examples : [ auto, 3024_day, 3024_night, aardvark_blue, abernathy ]
- Reference : [ https://github.com/lrstanley/bubbletint/blob/master/DEFAULT_TINTS.md ] (default "auto")
--config-file string Path to the configuration file to load.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--extended Include extended field details in text output
-h, --help help for explain
--jq string Filter JSON responses using jq expressions (powered by gojq for full jq compatibility)
--jq-color string Controls colorized output for jq filter results.
- Config path: [ jq.color.enabled ]
- Allowed : [ auto|always|never ] (default "auto")
--jq-color-theme string Select the color theme used for jq filter results.
- Config path: [ jq.color.theme ]
- Examples : [ friendly, github-dark, dracula ]
- Reference : [ https://xyproto.github.io/splash/docs/ ] (default "friendly")
-r, --jq-raw-output Output string jq results without JSON quotes (like jq -r).
- Config path: [ jq.raw-output ]
--log-file string Write execution logs to the specified file instead of STDERR.
- Config path: [ log-file ]
--log-level string Configures the logging level. Execution logs are written to STDERR.
- Config path: [ log-level ]
- Allowed : [ trace|debug|info|warn|error ] (default "error")
--no-telemetry Disable telemetry for this command invocation. Overrides config and env.
- Config path: [ telemetry.enabled ]
- Env var : [ KONGCTL_NO_TELEMETRY ]
- Default : [ false ]
-o, --output string Configures the format of data written to STDOUT.
- Config path: [ output ]
- Allowed : [ json|yaml|text ] (default "text")
-p, --profile string Specify the profile to use for this command. (default "default")
--text-id-format string Configure UUID rendering in static text-table ID columns.
- Config path: [ text.id-format ]
- Allowed : [ compact|full ]
- Default : [ compact ]
--text-layout string Configure static text-table column selection.
- Config path: [ text.layout ]
- Allowed : [ compact|auto|wide ]
- Default : [ compact ]