Show, open or download the API docs of the streaming session broker
nova simulation api [flags]
Examples
# open the interactive API docs of the broker
nova simulation api --open
# save the broker's OpenAPI spec
nova simulation api --spec -o broker.json
Options
-h, --help help for api
--open Open the interactive API docs in the browser
-o, --output string File to write the spec to (default: stdout)
--spec Download the OpenAPI spec
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)
SEE ALSO
- nova simulation - EXPERIMENTAL, Wandelbots internal: Manage simulation streaming sessions