{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/PatchedAnnotation", "title": "PatchedAnnotation", "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "content": { "type": "string", "nullable": true, "description": "Annotation text shown on charts to describe the change, release, or incident.", "maxLength": 8192 }, "date_marker": { "type": "string", "format": "date-time", "nullable": true, "description": "When this annotation happened (ISO 8601 timestamp). Used to position it on charts." }, "creation_type": { "allOf": [ { "$ref": "#/components/schemas/CreationTypeEnum" } ], "description": "Who created this annotation. Use `USR` for user-created notes and `GIT` for bot/deployment notes.\n\n* `USR` - user\n* `GIT` - GitHub" }, "dashboard_item": { "type": "integer", "nullable": true }, "dashboard_id": { "type": "integer", "nullable": true }, "dashboard_name": { "type": "string", "nullable": true, "readOnly": true }, "insight_short_id": { "type": "string", "nullable": true, "readOnly": true }, "insight_name": { "type": "string", "nullable": true, "readOnly": true }, "insight_derived_name": { "type": "string", "nullable": true, "readOnly": true }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ], "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "deleted": { "type": "boolean", "description": "Soft-delete flag. Set to true to hide the annotation, or false to restore it." }, "scope": { "allOf": [ { "$ref": "#/components/schemas/AnnotationScopeEnum" } ], "description": "Annotation visibility scope: `project`, `organization`, `dashboard`, or `dashboard_item`. `recording` is deprecated and rejected.\n\n* `dashboard_item` - insight\n* `dashboard` - dashboard\n* `project` - project\n* `organization` - organization\n* `recording` - recording" } } }