Kong · Schema

Notification

Properties of a notification.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
id object
title string
description string
status object
region object
namespace object
entity_id string ID of the entity. Use '*' to represent all entities of this type.
details object Metadata associated with the notification to build actionable links.
created_at object
updated_at object
View JSON Schema on GitHub

JSON Schema

kong-notification-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Notification",
  "title": "Notification",
  "description": "Properties of a notification.",
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UUID"
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "status": {
      "$ref": "#/components/schemas/NotificationStatus"
    },
    "region": {
      "$ref": "#/components/schemas/NotificationRegion"
    },
    "namespace": {
      "$ref": "#/components/schemas/NotificationNamespace"
    },
    "entity_id": {
      "description": "ID of the entity. Use '*' to represent all entities of this type.",
      "type": "string"
    },
    "details": {
      "description": "Metadata associated with the notification to build actionable links.",
      "type": "object"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "title",
    "description",
    "status",
    "region",
    "namespace",
    "entity_id",
    "details",
    "created_at",
    "updated_at"
  ]
}