grafana/docs/sources/as-code/observability-as-code/schema-v2/annotations-schema.md

description, keywords, labels, menuTitle, title, weight, canonical, aliases

description	keywords	labels	menuTitle	title	weight	canonical	aliases
A reference for the JSON annotations schema used with Observability as Code.	configuration as code as-code dashboards git integration git sync github annotations	products cloud enterprise oss	annotations schema	annotations	100	https://grafana.com/docs/grafana/latest/as-code/observability-as-code/schema-v2/annotations-schema/	../../../observability-as-code/schema-v2/annotations-schema/

annotations

The configuration for the list of annotations that are associated with the dashboard.

  "annotations": [
    {
      "kind": "AnnotationQuery",
      "spec": {
        "builtIn": false,
        "datasource": {
          "type": "",
          "uid": ""
        },
        "enable": false,
        "hide": false,
        "iconColor": "",
        "name": ""
      }
    }
  ],

AnnotationsQueryKind consists of:

• kind: "AnnotationQuery"
• spec: AnnotationQuerySpec

AnnotationQuerySpec

Name	Type/Definition
datasource	DataSourceRef
query	DataQueryKind
enable	bool
hide	bool
iconColor	string
name	string
builtIn	bool. Default is false.
filter	AnnotationPanelFilter
options	[string]: A catch-all field for datasource-specific properties.

DataSourceRef

Name	Usage
type?	string. The plugin type-id.
uid?	The specific data source instance.

DataQueryKind

Name	Type
kind	string
spec	string

AnnotationPanelFilter

Name	Type/Definition
exclude?	bool. Should the specified panels be included or excluded. Default is false.
ids	[...uint8]. Panel IDs that should be included or excluded.