Schema patch

Get the schema-patch contract

The schema-patch contract, the document that defines the schema-patch format: the shape DrawSQL accepts wherever a patch can be supplied. Served verbatim, and byte-identical to the ungated drawsql.app/schema-patch-contract.json — this URL exists so a consumer that already holds a token can fetch the contract from the API origin.

The ETag hashes the document, so it changes only when the format does. Rate limit: 60 requests/minute per token.

get/schema-patch-contract

Request

  • Base URL
    https://api.drawsql.app/v1
  • Auth
    HTTP bearer

Headers

If-None-Matchstring

An ETag from a previous response. Returns 304 if unchanged.

Response

The schema-patch contract.

object required

The contract document. Its properties tree uses JSON-Schema-like type/description/enum keys, but it is not a JSON Schema: required is a per-field boolean and examples is an object, so do not feed it to a JSON Schema validator.

Changes

No recorded changes to this operation across all 1 revision of this API.