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

The backend for AI code editors

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://schema.manifest.build/definitions/endpoint-schema.json",
    "title": "Endpoint Schema",
    "description": "Defines a custom endpoint in Manifest: https://manifest.build/docs/endpoints",
    "type": "object",
    "properties": {
        "path": {
            "description": "The URL path of the endpoint. Must start with a '/'.",
            "type": "string",
            "pattern": "^/.*"
        },
        "method": {
            "description": "The HTTP method for the endpoint.",
            "type": "string",
            "enum": ["GET", "POST", "PATCH", "PUT", "DELETE"]
        },
        "handler": {
            "description": "The name of the handler function for this endpoint. Doc: https://manifest.build/docs/endpoints#handlers",
            "type": "string"
        },
        "description": {
            "description": "An optional endpoint description. Doc: https://manifest.build/docs/endpoints",
            "type": "string"
        },
        "policies": {
            "description": "An optional array of policies applied to the endpoint.",
            "type": "array",
            "items": {
                "$ref": "https://schema.manifest.build/definitions/policies/policy-schema.json"
            }
        }
    },
    "required": ["path", "method", "handler"],
    "additionalProperties": false
}