manifest/dist/json-schema/src/schema/definitions/relationship-schema.json

The backend for AI code editors

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://schema.manifest.build/definitions/relationship-schema.json",
    "title": "Relationship Schema",
    "description": "A relationship between two entities. Doc: https://manifest.build/docs/entities#relations",
    "anyOf": [
        {
            "type": "object",
            "properties": {
                "name": {
                    "type": "string",
                    "description": "The name of the relation."
                },
                "entity": {
                    "type": "string",
                    "description": "The class name of the entity that the relationship is with."
                },
                "eager": {
                    "type": "boolean",
                    "description": "Whether the relationship should be eager loaded. Otherwise, you need to explicitly request the relation in the client SDK or API.\nDefaults to false."
                },
                "helpText": {
                    "description": "Optional help text to provide additional guidance for the relationship in the admin UI.",
                    "type": "string"
                }
            },
            "required": ["entity"],
            "additionalProperties": false
        },
        {
            "type": "string",
            "description": "A simple string representing the class name of the entity"
        }
    ]
}