honeycomb · Schema

ColumnCreateRequest

Properties

Name Type Description
key_name string The name for the new column.
type string The data type for the column.
description string An optional description for the column.
hidden boolean If true, hides the column from autocomplete and raw data field lists.
View JSON Schema on GitHub

JSON Schema

honeycomb-columncreaterequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ColumnCreateRequest",
  "title": "ColumnCreateRequest",
  "type": "object",
  "required": [
    "key_name"
  ],
  "properties": {
    "key_name": {
      "type": "string",
      "description": "The name for the new column."
    },
    "type": {
      "type": "string",
      "description": "The data type for the column.",
      "enum": [
        "string",
        "float",
        "integer",
        "boolean"
      ]
    },
    "description": {
      "type": "string",
      "description": "An optional description for the column."
    },
    "hidden": {
      "type": "boolean",
      "description": "If true, hides the column from autocomplete and raw data field lists."
    }
  }
}