Graphs

Validate Schema

Validates a custom schema definition before deployment — checks structure, types, constraints, and relationship references. Returns errors and warnings without applying changes. Supports JSON, YAML, and dict formats.

post/v1/graphs/schema/validate

Request

  • Base URL: https://api.robosystems.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.robosystems.ai/v1/graphs/schema/validate
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

formatstring

Schema format: json, yaml, or dict

check_compatibilitystring[] nullable

List of existing schema extensions to check compatibility with

Example request

{
  "format": "json"
}

Response

Successful Response

validboolean required

Whether the schema is valid

messagestring required

Validation message

errorsstring[] nullable

List of validation errors (only present when valid=false)

warningsstring[] nullable

List of validation warnings (schema is still valid but has potential issues)

statsobject nullable

Schema statistics (only present when valid=true)

compatibilityobject nullable

Compatibility check results (only when check_compatibility specified)

Example response

{
  "valid": true,
  "message": "Schema is valid",
  "stats": {
    "nodes": 2,
    "primary_keys": 2,
    "relationships": 1,
    "total_properties": 7
  },
  "compatibility": {
    "checked_extensions": [
      "roboledger"
    ],
    "compatible": true,
    "conflicts": []
  }
}

Changes

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