Backstage · Schema
Entity
A Backstage catalog entity.
Developer PortalInternal Developer PlatformSoftware CatalogOpen Source
Properties
| Name | Type | Description |
|---|---|---|
| apiVersion | string | The API version of the entity schema. |
| kind | string | The kind of entity. Common kinds include Component, API, System, Domain, Resource, Group, User, Location, and Template. |
| metadata | object | |
| spec | object | The specification of the entity. The schema varies depending on the kind and type. |
| relations | array | |
| status | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/backstage/refs/heads/main/json-schema/catalog-entity-schema.json",
"title": "Entity",
"description": "A Backstage catalog entity.",
"type": "object",
"properties": {
"apiVersion": {
"type": "string",
"description": "The API version of the entity schema.",
"example": "backstage.io/v1alpha1"
},
"kind": {
"type": "string",
"description": "The kind of entity. Common kinds include Component, API, System, Domain, Resource, Group, User, Location, and Template.",
"example": "Component"
},
"metadata": {
"$ref": "#/components/schemas/EntityMetadata"
},
"spec": {
"type": "object",
"description": "The specification of the entity. The schema varies depending on the kind and type.",
"additionalProperties": true
},
"relations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRelation"
}
},
"status": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"level": {
"type": "string",
"enum": [
"info",
"warning",
"error"
]
},
"message": {
"type": "string"
},
"error": {
"type": "object"
}
}
}
}
}
}
},
"required": [
"apiVersion",
"kind",
"metadata"
]
}