← API reference
CANONICAL TYPE REFERENCE

ExternalSchemaState

An uploaded external API schema (OpenAPI, Swagger, JSON Schema)

Unique identifier

Exact uploaded source revision for API client authoring

sourceTextString!

The schema document exactly as uploaded (JSON or YAML)

nameString!

Schema name

Optional description

Schema format (OPENAPI_3, SWAGGER_2, JSON_SCHEMA)

Processing status

Error message if processing failed

Number of indexed entries

createdAtString!

Creation timestamp (ISO8601)

updatedAtString!

Last update timestamp (ISO8601)

View exact SDL
"""An uploaded external API schema (OpenAPI, Swagger, JSON Schema)"""
type ExternalSchemaState @iac_resource(name: "external_schema") @iac_ops(create: "createExternalSchema", read: "getExternalSchema", update: "updateExternalSchema", delete: "deleteExternalSchema") {
  """Unique identifier"""
  id: ExternalSchemaID! @iac_identity(assignedBy: SERVER) @iac_computed
  """Exact uploaded source revision for API client authoring"""
  sourceSHA256: String! @iac_computed
  """The schema document exactly as uploaded (JSON or YAML)"""
  sourceText: String!
  """Schema name"""
  name: String!
  """Optional description"""
  description: String
  """Schema format (OPENAPI_3, SWAGGER_2, JSON_SCHEMA)"""
  format: ExternalSchemaFormat!
  """Processing status"""
  status: ExternalSchemaStatus! @iac_computed
  """Error message if processing failed"""
  errorMessage: String @iac_computed
  """Number of indexed entries"""
  entryCount: Int! @iac_computed
  """Creation timestamp (ISO8601)"""
  createdAt: String! @iac_computed
  """Last update timestamp (ISO8601)"""
  updatedAt: String! @iac_computed
}

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