datumctl docs openapi

Browse OpenAPI specs for platform APIs

Synopsis

Discovers available API groups from the platform and serves Swagger UI for interactive API exploration.

A dropdown in the UI allows switching between different API groups without restarting the server.

By default, discovers APIs from the platform root. Use —organization or —project to browse APIs from a specific control plane.

Examples:

Browse platform-wide APIs (default)

datumctl docs openapi

Browse APIs for an organization

datumctl docs openapi —organization my-org

Browse APIs for a project

datumctl docs openapi —project my-project

Use a specific port

datumctl docs openapi —port 8080

datumctl docs openapi [flags]

Options

  -h, --help                  help for openapi
      --no-browser            Don't open browser automatically
      --organization string   Organization to target
      --platform-wide         Access platform-wide APIs
      --port int              Port for Swagger UI server (default: random available)
      --project string        Project to target

Options inherited from parent commands

      --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
      --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
      --as-uid string                  UID to impersonate for the operation.
      --as-user-extra stringArray      User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key.
      --certificate-authority string   Path to a cert file for the certificate authority
      --disable-compression            If true, opt-out of response compression for all requests to the server
      --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
      --log-flush-frequency duration   Maximum number of seconds between log flushes (default 5s)
  -n, --namespace string               If present, the namespace scope for this CLI request
      --request-timeout string         The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
  -s, --server string                  The address and port of the Kubernetes API server
      --tls-server-name string         Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
      --token string                   Bearer token for authentication to the API server
      --user string                    The name of the kubeconfig user to use
  -v, --v Level                        number for the log level verbosity
      --vmodule moduleSpec             comma-separated list of pattern=N settings for file-filtered logging (only works for the default text log format)

datumctl docs openapi