← All resources

Resource

external_schema

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

GraphQL reference →

Configuration

sourceTextString!Required

Raw schema content (JSON or YAML)

nameString!Required

Schema name (required)

descriptionStringOptional

Optional description

formatExternalSchemaFormat!Required

Schema format (required)

Allowed values

OPENAPI_3 — OpenAPI 3.x specification

SWAGGER_2 — Swagger 2.0 specification

JSON_SCHEMA — JSON Schema

Read-only values

Show values
idExternalSchemaID!Read only

Unique identifier

computed by the platform

sourceSHA256String!Read only

Exact uploaded source revision for API client authoring

computed by the platform

statusExternalSchemaStatus!Read only

Processing status

Allowed values

PENDING — Schema uploaded, awaiting processing

PROCESSING — Schema is being parsed and embedded

READY — Schema processed and searchable

FAILED — Processing failed

computed by the platform

errorMessageStringRead only

Error message if processing failed

computed by the platform

entryCountInt!Read only

Number of indexed entries

computed by the platform

createdAtString!Read only

Creation timestamp (ISO8601)

computed by the platform

updatedAtString!Read only

Last update timestamp (ISO8601)

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.