Backstage · JSON Structure

Catalog Entity Relation Structure

EntityRelation schema from Backstage catalog API

Type: object Properties: 2
Developer PortalInternal Developer PlatformSoftware CatalogOpen Source

EntityRelation is a JSON Structure definition published by Backstage, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

type targetRef

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/backstage/refs/heads/main/json-structure/catalog-entity-relation-structure.json",
  "name": "EntityRelation",
  "description": "EntityRelation schema from Backstage catalog API",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of relation.",
      "example": "ownedBy"
    },
    "targetRef": {
      "type": "string",
      "description": "The entity reference of the target entity.",
      "example": "group:default/my-team"
    }
  }
}