honeycomb · Schema

QueryAnnotationCreateRequest

Properties

Name Type Description
name string The name for the query annotation.
description string An optional description for the annotation.
query_id string The ID of the query to annotate.
View JSON Schema on GitHub

JSON Schema

honeycomb-queryannotationcreaterequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/QueryAnnotationCreateRequest",
  "title": "QueryAnnotationCreateRequest",
  "type": "object",
  "required": [
    "name",
    "query_id"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name for the query annotation."
    },
    "description": {
      "type": "string",
      "description": "An optional description for the annotation."
    },
    "query_id": {
      "type": "string",
      "description": "The ID of the query to annotate."
    }
  }
}