NOVA CLI reference 0.5.0 GitHub
  1. nova
  2. nova api

nova api schema

Show parameters and request body of an operation

Synopsis

Show what an operation of the instance's NOVA API v2 takes, as JSON: method, complete path, parameters and request body (references expanded), and the schema names of the answers.

nova api schema <operationId> [flags]

Examples

  nova api schema getRobotController
  nova api schema inverseKinematics

Options

  -h, --help   help for schema

Options inherited from parent commands

      --debug                      Write diagnostic output to stderr: HTTP requests and responses, external commands, the resolved instance. Known secrets are redacted, but bodies (app environments, kubeconfigs) can still contain some: don't share the output unreviewed (env: NOVA_DEBUG=1)
      --env string                 (Wandelbots internal) Portal environment for this invocation: prod, stg or dev (default: the environment of the cloud instance, else of the last 'nova login'; env: NOVA_ENV)
      --insecure-skip-tls-verify   If true, the server's certificate will not be checked for validity (disables TLS verification for all requests)
      --instance string            Name of the instance to work against for this invocation (overrides the selected instance; env: NOVA_INSTANCE)
      --timeout duration           How long to wait for the answer's headers and for the API spec (0: no limit for the answer) (default 1m0s)

SEE ALSO

  • nova api - Send an authenticated request to the NOVA API of the instance