kongctl explain

Beta and uses: kongctl
Related Documentation
Incompatible with
on-prem

Explain shows the declarative schema for a supported resource type or field path.

Use text output for human-readable field summaries. Use json or yaml output to retrieve the same machine-readable schema document in different serializations.

Command usage

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
  # 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   : [ 3024_day, 3024_night, aardvark_blue, abernathy, adventure ]
                                - Reference  : [ https://github.com/lrstanley/bubbletint/blob/master/DEFAULT_TINTS.md ] (default "kong-light")
      --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")
  -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")

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!