← All types

ExternalSchemaState

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

Fields

Unique identifier

Exact uploaded source revision for API client authoring

The schema document exactly as uploaded (JSON or YAML)

name

String!Non-null

Schema name

Optional description

Schema format (OPENAPI_3, SWAGGER_2, JSON_SCHEMA)

Possible values (3)
OPENAPI_3

OpenAPI 3.x specification

SWAGGER_2

Swagger 2.0 specification

JSON_SCHEMA

JSON Schema

Processing status

Possible values (4)
PENDING

Schema uploaded, awaiting processing

PROCESSING

Schema is being parsed and embedded

READY

Schema processed and searchable

FAILED

Processing failed

Error message if processing failed

entryCount

Int!Non-null

Number of indexed entries

Creation timestamp (ISO8601)

Last update timestamp (ISO8601)

Referenced by (3)
Exact type 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
}