Skip to content

cub changeorder explain

cub changeorder explain

Explain ChangeOrder fields from the OpenAPI spec

Synopsis

Show documentation for the ChangeOrder 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 ChangeOrder 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 changeorder explain [field] [flags]

Examples

  cub changeorder explain
  cub changeorder explain Labels
  cub changeorder explain --where
  cub changeorder explain --where Labels

Options

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

Options inherited from parent commands

      --component string   the Component of --variant, when that names the variant alone; --variant <component>/<variant> says the same in one flag
      --context string     The context to use for this command
      --debug              Debug output
      --space string       space to operate in, by slug or UUID. Omitted, a list or bulk operation spans the organization and a single entity is named as <space>/<slug>; "*" means the same as omitting it
      --variant string     variant to operate in, as <component>/<variant>, or as <variant> with --component: the space naming that Component whose Variant label is <variant>. The same scope as --space, named by what it is rather than by the space's slug; the two cannot be combined

SEE ALSO