Resource
external_schema
An uploaded external API schema (OpenAPI, Swagger, JSON Schema)
Configuration
sourceTextString!RequiredRaw schema content (JSON or YAML)
nameString!RequiredSchema name (required)
descriptionStringOptionalOptional description
formatExternalSchemaFormat!RequiredSchema 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 onlyUnique identifier
computed by the platform
sourceSHA256String!Read onlyExact uploaded source revision for API client authoring
computed by the platform
statusExternalSchemaStatus!Read onlyProcessing 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 onlyError message if processing failed
computed by the platform
entryCountInt!Read onlyNumber of indexed entries
computed by the platform
createdAtString!Read onlyCreation timestamp (ISO8601)
computed by the platform
updatedAtString!Read onlyLast 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.