compiler

Validate schema file set

Changed on

Validate a schema file set against a connection.

Checks all views, queries, and related schemas for correctness and returns any errors or warnings found.

RLS: Filtered to current client (ClientRLSDB).

post/api/v1/compiler/validate

Request

  • Base URL
    https://api.kater.ai
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Query parameters

sourcestring nullable

Headers

X-Kater-CLI-IDstring nullable

Request body

auto_fixboolean

Automatically fix broken refs caused by renames. Defaults to True.

connection_idsstring[] nullable

Optional connection IDs to validate. If omitted, validates all connections.

Response

Successful Response

request_idstring nullable

Write-back request ID. Non-null when files were dispatched to CLI via WebSocket.

successboolean required

Whether validation passed without errors

Changes

    • breaking

      response property errors list-of-types was widened by adding types array to media type application/json of response 400

    • breaking

      response property errors list-of-types was widened by adding types array to media type application/json of response 401

    • breaking

      response property errors list-of-types was widened by adding types array to media type application/json of response 403

    • breaking

      response property errors list-of-types was widened by adding types array to media type application/json of response 404

    • breaking

      response property errors list-of-types was widened by adding types array to media type application/json of response 422

    • breaking

      response property errors list-of-types was widened by adding types array to media type application/json of response 500

    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status