Skip to content

Instantly share code, notes, and snippets.

@letzya
Created May 1, 2025 14:36
Show Gist options
  • Save letzya/f73f3b7c7f402c8f1348c254f108d47a to your computer and use it in GitHub Desktop.
Save letzya/f73f3b7c7f402c8f1348c254f108d47a to your computer and use it in GitHub Desktop.
menu-yaml-with-tabs-on-top
# yamllint disable rule:line-length rule:truthy
---
menu:
- title: "Home"
path: /
category: Label
tab_on_top: true
show: True
- title: "API Management"
path: /getting-started
category: Label
show: True
tab_on_top: true
menu:
- title: "Overview"
category: Label
show: True
menu:
- title: "Overview"
path: /tyk-overview
category: Page
show: True
- title: "Tyk Components"
path: /tyk-components
category: Page
show: True
- title: "Deployment Options"
path: /apim
category: Page
show: True
- title: "Plan Your API Integration"
path: /plan-your-api-integration
category: Page
show: True
- title: "Getting Started"
category: Label
show: True
menu:
- title: "Create Account"
path: /getting-started/create-account
category: Page
show: True
- title: "Configure Your First API"
path: /getting-started/configure-first-api
category: Page
show: True
- title: "Using Tyk Dashboard"
path: /getting-started/using-tyk-dashboard
category: Page
show: True
- title: "Manage API"
category: Label
show: True
menu:
- title: "Overview"
path: /getting-started
category: Page
show: True
- title: "Deploy Tyk"
category: Directory
show: True
menu:
- title: "Tyk Stack"
path: /tyk-stack
category: Page
show: True
- title: "Tyk Cloud"
path: /tyk-cloud
category: Page
show: True
- title: "Tyk Open Source"
path: /tyk-open-source
category: Page
show: True
- title: "Tyk Self Managed"
path: /tyk-self-managed
category: Page
show: True
- title: "Tyk Gateway"
path: /tyk-oss-gateway
category: Page
show: True
- title: "Client Authentication"
category: Directory
path: /api-management/client-authentication
show: True
menu:
- title: "JSON Web Tokens"
path: /basic-config-and-security/security/authentication-authorization/json-web-tokens
category: Page
show: True
- title: "HMAC Signatures"
path: /basic-config-and-security/security/authentication-authorization/hmac-signatures
category: Page
show: True
- title: "Upstream Authentication"
path: /api-management/upstream-authentication
category: Page
show: True
- title: "API Traffic Control"
category: Directory
show: True
menu:
- title: "Rate Limiting"
path: /api-management/rate-limit
category: Page
show: True
- title: "Request Quotas"
path: /api-management/request-quotas
category: Page
show: True
- title: "Request Throttling"
path: /api-management/request-throttling
category: Page
show: True
- title: "Security Policy and Access Keys"
path: /api-management/policies
category: Page
show: True
- title: "Certificates"
path: /api-management/certificates
category: Page
show: True
- title: "Security Best Practices"
category: Page
show: True
path: /api-management/security-best-practices
- title: "Security Features"
category: Page
show: True
path: /api-management/security-features
- title: "Tyk API Definitions"
category: Directory
path: /api-management/gateway-config-introduction
show: True
menu:
- title: "Tyk OAS"
path: /api-management/gateway-config-tyk-oas
category: Page
show: True
- title: "Tyk Classic"
path: /api-management/gateway-config-tyk-classic
category: Page
show: True
- title: "What is URL path matching?"
path: /getting-started/key-concepts/url-matching
category: Page
show: True
- title: "What is Internal Looping?"
path: /advanced-configuration/transform-traffic/looping
category: Page
show: True
- title: "Manage APIs"
category: Directory
show: True
menu:
- title: "Tyk OAS APIs"
path: /api-management/gateway-config-managing-oas
category: Page
show: True
- title: "Tyk Classic APIs"
path: /api-management/gateway-config-managing-classic
category: Page
show: True
- title: "Migrate from Tyk Classic"
path: /api-management/migrate-from-tyk-classic
category: Page
show: True
- title: "Deploy APIs"
category: Page
show: True
path: /api-management/manage-apis/deploy-apis/deploy-apis-overview
- title: "Useful Configurations"
path: /tyk-stack/tyk-gateway/important-prerequisites
category: Page
show: True
- title: "Monitoring and Troubleshooting APIs"
category: Page
show: True
path: /api-management/manage-apis/api-operations/api-observability
- title: "Manage Tyk Dashboard"
path: /api-management/dashboard-configuration
category: Page
show: True
- title: "API Versioning"
path: /api-management/api-versioning
category: Page
show: True
- title: "Identity Management"
path: /api-management/external-service-integration
category: Page
show: True
- title: "Custom Plugins"
category: Directory
show: True
menu:
- title: "Overview"
path: /api-management/plugins/overview
category: Page
show: True
- title: "Plugin Types"
path: /api-management/plugins/plugin-types
category: Page
show: True
- title: "Golang Plugins"
path: /api-management/plugins/golang
category: Page
show: True
- title: "Javscript Plugins"
path: /api-management/plugins/javascript
category: Page
show: True
- title: "Rich Plugins"
path: /api-management/plugins/rich-plugins
category: Page
show: True
- title: "Advance Configuration"
path: /api-management/plugins/advance-config
category: Page
show: True
- title: "Event Driven APIs"
category: Directory
show: True
menu:
- title: "Tyk Streams"
path: /api-management/event-driven-apis
category: Page
show: True
- title: "Tyk Streams Reference"
path: /api-management/stream-config
category: Page
show: True
- title: "GraphQL"
path: /api-management/graphql
category: Page
show: True
- title: "Universal Data Graph (UDG)"
path: /api-management/data-graph
category: Page
show: True
- title: "TCP Proxy"
path: /key-concepts/tcp-proxy
category: Page
show: True
- title: "Other Non HTTP Protocols"
path: /api-management/non-http-protocols
category: Page
show: True
- title: "Request Optimization"
category: Directory
show: True
menu:
- title: "Response Caching"
path: /api-management/response-caching
category: Page
show: True
- title: "Batch Processing"
path: /api-management/batch-processing
category: Page
show: True
- title: "API Observability"
category: Directory
show: True
menu:
- title: "Metrics and Logs"
path: /api-management/logs-metrics
category: Page
show: True
- title: "Metrics Exporter"
path: /api-management/tyk-pump
category: Page
show: True
- title: "Performance Monitoring"
path: /api-management/performance-monitoring
category: Page
show: True
- title: "Traffic Transformation"
category: Directory
show: True
menu:
- title: "Overview"
path: /api-management/traffic-transformation
category: Page
show: True
- title: "SOAP to REST"
path: /advanced-configuration/transform-traffic/soap-rest
category: Page
show: True
- title: "URL Rewrite"
path: /transform-traffic/url-rewriting
category: Page
show: True
- title: "Gateway Events"
path: /api-management/gateway-events
category: Page
show: True
- title: "Manage Distributed Gateways"
path: /api-management/mdcb
category: Page
show: True
- title: "Automations Tools"
category: Directory
show: True
menu:
- title: "Overview"
path: /api-management/automations
category: Page
show: True
- title: "API Management in Kubernetes"
path: /api-management/automations/operator
category: Page
show: True
- title: "Synchronizing Tyk Configuration"
path: /api-management/automations/sync
category: Page
show: True
- title: "Manage Environments"
path: /api-management/multiple-environments
category: Page
show: True
- title: "Tyk Helm Charts"
category: Directory
show: True
menu:
- title: "Overview"
path: /product-stack/tyk-charts/overview
category: Page
show: True
- title: "Tyk Stack Chart"
path: /product-stack/tyk-charts/tyk-stack-chart
category: Page
show: True
- title: "Tyk Control Plane Chart"
path: /product-stack/tyk-charts/tyk-control-plane-chart
category: Page
show: True
- title: "Tyk Data Plane Chart"
path: /product-stack/tyk-charts/tyk-data-plane-chart
category: Page
show: True
- title: "Tyk Open Source Chart"
path: /product-stack/tyk-charts/tyk-oss-chart
category: Page
show: True
- title: "User Management"
path: /api-management/user-management
category: Page
show: True
- title: "Troubleshooting"
path: /api-management/troubleshooting-debugging
category: Page
show: True
- title: "Developer Portal"
category: Label
show: True
path: /portal/overview
tab_on_top: true
menu:
- title: "Overview"
path: /portal/overview
category: Page
show: True
- title: "Install and Configure"
path: /portal/install
category: Page
show: True
- title: "API Consumer"
path: /portal/api-consumer
category: Page
show: True
- title: "API Provider"
path: /portal/api-provider
category: Page
show: True
- title: "Customization"
path: /portal/customization
category: Page
show: True
- title: "Advance Configuration"
path: /portal/settings
category: Page
show: True
- title: "Tyk Classic Developer Portal"
category: Directory
show: True
menu:
- title: "Overview"
path: /tyk-developer-portal/tyk-portal-classic
category: Page
show: True
- title: "Portal Concepts"
path: /tyk-developer-portal/tyk-portal-classic/portal-concepts
category: Page
show: True
- title: "Portal API Catalogue"
path: /getting-started/key-concepts/api-catalogue
category: Page
show: True
- title: "Publish an API"
path: /getting-started/tutorials/publish-api
category: Page
show: True
- title: "Advanced configurations"
category: Directory
show: True
menu:
- title: "Key Requests"
path: /tyk-developer-portal/tyk-portal-classic/key-requests
category: Page
show: True
- title: "Developer Profiles"
path: /tyk-developer-portal/tyk-portal-classic/developer-profiles
category: Page
show: True
- title: "Dynamic Client Registration (DCR)"
category: Directory
show: True
menu:
- title: "Overview"
path: /tyk-developer-portal/tyk-portal-classic/dynamic-client-registration
category: Page
show: True
- title: "Step by step guide using Gluu"
path: /tyk-developer-portal/tyk-portal-classic/gluu-dcr
category: Page
show: True
- title: "Step by step guide using Keycloak"
path: /tyk-developer-portal/tyk-portal-classic/keycloak-dcr
category: Page
show: True
- title: "Step by step guide using Okta"
path: /tyk-developer-portal/tyk-portal-classic/okta-dcr
category: Page
show: True
- title: "Step by step guide using Curity"
path: /tyk-developer-portal/tyk-portal-classic/curity-dcr
category: Page
show: True
- title: "Portal OAuth Clients"
path: /tyk-developer-portal/tyk-portal-classic/portal-oauth-clients
category: Page
show: True
- title: "GraphQL with Classic Portal"
path: /tyk-developer-portal/tyk-portal-classic/graphql
category: Page
show: True
- title: "Streams with Classic Portal"
path: /tyk-developer-portal/tyk-portal-classic/streams
category: Page
show: True
- title: "Monetising your APIs"
path: /tyk-developer-portal/tyk-portal-classic/monetise
category: Page
show: True
- title: "Events and Notifications"
path: /tyk-developer-portal/tyk-portal-classic/portal-events-notifications
category: Page
show: True
- title: "Outbound Email Configuration"
path: /configure/outbound-email-configuration
category: Page
show: True
- title: "Portal customisation"
category: Directory
show: True
menu:
- title: "Overview"
path: /tyk-developer-portal/customise
category: Page
show: True
- title: "Customising API Visibility"
path: /tyk-developer-portal/customise/customize-api-visibility
category: Page
show: True
- title: "Customise the Portal Menus"
path: /tyk-developer-portal/tyk-portal-classic/customise/changing-the-navigation
category: Page
show: True
- title: "Creating a Custom Developer Portal"
path: /tyk-developer-portal/tyk-portal-classic/customise/custom-developer-portal
category: Page
show: True
- title: "Swap out Swagger UI for ReDoc"
path: /tyk-developer-portal/tyk-portal-classic/customise/customise-documentation
category: Page
show: True
- title: "Customise Pages with CSS and JavaScript"
path: /tyk-developer-portal/tyk-portal-classic/customise/customising-using-dashboard
category: Page
show: True
- title: "Customising using jQuery"
path: /tyk-developer-portal/tyk-portal-classic/customise/customize-with-jquery
category: Page
show: True
- title: "Customise the Developer Signup Form"
path: /tyk-developer-portal/tyk-portal-classic/customise/developer-meta-data
category: Page
show: True
- title: "Customise Page Templates"
path: /tyk-developer-portal/tyk-portal-classic/tyk-portal-classic/customise/customise-with-templates
category: Page
show: True
- title: "API documentation"
category: Directory
show: True
menu:
- title: "Overview"
path: /tyk-portal-api
category: Page
show: True
- title: "Configuration"
path: /tyk-apis/tyk-portal-api/portal-configuration
category: Page
show: True
- title: "Developers"
path: /tyk-apis/tyk-portal-api/portal-developers
category: Page
show: True
- title: "API Publishing"
path: /tyk-apis/tyk-portal-api/portal-documentation
category: Page
show: True
- title: "Key Requests"
path: /tyk-apis/tyk-portal-api/portal-keys
category: Page
show: True
- title: "Troubleshooting"
category: Directory
show: True
menu:
- title: "How to add, list or delete a developer using the API"
path: /frequently-asked-questions/add-list-delete-developer-using-api
category: Page
show: True
- title: "Alerts on new developer key requests"
path: /frequently-asked-questions/alerts-new-developer-key-requests
category: Page
show: True
- title: "Custom Developer Portal Options"
path: /frequently-asked-questions/custom-developer-portal-options
category: Page
show: True
- title: "“API catalogue not found“ error in the Developer Portal"
path: /troubleshooting/tyk-dashboard/api-catalogue-not-found-error-developer-portal
category: Page
show: True
- title: "CORS issues on developer portal"
path: /troubleshooting/tyk-dashboard/cors-issues-on-developer-portal
category: Page
show: True
- title: "“Not Found“ error in the Developer Portal"
path: /troubleshooting/tyk-dashboard/not-found-error-developer-portal
category: Page
show: True
- title: "Receive a CSRF error in the Developer Portal"
path: /troubleshooting/tyk-dashboard/receive-csrf-error-developer-portal
category: Page
show: True
- title: "Dashboard API"
category: Directory
show: True
menu:
- title: "Classic Portal"
category: Directory
show: True
menu:
- title: "Portal Key Requests"
path: /tyk-apis/tyk-dashboard-api/manage-key-requests
category: Page
show: True
- title: "Portal Policies"
path: /tyk-apis/tyk-dashboard-api/portal-policies
category: Page
show: True
- title: "AI Management"
category: Label
show: True
tab_on_top: true
path: /ai-management/overview
menu:
- title: "Overview"
category: Page
path: /ai-management/overview
show: True
- title: "MCPs"
path: /ai-management/mcps/overview
category: Directory
show: True
menu:
- title: "API to MCP"
category: Page
path: /ai-management/mcps/api-to-mcp
show: True
- title: "Dashboard API to MCP"
category: Page
path: /ai-management/mcps/dashboard-api-to-mcp
show: True
- title: "Tyk Docs MCP"
category: Page
path: /ai-management/mcps/tyk-docs-mcp
show: True
- title: "AI Studio"
path: /ai-management/ai-studio/overview
category: Directory
show: True
menu:
- title: "Introduction"
category: Directory
show: True
menu:
- title: "Quickstart"
category: Page
path: /ai-management/ai-studio/quickstart
show: True
- title: "Core Concepts"
category: Page
path: /ai-management/ai-studio/core-concepts
show: True
- title: "Getting Started"
category: Directory
show: True
menu:
- title: "Installation (Helm/K8s)"
category: Page
path: /ai-management/ai-studio/deployment-helm-k8s
show: True
- title: "Initial Configuration"
category: Page
path: /ai-management/ai-studio/configuration
show: True
- title: "Core Features"
category: Directory
show: True
menu:
- title: "AI Gateway"
category: Page
path: /ai-management/ai-studio/proxy
show: True
- title: "AI Portal"
category: Page
path: /ai-management/ai-studio/ai-portal
show: True
- title: "Chat Interface"
category: Page
path: /ai-management/ai-studio/chat-interface
show: True
- title: "LLM Management"
category: Page
path: /ai-management/ai-studio/llm-management
show: True
- title: "Tools & Extensibility"
category: Page
path: /ai-management/ai-studio/tools
show: True
- title: "Data Sources & RAG"
category: Page
path: /ai-management/ai-studio/datasources-rag
show: True
- title: "Filters & Policies"
category: Page
path: /ai-management/ai-studio/filters
show: True
- title: "Administration"
category: Directory
show: True
menu:
- title: "User Management & RBAC"
category: Page
path: /ai-management/ai-studio/user-management
show: True
- title: "SSO Integration"
category: Page
path: /ai-management/ai-studio/sso
show: True
- title: "Secrets Management"
category: Page
path: /ai-management/ai-studio/secrets
show: True
- title: "Budget Control"
category: Page
path: /ai-management/ai-studio/budgeting
show: True
- title: "Analytics & Monitoring"
category: Page
path: /ai-management/ai-studio/analytics
show: True
- title: "Notifications"
category: Page
path: /ai-management/ai-studio/notifications
show: True
- title: "API Documentation"
category: Page
path: /ai-management/ai-studio/ai-studio-swagger
show: True
- title: "API Governance"
category: Label
show: True
tab_on_top: true
path: /tyk-governance/overview
menu:
- title: "Overview"
path: /tyk-governance/overview
category: Page
show: True
- title: "Core Concepts"
path: /tyk-governance/core-concepts
category: Page
show: True
- title: "Installation"
path: /tyk-governance/installation
category: Page
show: True
- title: "Federated API Repository"
path: /tyk-governance/api-repository
category: Page
show: True
- title: "API Labeling and Categorization"
path: /tyk-governance/api-labeling
category: Page
show: True
- title: "Developer Support"
category: Label
show: True
tab_on_top: true
path: /developer-support/community
menu:
- title: "Community Support"
path: /developer-support/community
category: Page
show: True
- title: "Support SLA"
path: /developer-support/support
category: Page
show: True
- title: "Tyk Release Types"
category: Directory
show: True
menu:
- title: "Long Term Support Release"
path: /developer-support/release-types/long-term-support
category: Page
show: True
- title: "Early access feature"
path: /developer-support/release-types/early-access-feature
category: Page
show: True
- title: "Lab Release"
path: /developer-support/release-types/lab-release
category: Page
show: True
- title: "FIPS Release"
path: /developer-support/release-types/fips-release
category: Page
show: True
- title: "Environment Variables and Configs"
category: Directory
show: True
menu:
- title: "Gateway"
path: /tyk-oss-gateway/configuration
category: Page
show: True
- title: "Dashboard"
path: /tyk-dashboard/configuration
category: Page
show: True
- title: "Pump"
path: /tyk-pump/tyk-pump-configuration/tyk-pump-environment-variables
category: Page
show: True
- title: "Enterprise Developer Portal"
path: /product-stack/tyk-enterprise-developer-portal/deploy/configuration
category: Page
show: True
- title: "Multi Data Center Bridge"
path: /tyk-multi-data-centre/mdcb-configuration-options
category: Page
show: True
- title: "Tyk Identity Broker"
path: /tyk-configuration-reference/tyk-identity-broker-configuration
category: Page
show: True
- title: "API Documentation"
category: Directory
show: True
menu:
- title: "Overview"
path: /tyk-apis
category: Page
show: True
- title: "Gateway"
path: /tyk-gateway-api
category: Page
show: True
- title: "Dashboard"
path: /tyk-dashboard-api
category: Page
show: True
- title: "Dashboard Admin"
path: /dashboard-admin-api
category: Page
show: True
- title: "Multi Data Center Bridge"
path: /tyk-mdcb-api
category: Page
show: True
- title: "Enterprise Developer Portal"
path: /product-stack/tyk-enterprise-developer-portal/api-documentation/tyk-edp-api
category: Page
show: True
- title: "Enterprise Developer Portal Admin"
path: /product-stack/tyk-enterprise-developer-portal/api-documentation/list-of-endpoints/portal-1.13.0-list-of-endpoints
category: Page
show: True
- title: "Tyk Identity Broker"
path: /tyk-identity-broker/tib-rest-api
category: Page
show: True
- title: "Release Notes"
category: Directory
show: True
menu:
- title: "Latest Tyk Releases"
path: /developer-support/release-notes/overview
category: Page
show: True
- title: "Gateway"
path: /developer-support/release-notes/gateway
category: Page
show: True
- title: "Dashboard"
path: /developer-support/release-notes/dashboard
category: Page
show: True
- title: "Pump"
path: /developer-support/release-notes/pump
category: Page
show: True
- title: "Sync"
path: /developer-support/release-notes/sync
category: Page
show: True
- title: "Multi Data Center Bridge"
path: /developer-support/release-notes/mdcb
category: Page
show: True
- title: "Enterprise Developer Portal"
path: /developer-support/release-notes/portal
category: Page
show: True
- title: "Tyk Operator"
path: /developer-support/release-notes/operator
category: Page
show: True
- title: "Tyk Chart"
path: /developer-support/release-notes/helm-chart
category: Page
show: True
- title: "Tyk Identity Broker"
path: /developer-support/release-notes/tib
category: Page
show: True
- title: "Tyk Cloud"
path: /developer-support/release-notes/cloud
category: Page
show: True
- title: "Archived Releases"
path: /developer-support/release-notes/archived
category: Page
show: True
- title: "Deprecation"
path: /developer-support/deprecation
category: Page
show: True
- title: "Upgrading Guide"
path: /developer-support/upgrading
category: Page
show: True
- title: "Frequently Asked Questions"
path: /developer-support/faq
category: Page
show: True
- title: "Docs Contribution"
path: /developer-support/contributing
category: Directory
show: True
menu:
- title: "UI Example: Pill Label shortcode"
path: /ui-examples/test-pill-label
category: Page
show: true
- title: "UI Example: Feature Cards shortcode"
path: /ui-examples/feature-cards
category: Page
show: true
- title: "UI Example: YouTube Video Embed shortcode"
path: /ui-examples/youtube-video-embed
category: Page
show: true
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment