Skip to main content

OpenAPI specification

The OpenAPI specification can be exported from the Command-Line interface using a subcommand.

opentalk-controller openapi subcommand​

This subcommand is the top-level entrypoint to exporting the OpenAPI specification of the web api.

Help output looks like this:

Get information on the OpenAPI specification

Usage: opentalk-controller openapi <COMMAND>

Commands:
  dump  Dump the OpenAPI specification
  help  Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

opentalk-controller openapi dump subcommand​

This subcommand allows to dump the OpenAPI specification to either stdout or a file.

Help output looks like this:

Dump the OpenAPI specification

Usage: opentalk-controller openapi dump [OPTIONS] [TARGET]

Arguments:
  [TARGET]
          The output target (either a filename, or `-` for stdout)

          [default: -]

Options:
      --format <FORMAT>
          The export format

          [default: yaml]

          Possible values:
          - yaml: YAML output format
          - json: JSON output format

  -h, --help
          Print help (see a summary with '-h')