Databricks SDK for JavaScript
    Preparing search index...

    Variable OpenApiModeConst

    OpenApiMode: {
        OPEN_API_MODE_DISABLED: "OPEN_API_MODE_DISABLED";
        OPEN_API_MODE_IGNORE_PRIVILEGES: "OPEN_API_MODE_IGNORE_PRIVILEGES";
        OPEN_API_MODE_UNSPECIFIED: "OPEN_API_MODE_UNSPECIFIED";
    } = ...

    Controls how the Data API exposes the OpenAPI documentation endpoint. Only IGNORE_PRIVILEGES and DISABLED are supported today; "follow-privileges" is not implemented yet (it may be added later as value 3 — adding new enum values is backward-compatible).

    Type Declaration

    • ReadonlyOPEN_API_MODE_DISABLED: "OPEN_API_MODE_DISABLED"

      Disable the OpenAPI documentation endpoint entirely.

    • ReadonlyOPEN_API_MODE_IGNORE_PRIVILEGES: "OPEN_API_MODE_IGNORE_PRIVILEGES"

      Generate OpenAPI output ignoring the privileges of the requesting role.

    • ReadonlyOPEN_API_MODE_UNSPECIFIED: "OPEN_API_MODE_UNSPECIFIED"

      Unspecified; the server applies its default mode.