Skip to content

cub group explain

cub group explain

Explain Group fields from the OpenAPI spec

Synopsis

Show documentation for the Group entity, sourced from the OpenAPI spec.

With no argument, lists every field with a one-line description. With a field name, shows the full description, type, constraints, and any enum values resolved through referenced schemas. When the field holds an object, or a list or map of them, the fields of that object are listed too.

A field of an object is named by its path, with the names separated by dots. A path goes through a list or a map without naming an element.

With --where, lists instead the attributes a --where expression over Group entities can name, with their types and how each is written, or describes the one named. Like the fields, they come from the OpenAPI spec this cub was built with, which publishes the attributes the server accepts.

cub group explain [field] [flags]

Examples

  cub group explain
  cub group explain Labels
  cub group explain --where
  cub group explain --where Labels

Options

  -h, --help    help for explain
      --where   List the attributes a --where expression over Group entities can name, or describe the one named, instead of the fields

Options inherited from parent commands

      --context string   The context to use for this command
      --debug            Debug output

SEE ALSO