← API reference
CANONICAL TYPE REFERENCE

APIClientDefinition

Persisted API contract and its revision-bound Lua type export.

API client definition identity.

Uploaded external schema supplying the pinned API description.

nameString!

Stable Lua binding or declared field name.

sourceString!

Native DataXML API definition source.

revisionString!

Opaque revision required when updating or deleting this definition.

SHA-256 of the exact uploaded schema bytes.

statusString!

READY, FAILED or STALE; independent of schema search indexing

Compilation or stale-source diagnostic; absent for a ready definition.

typeSpecString

Portable Swift-Lua TypeSpec JSON; absent for failed or stale definitions. Declaration-only, not runtime registration.

View exact SDL
"""Persisted API contract and its revision-bound Lua type export."""
type APIClientDefinition {
  """API client definition identity."""
  id: APIClientDefinitionID!
  """Uploaded external schema supplying the pinned API description."""
  externalSchemaId: ExternalSchemaID!
  """Stable Lua binding or declared field name."""
  name: String!
  """Native DataXML API definition source."""
  source: String!
  """Opaque revision required when updating or deleting this definition."""
  revision: String!
  """SHA-256 of the exact uploaded schema bytes."""
  schemaSHA256: String!
  """READY, FAILED or STALE; independent of schema search indexing"""
  status: String!
  """Compilation or stale-source diagnostic; absent for a ready definition."""
  diagnostic: String
  """
  Portable Swift-Lua TypeSpec JSON; absent for failed or stale definitions. Declaration-only, not runtime registration.
  """
  typeSpec: String
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.