planetscale · Schema

SchemaLintError

A schema lint error or warning for a database branch.

Properties

Name	Type	Description
lint_error	string	The lint error identifier.
subject_type	string	The type of schema element with the error.
table_name	string	The table name associated with the error.
column_name	string	The column name associated with the error, if applicable.
error_description	string	A human-readable description of the lint error.
docs_url	string	A URL to documentation about the lint error.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SchemaLintError",
  "title": "SchemaLintError",
  "type": "object",
  "description": "A schema lint error or warning for a database branch.",
  "properties": {
    "lint_error": {
      "type": "string",
      "description": "The lint error identifier."
    },
    "subject_type": {
      "type": "string",
      "description": "The type of schema element with the error."
    },
    "table_name": {
      "type": "string",
      "description": "The table name associated with the error."
    },
    "column_name": {
      "type": "string",
      "description": "The column name associated with the error, if applicable."
    },
    "error_description": {
      "type": "string",
      "description": "A human-readable description of the lint error."
    },
    "docs_url": {
      "type": "string",
      "format": "uri",
      "description": "A URL to documentation about the lint error."
    }
  }
}