Catalog Info Backstage

Backstage Catalog Info

catalog-info.yaml*.catalog-info.yaml

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your catalog-info.yaml and it validates in your browser — nothing is uploaded.

Validate a catalog-info.yaml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`apiVersion`	`enum`	— one of: `"backstage.io/v1al…, "backstage.io/v1be…`
`kind`	`enum`	— one of: `"API"`
`spec`required	`object`	—
`spec.type`required	`string`	The type of the API definition.
`spec.lifecycle`required	`string`	The lifecycle state of the API.
`spec.owner`required	`string`	An entity reference to the owner of the API.
`spec.system`	`string`	An entity reference to the system that the API belongs to.
`spec.definition`required	`string \| object`	The definition of the API, based on the format defined by the type.
`spec.definition.$json`	`string`	Interprets the contents of the referenced file as JSON and embeds the parsed structure.
`spec.definition.$text`	`string`	Interprets the contents of the referenced file as plain text and embeds it as a string.
`spec.definition.$yaml`	`string`	Interprets the contents of the referenced file as YAML and embeds the parsed structure.
`apiVersion`	`enum`	— one of: `"backstage.io/v1al…, "backstage.io/v1be…`
`kind`	`enum`	— one of: `"Component"`
`spec`required	`object`	—
`spec.type`required	`string`	The type of component.
`spec.lifecycle`required	`string`	The lifecycle state of the component.
`spec.owner`required	`string`	An entity reference to the owner of the component.
`spec.system`	`string`	An entity reference to the system that the component belongs to.
`spec.subcomponentOf`	`string`	An entity reference to another component of which the component is a part.
`spec.providesApis`	`array<string>`	An array of entity references to the APIs that are provided by the component.
`spec.consumesApis`	`array<string>`	An array of entity references to the APIs that are consumed by the component.
`spec.dependsOn`	`array<string>`	An array of references to other entities that the component depends on to function.
`apiVersion`	`enum`	— one of: `"backstage.io/v1al…, "backstage.io/v1be…`
`kind`	`enum`	— one of: `"Domain"`
`spec`required	`object`	—
`spec.owner`required	`string`	An entity reference to the owner of the component.

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
156 properties, 73% carrying a description, max nesting depth 17.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$ref`	JSON Schema Core, draft 2020-12	§8.2.3.1 — Direct References with "$ref"
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`allOf`	JSON Schema Core, draft 2020-12	§10.2.1.1 — "allOf"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`examples`	JSON Schema Validation, draft 2020-12	§9.5 — "examples"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`minLength`	JSON Schema Validation, draft 2020-12	§6.3.2 — "minLength"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`required`	JSON Schema Validation, draft 2020-12	§6.5.3 — "required"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas