Kong · Schema

PortalMenuItem

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
path string The absolute path of a page in a portal with a leading slash.
title string The link display text
visibility string Whether a menu item is public or private. Private menu items are only accessible to authenticated users.
external boolean When clicked, open the link in a new window
View JSON Schema on GitHub

JSON Schema

kong-portalmenuitem-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PortalMenuItem",
  "title": "PortalMenuItem",
  "type": "object",
  "properties": {
    "path": {
      "description": "The absolute path of a page in a portal with a leading slash.",
      "type": "string",
      "example": "/about/company",
      "maxLength": 512
    },
    "title": {
      "description": "The link display text",
      "type": "string",
      "example": "My Page"
    },
    "visibility": {
      "description": "Whether a menu item is public or private. Private menu items are only accessible to authenticated users.",
      "type": "string",
      "example": "public",
      "enum": [
        "public",
        "private"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "external": {
      "description": "When clicked, open the link in a new window",
      "type": "boolean"
    }
  },
  "additionalProperties": false,
  "required": [
    "path",
    "title",
    "visibility",
    "external"
  ]
}