zuplo 7.12.5 → 7.12.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (579) hide show
  1. package/docs/ai-gateway/apps.mdx +3 -0
  2. package/docs/ai-gateway/azure-ai.mdx +3 -0
  3. package/docs/ai-gateway/bedrock-mantle.mdx +3 -0
  4. package/docs/ai-gateway/bedrock-runtime.mdx +3 -0
  5. package/docs/ai-gateway/budget-alerts.mdx +3 -0
  6. package/docs/ai-gateway/cookbooks/custom-fallback.mdx +3 -0
  7. package/docs/ai-gateway/cookbooks/dynamic-model-routing.mdx +3 -0
  8. package/docs/ai-gateway/cookbooks/sdk-path-shim.mdx +3 -0
  9. package/docs/ai-gateway/custom-policies.mdx +3 -0
  10. package/docs/ai-gateway/custom-pricing.mdx +3 -0
  11. package/docs/ai-gateway/custom-providers.mdx +3 -0
  12. package/docs/ai-gateway/fallback.mdx +3 -0
  13. package/docs/ai-gateway/integrations/ai-sdk.mdx +3 -0
  14. package/docs/ai-gateway/integrations/claude-code.mdx +3 -0
  15. package/docs/ai-gateway/integrations/claude-desktop.mdx +3 -0
  16. package/docs/ai-gateway/integrations/codex.mdx +3 -0
  17. package/docs/ai-gateway/integrations/github-copilot.mdx +3 -0
  18. package/docs/ai-gateway/integrations/goose.mdx +3 -0
  19. package/docs/ai-gateway/integrations/langchain.mdx +3 -0
  20. package/docs/ai-gateway/integrations/openai.mdx +3 -0
  21. package/docs/ai-gateway/jev.mdx +3 -0
  22. package/docs/ai-gateway/managing-apps.mdx +3 -0
  23. package/docs/ai-gateway/managing-pools.mdx +3 -0
  24. package/docs/ai-gateway/managing-providers.mdx +3 -0
  25. package/docs/ai-gateway/openrouter.mdx +3 -0
  26. package/docs/ai-gateway/overview.mdx +3 -0
  27. package/docs/ai-gateway/policies/overview.mdx +3 -0
  28. package/docs/ai-gateway/policy-chains.mdx +3 -0
  29. package/docs/ai-gateway/policy-templates.mdx +3 -0
  30. package/docs/ai-gateway/pools.mdx +3 -0
  31. package/docs/ai-gateway/providers.mdx +3 -0
  32. package/docs/ai-gateway/source-control.mdx +3 -0
  33. package/docs/ai-gateway/universal-api.mdx +3 -0
  34. package/docs/ai-gateway/usage-limits.mdx +3 -0
  35. package/docs/ai-gateway/user-apps.mdx +3 -0
  36. package/docs/ai-gateway/vertex-ai.mdx +3 -0
  37. package/docs/analytics/access-and-entitlements.md +3 -0
  38. package/docs/analytics/overview.md +9 -0
  39. package/docs/analytics/reference/metrics-glossary.md +3 -0
  40. package/docs/analytics/reference/url-parameters.md +3 -0
  41. package/docs/analytics/shared-controls.md +3 -0
  42. package/docs/analytics/tabs/agents.md +3 -0
  43. package/docs/analytics/tabs/consumers.md +3 -0
  44. package/docs/analytics/tabs/graphql.md +3 -0
  45. package/docs/analytics/tabs/mcp.md +3 -0
  46. package/docs/analytics/tabs/origins.md +3 -0
  47. package/docs/analytics/tabs/requests.md +12 -0
  48. package/docs/api-management/overview.md +12 -0
  49. package/docs/articles/accounts/audit-logs.mdx +3 -0
  50. package/docs/articles/accounts/billing.mdx +3 -0
  51. package/docs/articles/accounts/default-api-key.mdx +3 -0
  52. package/docs/articles/accounts/delete-account.mdx +3 -0
  53. package/docs/articles/accounts/enterprise-sso.mdx +3 -0
  54. package/docs/articles/accounts/managing-account-members.mdx +3 -0
  55. package/docs/articles/accounts/managing-project-members.mdx +3 -0
  56. package/docs/articles/accounts/members-and-roles.mdx +3 -0
  57. package/docs/articles/accounts/renew-sso-credentials.mdx +3 -0
  58. package/docs/articles/accounts/roles-and-permissions.mdx +3 -0
  59. package/docs/articles/accounts/switching-between-accounts.mdx +3 -0
  60. package/docs/articles/accounts/zuplo-api-keys.mdx +3 -0
  61. package/docs/articles/add-api-to-backstage.mdx +3 -0
  62. package/docs/articles/advanced-path-matching.mdx +3 -0
  63. package/docs/articles/api-key-administration.mdx +3 -0
  64. package/docs/articles/api-key-api.mdx +3 -0
  65. package/docs/articles/api-key-authentication.mdx +3 -0
  66. package/docs/articles/api-key-best-practices.mdx +10 -0
  67. package/docs/articles/api-key-buckets.mdx +3 -0
  68. package/docs/articles/api-key-consumer-bucket-portal-ui.mdx +3 -0
  69. package/docs/articles/api-key-end-users.mdx +3 -0
  70. package/docs/articles/api-key-leak-detection.mdx +3 -0
  71. package/docs/articles/api-key-management.mdx +10 -0
  72. package/docs/articles/api-key-metadata.mdx +3 -0
  73. package/docs/articles/api-key-react-component.mdx +3 -0
  74. package/docs/articles/api-key-self-serve-integration.mdx +3 -0
  75. package/docs/articles/api-key-service-limits.mdx +3 -0
  76. package/docs/articles/archiving-requests-to-storage.mdx +11 -0
  77. package/docs/articles/audit-logging.mdx +3 -0
  78. package/docs/articles/audit-logs.mdx +3 -0
  79. package/docs/articles/branch-based-deployments.mdx +13 -0
  80. package/docs/articles/bypass-policy-for-testing.mdx +3 -0
  81. package/docs/articles/certificate-pinning.mdx +12 -0
  82. package/docs/articles/check-ip-address.mdx +17 -9
  83. package/docs/articles/ci-cd-azure/basic-deployment.mdx +8 -0
  84. package/docs/articles/ci-cd-azure/deploy-and-test.mdx +8 -0
  85. package/docs/articles/ci-cd-azure/local-testing.mdx +8 -0
  86. package/docs/articles/ci-cd-azure/multi-stage-deployment.mdx +8 -0
  87. package/docs/articles/ci-cd-azure/pr-preview-environments.mdx +8 -0
  88. package/docs/articles/ci-cd-azure/tag-based-releases.mdx +8 -0
  89. package/docs/articles/ci-cd-bitbucket/basic-deployment.mdx +8 -0
  90. package/docs/articles/ci-cd-bitbucket/deploy-and-test.mdx +8 -0
  91. package/docs/articles/ci-cd-bitbucket/local-testing.mdx +8 -0
  92. package/docs/articles/ci-cd-bitbucket/multi-stage-deployment.mdx +8 -0
  93. package/docs/articles/ci-cd-bitbucket/pr-preview-environments.mdx +8 -0
  94. package/docs/articles/ci-cd-bitbucket/tag-based-releases.mdx +8 -0
  95. package/docs/articles/ci-cd-circleci/basic-deployment.mdx +8 -0
  96. package/docs/articles/ci-cd-circleci/deploy-and-test.mdx +8 -0
  97. package/docs/articles/ci-cd-circleci/local-testing.mdx +8 -0
  98. package/docs/articles/ci-cd-circleci/multi-stage-deployment.mdx +8 -0
  99. package/docs/articles/ci-cd-circleci/pr-preview-environments.mdx +8 -0
  100. package/docs/articles/ci-cd-circleci/tag-based-releases.mdx +8 -0
  101. package/docs/articles/ci-cd-github/basic-deployment.mdx +8 -0
  102. package/docs/articles/ci-cd-github/cleanup-on-branch-delete.mdx +8 -0
  103. package/docs/articles/ci-cd-github/deploy-and-test.mdx +8 -0
  104. package/docs/articles/ci-cd-github/local-testing.mdx +8 -0
  105. package/docs/articles/ci-cd-github/multi-stage-deployment.mdx +8 -0
  106. package/docs/articles/ci-cd-github/pr-preview-environments.mdx +8 -0
  107. package/docs/articles/ci-cd-github/tag-based-releases.mdx +8 -0
  108. package/docs/articles/ci-cd-gitlab/basic-deployment.mdx +8 -0
  109. package/docs/articles/ci-cd-gitlab/deploy-and-test.mdx +8 -0
  110. package/docs/articles/ci-cd-gitlab/local-testing.mdx +8 -0
  111. package/docs/articles/ci-cd-gitlab/mr-preview-environments.mdx +8 -0
  112. package/docs/articles/ci-cd-gitlab/multi-stage-deployment.mdx +8 -0
  113. package/docs/articles/ci-cd-gitlab/tag-based-releases.mdx +8 -0
  114. package/docs/articles/composite-policy-reference.mdx +3 -0
  115. package/docs/articles/configuring-auth0-for-mcp-auth.mdx +3 -0
  116. package/docs/articles/configuring-okta-for-mcp-auth.mdx +3 -0
  117. package/docs/articles/connect-to-aws-alb-with-mtls.mdx +10 -0
  118. package/docs/articles/convert-urls-to-openapi.mdx +3 -0
  119. package/docs/articles/cors.mdx +3 -0
  120. package/docs/articles/custom-audit-logs.mdx +3 -0
  121. package/docs/articles/custom-ci-cd-azure.mdx +8 -0
  122. package/docs/articles/custom-ci-cd-bitbucket.mdx +8 -0
  123. package/docs/articles/custom-ci-cd-circleci.mdx +8 -0
  124. package/docs/articles/custom-ci-cd-github.mdx +8 -0
  125. package/docs/articles/custom-ci-cd-gitlab.mdx +8 -0
  126. package/docs/articles/custom-ci-cd.mdx +8 -0
  127. package/docs/articles/custom-code-patterns.md +3 -0
  128. package/docs/articles/custom-domains.mdx +10 -0
  129. package/docs/articles/custom-logging-example.mdx +3 -0
  130. package/docs/articles/ddos-protection.mdx +3 -0
  131. package/docs/articles/development-options.mdx +7 -0
  132. package/docs/articles/environment-variables.mdx +8 -0
  133. package/docs/articles/environments.mdx +18 -8
  134. package/docs/articles/fastly-zuplo-host-setup.mdx +3 -0
  135. package/docs/articles/feature-flags.mdx +3 -0
  136. package/docs/articles/github-deployment-testing.mdx +3 -0
  137. package/docs/articles/gke-with-upstream-auth-policy.mdx +3 -0
  138. package/docs/articles/graphql-caching.mdx +3 -0
  139. package/docs/articles/graphql-security.mdx +3 -0
  140. package/docs/articles/graphql-support.mdx +3 -0
  141. package/docs/articles/graphql.mdx +3 -0
  142. package/docs/articles/handling-form-data.mdx +3 -0
  143. package/docs/articles/health-checks.mdx +3 -0
  144. package/docs/articles/hosting-options.mdx +3 -0
  145. package/docs/articles/lazy-load-configuration-into-cache.mdx +3 -0
  146. package/docs/articles/limits.mdx +7 -0
  147. package/docs/articles/local-development-debugging.mdx +3 -0
  148. package/docs/articles/local-development-env-variables.mdx +3 -0
  149. package/docs/articles/local-development-installing-packages.mdx +3 -0
  150. package/docs/articles/local-development-routes-designer.mdx +3 -0
  151. package/docs/articles/local-development-services.mdx +3 -0
  152. package/docs/articles/local-development-troubleshooting.mdx +7 -0
  153. package/docs/articles/local-development.mdx +3 -0
  154. package/docs/articles/log-plugin-aws-cloudwatch.mdx +14 -0
  155. package/docs/articles/log-plugin-datadog.mdx +3 -0
  156. package/docs/articles/log-plugin-dynatrace.mdx +14 -0
  157. package/docs/articles/log-plugin-gcp.mdx +14 -0
  158. package/docs/articles/log-plugin-loki.mdx +14 -0
  159. package/docs/articles/log-plugin-new-relic.mdx +3 -0
  160. package/docs/articles/log-plugin-splunk.mdx +3 -0
  161. package/docs/articles/log-plugin-sumo.mdx +14 -0
  162. package/docs/articles/log-plugin-vmware-log-insight.mdx +3 -0
  163. package/docs/articles/log-request-response-data.mdx +3 -0
  164. package/docs/articles/logging.mdx +14 -0
  165. package/docs/articles/manual-mcp-oauth-testing.mdx +3 -0
  166. package/docs/articles/metrics-plugins.mdx +10 -0
  167. package/docs/articles/migrate-from-apigee.md +10 -0
  168. package/docs/articles/migrate-from-aws-api-gateway.md +3 -0
  169. package/docs/articles/migrate-from-azure-apim.md +10 -0
  170. package/docs/articles/migrate-from-kong.md +10 -0
  171. package/docs/articles/migration-overview.md +10 -0
  172. package/docs/articles/monetization/api-access.mdx +3 -0
  173. package/docs/articles/monetization/billing-models.md +3 -0
  174. package/docs/articles/monetization/developer-portal.md +8 -0
  175. package/docs/articles/monetization/dynamic-metering.md +3 -0
  176. package/docs/articles/monetization/features.mdx +3 -0
  177. package/docs/articles/monetization/going-to-production.mdx +3 -0
  178. package/docs/articles/monetization/index.mdx +3 -0
  179. package/docs/articles/monetization/meters.mdx +3 -0
  180. package/docs/articles/monetization/monetization-policy.md +3 -0
  181. package/docs/articles/monetization/plan-examples.mdx +3 -0
  182. package/docs/articles/monetization/plans.mdx +3 -0
  183. package/docs/articles/monetization/pricing-models.mdx +3 -0
  184. package/docs/articles/monetization/private-plans.md +3 -0
  185. package/docs/articles/monetization/programmatic-monetization.md +3 -0
  186. package/docs/articles/monetization/quickstart.md +8 -0
  187. package/docs/articles/monetization/rate-cards.mdx +3 -0
  188. package/docs/articles/monetization/stripe-integration.md +3 -0
  189. package/docs/articles/monetization/subscription-data.md +3 -0
  190. package/docs/articles/monetization/subscription-lifecycle.md +3 -0
  191. package/docs/articles/monetization/tax-collection.md +3 -0
  192. package/docs/articles/monetization/troubleshooting.md +3 -0
  193. package/docs/articles/monetization-custom.mdx +3 -0
  194. package/docs/articles/monetization-integrations.mdx +3 -0
  195. package/docs/articles/monitoring-your-gateway.mdx +3 -0
  196. package/docs/articles/monorepo-deployment.mdx +3 -0
  197. package/docs/articles/multiple-auth-policies.mdx +3 -0
  198. package/docs/articles/non-standard-ports.mdx +3 -0
  199. package/docs/articles/oauth-authentication.mdx +3 -0
  200. package/docs/articles/openapi-server-urls.mdx +12 -0
  201. package/docs/articles/openapi-string-format-validation-warnings.mdx +3 -0
  202. package/docs/articles/openapi.mdx +3 -0
  203. package/docs/articles/opentelemetry.mdx +3 -0
  204. package/docs/articles/performance-testing.mdx +9 -0
  205. package/docs/articles/plugin-akamai-api-security.mdx +3 -0
  206. package/docs/articles/plugin-azure-blob.mdx +3 -0
  207. package/docs/articles/plugin-azure-event-hubs.mdx +3 -0
  208. package/docs/articles/plugin-hydrolix-traffic-peak.mdx +12 -0
  209. package/docs/articles/policies.mdx +3 -0
  210. package/docs/articles/rename-or-move-project.mdx +3 -0
  211. package/docs/articles/rick-and-morty-api-developer-portal-example.mdx +3 -0
  212. package/docs/articles/routing.mdx +3 -0
  213. package/docs/articles/s3-signed-url-uploads.mdx +8 -0
  214. package/docs/articles/secure-tunnel.mdx +16 -5
  215. package/docs/articles/securing-backend-mtls.mdx +9 -0
  216. package/docs/articles/securing-the-gateway-with-client-mtls.mdx +3 -0
  217. package/docs/articles/securing-your-backend.mdx +7 -0
  218. package/docs/articles/security.mdx +11 -0
  219. package/docs/articles/sharing-code-across-projects.mdx +3 -0
  220. package/docs/articles/source-control-setup-azure.mdx +3 -0
  221. package/docs/articles/source-control-setup-bitbucket.mdx +3 -0
  222. package/docs/articles/source-control-setup-github.mdx +3 -0
  223. package/docs/articles/source-control-setup-gitlab.mdx +3 -0
  224. package/docs/articles/source-control.mdx +12 -0
  225. package/docs/articles/streaming-responses-sse.mdx +3 -0
  226. package/docs/articles/support.mdx +3 -0
  227. package/docs/articles/terraform.mdx +3 -0
  228. package/docs/articles/testing-getting-started.mdx +3 -0
  229. package/docs/articles/testing-graphql.mdx +3 -0
  230. package/docs/articles/testing-preview-environments.mdx +3 -0
  231. package/docs/articles/testing-recipes.mdx +3 -0
  232. package/docs/articles/testing.mdx +3 -0
  233. package/docs/articles/troubleshooting-deployments-and-git-sync.mdx +3 -0
  234. package/docs/articles/troubleshooting-slow-responses.mdx +10 -0
  235. package/docs/articles/troubleshooting.md +14 -0
  236. package/docs/articles/tsconfig.mdx +3 -0
  237. package/docs/articles/tunnel-advanced.mdx +48 -104
  238. package/docs/articles/tunnel-services.mdx +14 -2
  239. package/docs/articles/tunnel-setup.mdx +12 -0
  240. package/docs/articles/tunnel-troubleshooting.mdx +12 -0
  241. package/docs/articles/update-zup-in-github-action.mdx +3 -0
  242. package/docs/articles/upstream-iam-auth.mdx +3 -0
  243. package/docs/articles/use-openapi-extension-data.mdx +3 -0
  244. package/docs/articles/users/multifactor-authentication.mdx +3 -0
  245. package/docs/articles/users/profile.mdx +3 -0
  246. package/docs/articles/version-support-policy.mdx +3 -0
  247. package/docs/articles/versioning-on-zuplo.mdx +3 -0
  248. package/docs/articles/waf-ddos-akamai.md +3 -0
  249. package/docs/articles/waf-ddos-aws-waf-shield.mdx +3 -0
  250. package/docs/articles/waf-ddos-fastly.mdx +3 -0
  251. package/docs/articles/waf-ddos.mdx +8 -0
  252. package/docs/articles/when-to-use-api-keys.md +3 -0
  253. package/docs/articles/workload-identity-inbound.mdx +3 -0
  254. package/docs/build-with-ai.mdx +3 -0
  255. package/docs/caching/cdn-caching.mdx +3 -0
  256. package/docs/caching/custom-caching-policy.mdx +3 -0
  257. package/docs/caching/dynamic-cache-rules.mdx +3 -0
  258. package/docs/caching/gateway-caching.mdx +3 -0
  259. package/docs/caching/overview.mdx +3 -0
  260. package/docs/caching/partial-response-caching.mdx +3 -0
  261. package/docs/cli/authentication.mdx +3 -0
  262. package/docs/cli/bucket-list.mdx +3 -0
  263. package/docs/cli/ca-certificate-create.mdx +3 -0
  264. package/docs/cli/ca-certificate-delete.mdx +3 -0
  265. package/docs/cli/ca-certificate-describe.mdx +3 -0
  266. package/docs/cli/ca-certificate-list.mdx +3 -0
  267. package/docs/cli/ca-certificate-update.mdx +3 -0
  268. package/docs/cli/connectivity.mdx +3 -0
  269. package/docs/cli/create-zuplo-api.mdx +3 -0
  270. package/docs/cli/custom-domain-create.mdx +6 -0
  271. package/docs/cli/custom-domain-delete.mdx +6 -0
  272. package/docs/cli/custom-domain-list.mdx +6 -0
  273. package/docs/cli/custom-domain-update.mdx +6 -0
  274. package/docs/cli/delete.mdx +5 -0
  275. package/docs/cli/deploy.mdx +5 -0
  276. package/docs/cli/dev.mdx +5 -0
  277. package/docs/cli/docs.mdx +3 -0
  278. package/docs/cli/editor.mdx +3 -0
  279. package/docs/cli/global-options.mdx +3 -0
  280. package/docs/cli/info.mdx +3 -0
  281. package/docs/cli/init.mdx +3 -0
  282. package/docs/cli/link.mdx +3 -0
  283. package/docs/cli/lint.mdx +3 -0
  284. package/docs/cli/list.mdx +5 -0
  285. package/docs/cli/logout.mdx +3 -0
  286. package/docs/cli/mtls-certificate-create.mdx +3 -0
  287. package/docs/cli/mtls-certificate-delete.mdx +3 -0
  288. package/docs/cli/mtls-certificate-describe.mdx +3 -0
  289. package/docs/cli/mtls-certificate-disable.mdx +3 -0
  290. package/docs/cli/mtls-certificate-list.mdx +3 -0
  291. package/docs/cli/mtls-certificate-update.mdx +3 -0
  292. package/docs/cli/openapi-convert.mdx +3 -0
  293. package/docs/cli/openapi-merge.mdx +3 -0
  294. package/docs/cli/openapi-overlay.mdx +3 -0
  295. package/docs/cli/overview.mdx +18 -15
  296. package/docs/cli/project-create.mdx +3 -0
  297. package/docs/cli/project-info.mdx +3 -0
  298. package/docs/cli/project-list.mdx +3 -0
  299. package/docs/cli/source-migrate.mdx +3 -0
  300. package/docs/cli/source-upgrade.mdx +3 -0
  301. package/docs/cli/test.mdx +3 -0
  302. package/docs/cli/tunnel-create.mdx +3 -0
  303. package/docs/cli/tunnel-delete.mdx +3 -0
  304. package/docs/cli/tunnel-describe.mdx +3 -0
  305. package/docs/cli/tunnel-list.mdx +3 -0
  306. package/docs/cli/tunnel-rotate-token.mdx +3 -0
  307. package/docs/cli/tunnel-services-describe.mdx +3 -0
  308. package/docs/cli/tunnel-services-update.mdx +3 -0
  309. package/docs/cli/variable-create.mdx +3 -0
  310. package/docs/cli/variable-update.mdx +3 -0
  311. package/docs/cli/whoami.mdx +3 -0
  312. package/docs/concepts/ai-gateway.mdx +3 -0
  313. package/docs/concepts/api-errors.md +3 -0
  314. package/docs/concepts/api-keys.md +12 -0
  315. package/docs/concepts/authentication.mdx +3 -0
  316. package/docs/concepts/how-zuplo-works.mdx +3 -0
  317. package/docs/concepts/mcp.mdx +3 -0
  318. package/docs/concepts/project-structure.mdx +3 -0
  319. package/docs/concepts/request-lifecycle.mdx +3 -0
  320. package/docs/concepts/source-control-and-deployment.mdx +14 -0
  321. package/docs/concepts/upstream-credentials.mdx +3 -0
  322. package/docs/concepts/where-zuplo-runs.mdx +124 -0
  323. package/docs/dedicated/akamai/ai-powered-applications.mdx +3 -0
  324. package/docs/dedicated/akamai/architecture.mdx +4 -1
  325. package/docs/dedicated/akamai/caching.mdx +3 -0
  326. package/docs/dedicated/akamai/cdn.mdx +3 -0
  327. package/docs/dedicated/architecture.mdx +3 -0
  328. package/docs/dedicated/aws/architecture.mdx +3 -0
  329. package/docs/dedicated/aws/private-networking.mdx +3 -0
  330. package/docs/dedicated/azure/architecture.mdx +3 -0
  331. package/docs/dedicated/azure/private-networking.mdx +3 -0
  332. package/docs/dedicated/configuration/host-header-override.mdx +3 -0
  333. package/docs/dedicated/configuration/overview.mdx +3 -0
  334. package/docs/dedicated/custom-domains.mdx +3 -0
  335. package/docs/dedicated/federated-gateways.mdx +4 -0
  336. package/docs/dedicated/gcp/architecture.mdx +3 -0
  337. package/docs/dedicated/gcp/private-networking.mdx +3 -0
  338. package/docs/dedicated/networking.mdx +3 -0
  339. package/docs/dedicated/overview.mdx +3 -0
  340. package/docs/dedicated/source-control.mdx +3 -0
  341. package/docs/dev-portal/auth-provider-api-identities.md +3 -0
  342. package/docs/dev-portal/branding.mdx +3 -0
  343. package/docs/dev-portal/dev-portal-create-consumer-on-auth.mdx +3 -0
  344. package/docs/dev-portal/documenting-mcp-servers.mdx +3 -0
  345. package/docs/dev-portal/migration.mdx +9 -0
  346. package/docs/dev-portal/node-modules.mdx +3 -0
  347. package/docs/dev-portal/overview.mdx +10 -0
  348. package/docs/dev-portal/server-side-rendering.mdx +4 -0
  349. package/docs/dev-portal/updating.mdx +3 -0
  350. package/docs/dev-portal/zudoku/components/alert.mdx +3 -0
  351. package/docs/dev-portal/zudoku/components/badge.mdx +3 -0
  352. package/docs/dev-portal/zudoku/components/browser-window.mdx +3 -0
  353. package/docs/dev-portal/zudoku/components/button.mdx +3 -0
  354. package/docs/dev-portal/zudoku/components/callout.mdx +3 -0
  355. package/docs/dev-portal/zudoku/components/card.mdx +3 -0
  356. package/docs/dev-portal/zudoku/components/checkbox.mdx +3 -0
  357. package/docs/dev-portal/zudoku/components/client-only.mdx +3 -0
  358. package/docs/dev-portal/zudoku/components/code-tabs.mdx +3 -0
  359. package/docs/dev-portal/zudoku/components/dialog.mdx +3 -0
  360. package/docs/dev-portal/zudoku/components/head.mdx +3 -0
  361. package/docs/dev-portal/zudoku/components/icons.mdx +3 -0
  362. package/docs/dev-portal/zudoku/components/input.mdx +3 -0
  363. package/docs/dev-portal/zudoku/components/label.mdx +3 -0
  364. package/docs/dev-portal/zudoku/components/landing-page.mdx +3 -0
  365. package/docs/dev-portal/zudoku/components/link.mdx +3 -0
  366. package/docs/dev-portal/zudoku/components/markdown.mdx +3 -0
  367. package/docs/dev-portal/zudoku/components/mermaid.mdx +3 -0
  368. package/docs/dev-portal/zudoku/components/playground.mdx +3 -0
  369. package/docs/dev-portal/zudoku/components/secret.mdx +3 -0
  370. package/docs/dev-portal/zudoku/components/select.mdx +3 -0
  371. package/docs/dev-portal/zudoku/components/shadcn.mdx +3 -0
  372. package/docs/dev-portal/zudoku/components/sidecar-box.mdx +3 -0
  373. package/docs/dev-portal/zudoku/components/slider.mdx +3 -0
  374. package/docs/dev-portal/zudoku/components/slot.mdx +3 -0
  375. package/docs/dev-portal/zudoku/components/stepper.mdx +3 -0
  376. package/docs/dev-portal/zudoku/components/switch.mdx +3 -0
  377. package/docs/dev-portal/zudoku/components/syntax-highlight.mdx +3 -0
  378. package/docs/dev-portal/zudoku/components/textarea.mdx +3 -0
  379. package/docs/dev-portal/zudoku/components/tooltip.mdx +3 -0
  380. package/docs/dev-portal/zudoku/components/typography.mdx +3 -0
  381. package/docs/dev-portal/zudoku/configuration/ai-assistants.md +3 -0
  382. package/docs/dev-portal/zudoku/configuration/api-catalog.md +3 -0
  383. package/docs/dev-portal/zudoku/configuration/api-reference.md +3 -0
  384. package/docs/dev-portal/zudoku/configuration/authentication-auth0.md +3 -0
  385. package/docs/dev-portal/zudoku/configuration/authentication-azure-ad.md +3 -0
  386. package/docs/dev-portal/zudoku/configuration/authentication-clerk.md +3 -0
  387. package/docs/dev-portal/zudoku/configuration/authentication-firebase.md +3 -0
  388. package/docs/dev-portal/zudoku/configuration/authentication-openid.md +3 -0
  389. package/docs/dev-portal/zudoku/configuration/authentication-pingfederate.md +3 -0
  390. package/docs/dev-portal/zudoku/configuration/authentication-supabase.md +3 -0
  391. package/docs/dev-portal/zudoku/configuration/authentication.md +3 -0
  392. package/docs/dev-portal/zudoku/configuration/build-configuration.mdx +3 -0
  393. package/docs/dev-portal/zudoku/configuration/docs.md +3 -0
  394. package/docs/dev-portal/zudoku/configuration/footer.mdx +3 -0
  395. package/docs/dev-portal/zudoku/configuration/llms.md +3 -0
  396. package/docs/dev-portal/zudoku/configuration/navigation.mdx +3 -0
  397. package/docs/dev-portal/zudoku/configuration/oauth-security-schemes.md +3 -0
  398. package/docs/dev-portal/zudoku/configuration/overview.md +3 -0
  399. package/docs/dev-portal/zudoku/configuration/protected-routes.md +3 -0
  400. package/docs/dev-portal/zudoku/configuration/search.md +3 -0
  401. package/docs/dev-portal/zudoku/configuration/sentry.mdx +3 -0
  402. package/docs/dev-portal/zudoku/configuration/site.md +3 -0
  403. package/docs/dev-portal/zudoku/configuration/slots.mdx +3 -0
  404. package/docs/dev-portal/zudoku/configuration/vite-config.md +3 -0
  405. package/docs/dev-portal/zudoku/custom-plugins.md +3 -0
  406. package/docs/dev-portal/zudoku/customization/colors-theme.mdx +3 -0
  407. package/docs/dev-portal/zudoku/customization/fonts.md +3 -0
  408. package/docs/dev-portal/zudoku/extending/events.md +3 -0
  409. package/docs/dev-portal/zudoku/extending/hooks.md +3 -0
  410. package/docs/dev-portal/zudoku/guides/custom-pages.md +3 -0
  411. package/docs/dev-portal/zudoku/guides/environment-variables.md +3 -0
  412. package/docs/dev-portal/zudoku/guides/mermaid.mdx +3 -0
  413. package/docs/dev-portal/zudoku/guides/navigation-migration.md +3 -0
  414. package/docs/dev-portal/zudoku/guides/navigation-rules.mdx +3 -0
  415. package/docs/dev-portal/zudoku/guides/processors.mdx +3 -0
  416. package/docs/dev-portal/zudoku/guides/redirects.md +3 -0
  417. package/docs/dev-portal/zudoku/guides/server-side-content-protection.md +3 -0
  418. package/docs/dev-portal/zudoku/guides/static-files.md +3 -0
  419. package/docs/dev-portal/zudoku/guides/transforming-examples.md +3 -0
  420. package/docs/dev-portal/zudoku/guides/using-multiple-apis.md +3 -0
  421. package/docs/dev-portal/zudoku/markdown/admonitions.md +3 -0
  422. package/docs/dev-portal/zudoku/markdown/code-blocks.md +3 -0
  423. package/docs/dev-portal/zudoku/markdown/frontmatter.md +3 -0
  424. package/docs/dev-portal/zudoku/markdown/mdx.md +3 -0
  425. package/docs/dev-portal/zudoku/markdown/overview.md +3 -0
  426. package/docs/dev-portal/zudoku/openapi-extensions/x-code-samples.md +3 -0
  427. package/docs/dev-portal/zudoku/openapi-extensions/x-display-name.md +3 -0
  428. package/docs/dev-portal/zudoku/openapi-extensions/x-internal.md +3 -0
  429. package/docs/dev-portal/zudoku/openapi-extensions/x-mcp-server.md +3 -0
  430. package/docs/dev-portal/zudoku/openapi-extensions/x-mcp.md +3 -0
  431. package/docs/dev-portal/zudoku/openapi-extensions/x-tag-groups.md +3 -0
  432. package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-collapsed.md +3 -0
  433. package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-collapsible.md +3 -0
  434. package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-playground-enabled.md +3 -0
  435. package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-request-box-enabled.md +3 -0
  436. package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-seo.md +3 -0
  437. package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-type.md +3 -0
  438. package/docs/dev-portal/zudoku/plugins.md +3 -0
  439. package/docs/dev-portal/zudoku/writing.mdx +3 -0
  440. package/docs/errors/bad-request.mdx +3 -0
  441. package/docs/errors/build-error.mdx +3 -0
  442. package/docs/errors/fatal-project-error.mdx +3 -0
  443. package/docs/errors/gateway-timeout.mdx +3 -0
  444. package/docs/errors/main-mod-error.mdx +3 -0
  445. package/docs/errors/no-project-set.mdx +3 -0
  446. package/docs/errors/not-found.mdx +3 -0
  447. package/docs/errors/rate-limit-exceeded.mdx +3 -0
  448. package/docs/errors/schema-validation-failed.mdx +3 -0
  449. package/docs/errors/system-configuration-error.mdx +3 -0
  450. package/docs/errors/unauthorized.mdx +3 -0
  451. package/docs/errors/unknown-error.mdx +3 -0
  452. package/docs/errors.mdx +6 -0
  453. package/docs/guides/canary-routing-for-employees.mdx +3 -0
  454. package/docs/guides/geolocation-backend-routing.mdx +12 -0
  455. package/docs/guides/modify-openapi-paths.mdx +3 -0
  456. package/docs/guides/openapi-overlays.mdx +3 -0
  457. package/docs/guides/overview.mdx +3 -0
  458. package/docs/guides/proxying-between-zuplo-gateways.mdx +10 -0
  459. package/docs/guides/transform-route-params-url-rewrite.mdx +3 -0
  460. package/docs/guides/user-based-backend-routing.mdx +3 -0
  461. package/docs/handlers/aws-lambda.mdx +3 -0
  462. package/docs/handlers/custom-handler.mdx +3 -0
  463. package/docs/handlers/legacy-dev-portal-handler.mdx +3 -0
  464. package/docs/handlers/mcp-server.mdx +5 -1
  465. package/docs/handlers/openapi.mdx +3 -0
  466. package/docs/handlers/redirect.mdx +3 -0
  467. package/docs/handlers/system-handlers.mdx +3 -0
  468. package/docs/handlers/url-forward.mdx +3 -0
  469. package/docs/handlers/url-rewrite.mdx +3 -0
  470. package/docs/handlers/websocket-handler.mdx +3 -0
  471. package/docs/handlers/websocket-pipeline-handler.mdx +3 -0
  472. package/docs/managed-edge/overview.md +3 -0
  473. package/docs/mcp-gateway/auth/configuring-auth0.mdx +3 -0
  474. package/docs/mcp-gateway/auth/configuring-clerk.mdx +3 -0
  475. package/docs/mcp-gateway/auth/configuring-cognito.mdx +3 -0
  476. package/docs/mcp-gateway/auth/configuring-entra.mdx +3 -0
  477. package/docs/mcp-gateway/auth/configuring-generic-oidc.mdx +3 -0
  478. package/docs/mcp-gateway/auth/configuring-google.mdx +3 -0
  479. package/docs/mcp-gateway/auth/configuring-keycloak.mdx +3 -0
  480. package/docs/mcp-gateway/auth/configuring-logto.mdx +3 -0
  481. package/docs/mcp-gateway/auth/configuring-okta.mdx +3 -0
  482. package/docs/mcp-gateway/auth/configuring-onelogin.mdx +3 -0
  483. package/docs/mcp-gateway/auth/configuring-ping.mdx +3 -0
  484. package/docs/mcp-gateway/auth/configuring-workos.mdx +3 -0
  485. package/docs/mcp-gateway/auth/manual-oauth-testing.mdx +3 -0
  486. package/docs/mcp-gateway/auth/overview.mdx +3 -0
  487. package/docs/mcp-gateway/auth/upstream-oauth.mdx +3 -0
  488. package/docs/mcp-gateway/capability-filtering.mdx +3 -0
  489. package/docs/mcp-gateway/code-config/compatibility-dates.mdx +3 -0
  490. package/docs/mcp-gateway/code-config/local-development.mdx +3 -0
  491. package/docs/mcp-gateway/code-config/mcp-proxy-handler.mdx +3 -0
  492. package/docs/mcp-gateway/code-config/multi-upstream.mdx +3 -0
  493. package/docs/mcp-gateway/code-config/overview.mdx +3 -0
  494. package/docs/mcp-gateway/connect-clients/chatgpt.mdx +3 -0
  495. package/docs/mcp-gateway/connect-clients/claude-code.mdx +3 -0
  496. package/docs/mcp-gateway/connect-clients/claude-desktop.mdx +3 -0
  497. package/docs/mcp-gateway/connect-clients/cursor.mdx +3 -0
  498. package/docs/mcp-gateway/connect-clients/other-clients.mdx +3 -0
  499. package/docs/mcp-gateway/connect-clients/overview.mdx +3 -0
  500. package/docs/mcp-gateway/connect-clients/vs-code.mdx +3 -0
  501. package/docs/mcp-gateway/cross-app-access/overview.mdx +3 -0
  502. package/docs/mcp-gateway/cross-app-access/policy-reference.mdx +3 -0
  503. package/docs/mcp-gateway/cross-app-access/quickstart.mdx +3 -0
  504. package/docs/mcp-gateway/how-it-works.mdx +3 -0
  505. package/docs/mcp-gateway/how-to/connect-upstream-api-key.mdx +3 -0
  506. package/docs/mcp-gateway/how-to/connect-upstream-oauth.mdx +3 -0
  507. package/docs/mcp-gateway/how-to/curate-tools-local.mdx +3 -0
  508. package/docs/mcp-gateway/how-to/curate-tools.mdx +3 -0
  509. package/docs/mcp-gateway/observability/analytics.mdx +3 -0
  510. package/docs/mcp-gateway/observability/logging.mdx +3 -0
  511. package/docs/mcp-gateway/overview.mdx +3 -0
  512. package/docs/mcp-gateway/policies/overview.mdx +3 -0
  513. package/docs/mcp-gateway/reference.mdx +3 -0
  514. package/docs/mcp-gateway/server-registry.mdx +3 -0
  515. package/docs/mcp-gateway/test-clients.mdx +3 -0
  516. package/docs/mcp-gateway/troubleshooting.mdx +3 -0
  517. package/docs/mcp-server/configuration-migration-guide.mdx +3 -0
  518. package/docs/mcp-server/custom-tools.mdx +3 -0
  519. package/docs/mcp-server/graphql.mdx +3 -0
  520. package/docs/mcp-server/openai-apps-sdk.mdx +3 -0
  521. package/docs/mcp-server/overview.mdx +3 -0
  522. package/docs/mcp-server/prompts.mdx +6 -1
  523. package/docs/mcp-server/resources.mdx +6 -1
  524. package/docs/mcp-server/testing.mdx +3 -0
  525. package/docs/mcp-server/tools.mdx +15 -1
  526. package/docs/mcp-server/troubleshooting.mdx +3 -0
  527. package/docs/policies/_index.md +1 -1
  528. package/docs/policies/ai-gateway-metering-inbound/doc.md +6 -7
  529. package/docs/policies/ai-gateway-metering-inbound/intro.md +2 -3
  530. package/docs/policies/ai-gateway-metering-inbound/schema.json +7 -6
  531. package/docs/programmable-api/background-dispatcher.mdx +3 -0
  532. package/docs/programmable-api/background-loader.mdx +3 -0
  533. package/docs/programmable-api/cache.mdx +3 -0
  534. package/docs/programmable-api/compatibility-dates.mdx +3 -0
  535. package/docs/programmable-api/console-logging.mdx +3 -0
  536. package/docs/programmable-api/context-data.mdx +3 -0
  537. package/docs/programmable-api/custom-cors-policy.mdx +3 -0
  538. package/docs/programmable-api/environment.mdx +10 -0
  539. package/docs/programmable-api/hooks.mdx +3 -0
  540. package/docs/programmable-api/http-problems.mdx +3 -0
  541. package/docs/programmable-api/jwt-service-plugin.mdx +3 -0
  542. package/docs/programmable-api/logger.mdx +3 -0
  543. package/docs/programmable-api/mcp-gateway-plugin.mdx +3 -0
  544. package/docs/programmable-api/mcp-sdk.mdx +3 -0
  545. package/docs/programmable-api/memory-zone-read-through-cache.mdx +3 -0
  546. package/docs/programmable-api/node-modules.mdx +3 -0
  547. package/docs/programmable-api/not-found-handler.mdx +3 -0
  548. package/docs/programmable-api/oauth-protected-resource-plugin.mdx +3 -0
  549. package/docs/programmable-api/overview.mdx +3 -0
  550. package/docs/programmable-api/problem-response-formatter.mdx +3 -0
  551. package/docs/programmable-api/request-user.mdx +3 -0
  552. package/docs/programmable-api/reusing-code.mdx +3 -0
  553. package/docs/programmable-api/route-raw.mdx +3 -0
  554. package/docs/programmable-api/runtime-behaviors.mdx +3 -0
  555. package/docs/programmable-api/runtime-errors.mdx +3 -0
  556. package/docs/programmable-api/runtime-extensions.mdx +10 -0
  557. package/docs/programmable-api/safely-clone-a-request-or-response.mdx +3 -0
  558. package/docs/programmable-api/streaming-zone-cache.mdx +3 -0
  559. package/docs/programmable-api/web-crypto-apis.mdx +3 -0
  560. package/docs/programmable-api/web-standard-apis.mdx +3 -0
  561. package/docs/programmable-api/zone-cache.mdx +3 -0
  562. package/docs/programmable-api/zp-body-removed.mdx +3 -0
  563. package/docs/programmable-api/zuplo-context.mdx +12 -0
  564. package/docs/programmable-api/zuplo-id-token.mdx +3 -0
  565. package/docs/programmable-api/zuplo-json.mdx +6 -0
  566. package/docs/programmable-api/zuplo-request.mdx +3 -0
  567. package/docs/rate-limiting/combining-policies.mdx +3 -0
  568. package/docs/rate-limiting/dynamic-rate-limiting.mdx +3 -0
  569. package/docs/rate-limiting/getting-started.mdx +3 -0
  570. package/docs/rate-limiting/how-it-works.md +3 -0
  571. package/docs/rate-limiting/monitoring-and-troubleshooting.mdx +3 -0
  572. package/docs/rate-limiting/per-user-rate-limits-using-db.mdx +3 -0
  573. package/docs/sample-apis.mdx +3 -0
  574. package/docs/self-hosted/install.md +3 -0
  575. package/docs/self-hosted/overview.md +3 -0
  576. package/docs/self-hosted/requirements.md +3 -0
  577. package/docs/self-hosted/troubleshooting.md +3 -0
  578. package/docs/self-hosted/upgrade.md +3 -0
  579. package/package.json +5 -5
@@ -2,6 +2,9 @@
2
2
  title: Secret
3
3
  sidebar_icon: lock
4
4
  description: Use the Secret component to display and manage API keys in your Dev Portal application.
5
+ applies_to:
6
+ product: developer-portal
7
+ hosting: all
5
8
  ---
6
9
 
7
10
  import { Secret } from "zudoku/ui/Secret";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Select
3
3
  sidebar_icon: chevron-down
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import {
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  sidebar_label: shadcn/ui
3
3
  sidebar_icon: puzzle
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  All shadcn/ui components are available for direct import from their respective UI modules:
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Sidecar Box
3
3
  sidebar_icon: panel-right
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import * as SidecarBox from "zudoku/ui/SidecarBox";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Slider
3
3
  sidebar_icon: sliders-horizontal
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import { Slider } from "zudoku/ui/Slider";
@@ -3,6 +3,9 @@ title: Slot
3
3
  sidebar_icon: between-horizontal-start
4
4
  description:
5
5
  Use the low-level Slot component for advanced slot management in custom pages and MDX content.
6
+ applies_to:
7
+ product: developer-portal
8
+ hosting: all
6
9
  ---
7
10
 
8
11
  The `Slot` component provides low-level access to Zudoku's slot system, allowing you to
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Stepper
3
3
  sidebar_icon: list-ordered
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  A vertical stepper component that displays a sequence of steps with automatic numbering and visual
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Switch
3
3
  sidebar_icon: toggle-left
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import { Switch } from "zudoku/ui/Switch";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Syntax Highlight
3
3
  sidebar_icon: code
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import { SyntaxHighlight } from "zudoku/ui/SyntaxHighlight";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Textarea
3
3
  sidebar_icon: type
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import { Textarea } from "zudoku/ui/Textarea";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Tooltip
3
3
  sidebar_icon: info
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import {
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Typography
3
3
  sidebar_icon: letter-text
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import { Typography } from "zudoku/components";
@@ -3,6 +3,9 @@ title: AI Assistants
3
3
  sidebar_icon: bot
4
4
  description:
5
5
  Configure which AI assistant integrations appear in dropdown menus across your Dev Portal documentation site, including built-in presets and custom providers.
6
+ applies_to:
7
+ product: developer-portal
8
+ hosting: all
6
9
  ---
7
10
 
8
11
  By default, Dev Portal shows "Use in Claude" and "Use in ChatGPT" options in dropdown menus on both
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: API Catalog
3
3
  sidebar_icon: book-open
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  If you're dealing with multiple APIs and multiple OpenAPI files, the API Catalog comes in handy. It
@@ -5,6 +5,9 @@ description:
5
5
  Learn how to configure the `apis` setting in Dev Portal to generate API reference documentation from
6
6
  OpenAPI files, including file and URL references, versioning, customization options, and OpenAPI
7
7
  extensions.
8
+ applies_to:
9
+ product: developer-portal
10
+ hosting: all
8
11
  ---
9
12
 
10
13
  The `apis` configuration setting in the [Dev Portal Configuration](./overview.md) file allows you to
@@ -4,6 +4,9 @@ sidebar_label: Auth0
4
4
  description:
5
5
  Learn how to set up Auth0 authentication for Zudoku, including application configuration and
6
6
  integration steps for secure API documentation access.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  Auth0 is a flexible authentication and authorization platform that integrates seamlessly with
@@ -4,6 +4,9 @@ sidebar_label: Azure AD
4
4
  description:
5
5
  Learn how to set up Azure Active Directory (Microsoft Entra ID) authentication for Zudoku,
6
6
  enabling secure single sign-on for your organization.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  Azure Active Directory (now Microsoft Entra ID) provides enterprise-grade authentication and
@@ -4,6 +4,9 @@ sidebar_label: Clerk
4
4
  description:
5
5
  Learn how to set up Clerk authentication for Zudoku, providing a seamless authentication
6
6
  experience with modern UI components and extensive customization options.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  Clerk is a modern authentication platform that provides beautiful, customizable UI components and a
@@ -4,6 +4,9 @@ sidebar_label: Firebase
4
4
  description:
5
5
  Learn how to set up Firebase Authentication for Zudoku, leveraging Google's secure authentication
6
6
  infrastructure with multiple sign-in providers.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  Firebase Authentication provides a comprehensive identity solution from Google, supporting
@@ -4,6 +4,9 @@ sidebar_label: OpenID Connect
4
4
  description:
5
5
  Configure any OpenID Connect compliant identity provider (Okta, Keycloak, Authentik, etc.) as the
6
6
  authentication provider for Zudoku.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  Dev Portal supports any identity provider that implements the
@@ -4,6 +4,9 @@ sidebar_label: PingFederate
4
4
  description:
5
5
  Learn how to set up PingFederate authentication for Dev Portal using OpenID Connect for
6
6
  enterprise-grade single sign-on.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  PingFederate is an enterprise federation server that enables secure single sign-on (SSO) and API
@@ -4,6 +4,9 @@ sidebar_label: Supabase
4
4
  description:
5
5
  Learn how to set up Supabase authentication for Dev Portal using email and password or OAuth providers
6
6
  for secure documentation access.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  Supabase is an open-source Firebase alternative that provides authentication, database, and storage
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Overview
3
3
  sidebar_icon: shield-check
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  If you use a managed authentication service, such as Auth0, Clerk, or OpenID, you can implement this
@@ -1,5 +1,8 @@
1
1
  ---
2
2
  sidebar_icon: pickaxe
3
+ applies_to:
4
+ product: developer-portal
5
+ hosting: all
3
6
  ---
4
7
 
5
8
  # Build Configuration
@@ -2,6 +2,9 @@
2
2
  title: Documentation
3
3
  navigation_label: Documentation
4
4
  navigation_icon: book
5
+ applies_to:
6
+ product: developer-portal
7
+ hosting: all
5
8
  ---
6
9
 
7
10
  Dev Portal uses a file-based routing system for documentation pages, similar to many modern frameworks.
@@ -4,6 +4,9 @@ sidebar_icon: panel-bottom-dashed
4
4
  description:
5
5
  Learn how to configure the footer in Zudoku, including columns, social links, copyright notice,
6
6
  and logo. Customize the footer's position and content with slots.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  # Footer Configuration
@@ -2,6 +2,9 @@
2
2
  title: LLM-Friendly Documentation Export
3
3
  navigation_label: llms.txt
4
4
  navigation_icon: bot
5
+ applies_to:
6
+ product: developer-portal
7
+ hosting: all
5
8
  ---
6
9
 
7
10
  Dev Portal can generate LLM-friendly versions of your documentation following the
@@ -5,6 +5,9 @@ description:
5
5
  Learn how to configure the navigation in Zudoku, including links, categories, documents, and
6
6
  custom pages. Understand the structure of the navigation array and how to use icons, labels, and
7
7
  paths.
8
+ applies_to:
9
+ product: developer-portal
10
+ hosting: all
8
11
  ---
9
12
 
10
13
  import { Book, Code, FileText } from "zudoku/icons";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: OAuth Security Schemes
3
3
  sidebar_icon: shield
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  If your OpenAPI specification defines OAuth2 or OpenID Connect security schemes, Dev Portal will display
@@ -4,6 +4,9 @@ sidebar_icon: file-json-2
4
4
  description:
5
5
  Learn how to configure your Dev Portal documentation site using the configuration file. Covers file
6
6
  formats, options, examples, and best practices.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  Dev Portal uses a single file for configuration. It controls the structure, metadata, style, plugins,
@@ -4,6 +4,9 @@ sidebar_icon: squares-subtract
4
4
  description:
5
5
  Learn how to protect specific routes in your documentation using authentication, including simple
6
6
  array patterns, advanced authorization with reason codes, and custom callback functions.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  You can protect specific routes in your documentation by adding the `protectedRoutes` property to
@@ -4,6 +4,9 @@ sidebar_icon: search-code
4
4
  description:
5
5
  Learn how to configure and customize search functionality in Zudoku, including setup instructions
6
6
  for Pagefind and Inkeep providers, result transformation, and ranking options.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  Dev Portal offers search functionality that enhances user experience by enabling content discovery
@@ -1,5 +1,8 @@
1
1
  ---
2
2
  sidebar_icon: bug
3
+ applies_to:
4
+ product: developer-portal
5
+ hosting: all
3
6
  ---
4
7
 
5
8
  # Sentry
@@ -4,6 +4,9 @@ sidebar_icon: layout-dashboard
4
4
  description:
5
5
  Customize your Dev Portal site's branding, logo, banner, and layout options with detailed
6
6
  configuration examples and guidance.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  # Branding & Layout
@@ -3,6 +3,9 @@ title: Slots
3
3
  sidebar_icon: between-horizontal-start
4
4
  description:
5
5
  Learn how to use slots to inject custom content into predefined locations throughout your Dev Portal site.
6
+ applies_to:
7
+ product: developer-portal
8
+ hosting: all
6
9
  ---
7
10
 
8
11
  Slots provide a powerful way to inject custom content into predefined locations throughout Zudoku.
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Vite Config
3
3
  sidebar_icon: server-crash
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  Dev Portal is built on top of [Vite](https://vite.dev/) and can be customized using a
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Custom Plugins
3
3
  sidebar_icon: list-end
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  Dev Portal is highly extensible. You can create custom plugins to add new functionality to your
@@ -4,6 +4,9 @@ title: Colors & Theme
4
4
  description:
5
5
  Customize your Dev Portal site's colors and theme with flexible options, including light/dark modes,
6
6
  custom CSS, and shadcn registry integration.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  Dev Portal provides flexible theming options allowing you to customize colors, import themes from
@@ -5,6 +5,9 @@ sidebar_label: Font & Typography
5
5
  description:
6
6
  Learn how to customize fonts and typography in Dev Portal using predefined Google Fonts, custom font
7
7
  URLs, or local fonts for sans, serif, and monospace text.
8
+ applies_to:
9
+ product: developer-portal
10
+ hosting: all
8
11
  ---
9
12
 
10
13
  Dev Portal allows you to customize fonts for text (`sans`), serif content (`serif`), and code (`mono`).
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Events
3
3
  sidebar_icon: shuffle
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  Dev Portal provides an events system that allows plugins to react to various application events. This
@@ -2,6 +2,9 @@
2
2
  title: Hooks
3
3
  sidebar_icon: webhook
4
4
  description: Reference for the React hooks exported by Zudoku.
5
+ applies_to:
6
+ product: developer-portal
7
+ hosting: all
5
8
  ---
6
9
 
7
10
  Dev Portal exposes a set of React hooks that let you read and interact with the runtime state of your
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Custom pages
3
3
  sidebar_icon: layers-3
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  If you want to include pages in your documentation that have greater flexibility than MDX pages, it
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Environment Variables
3
3
  sidebar_icon: table
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  Dev Portal is built on top of Vite and uses [their approach](https://vite.dev/guide/env-and-mode) for
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Mermaid Diagrams
3
3
  sidebar_icon: chart-network
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  Dev Portal supports rendering [Mermaid diagrams](https://mermaid.js.org/) in two ways:
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Navigation Migration
3
3
  navigation_icon: arrow-right-left
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  This guide explains how to migrate existing configurations that used `topNavigation`, `sidebar` and
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Navigation Rules
3
3
  sidebar_icon: list-tree
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import { LayersPlusIcon, PencilIcon, SortAscIcon, ArrowUpDownIcon, TrashIcon } from "zudoku/icons";
@@ -1,5 +1,8 @@
1
1
  ---
2
2
  sidebar_icon: cpu
3
+ applies_to:
4
+ product: developer-portal
5
+ hosting: all
3
6
  ---
4
7
 
5
8
  # Schema Processors
@@ -5,6 +5,9 @@ description:
5
5
  Configure URL redirects in your Dev Portal developer portal to set landing pages, maintain backward
6
6
  compatibility, and handle URL changes. Covers redirect behavior, basePath interaction, and
7
7
  troubleshooting.
8
+ applies_to:
9
+ product: developer-portal
10
+ hosting: all
8
11
  ---
9
12
 
10
13
  Redirects let you automatically send visitors from one URL to another in your developer portal. They
@@ -4,6 +4,9 @@ sidebar_icon: shield-check
4
4
  description:
5
5
  How Dev Portal isolates protected-route content at build time in SSR mode. Covers the auto-detection
6
6
  rules, caveats for dynamic routes and inline content, and a pre-ship checklist.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  When you run Dev Portal in SSR mode, [`protectedRoutes`](../configuration/protected-routes.md) is
@@ -4,6 +4,9 @@ sidebar_icon: folder-open
4
4
  description:
5
5
  Learn how to serve and reference static files like images and PDFs in your Dev Portal documentation
6
6
  using the public directory.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  Dev Portal makes it easy to serve static files like images, PDFs, or any other assets alongside your
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Transforming Operation Examples
3
3
  sidebar_icon: git-compare-arrows
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  Dev Portal allows you to transform operation examples in both request and response sections of your API
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Multiple APIs
3
3
  sidebar_icon: file-stack
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  Dev Portal supports creating documentation and API references for multiple APIs and can work with as
@@ -4,6 +4,9 @@ sidebar_icon: rectangle-horizontal
4
4
  description:
5
5
  Learn how to use admonitions (callouts) in Markdown, including syntax, types, titles, and
6
6
  formatting tips for compatibility with Prettier.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  In addition to the basic Markdown syntax, we have a special admonitions syntax by wrapping text with
@@ -4,6 +4,9 @@ sidebar_icon: braces
4
4
  description:
5
5
  Learn how to use code blocks, syntax highlighting, and advanced features like line highlighting
6
6
  and ANSI output in Dev Portal Markdown with Shiki.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  Dev Portal supports code blocks in Markdown using the [Shiki](https://shiki.style/) syntax highlighting
@@ -4,6 +4,9 @@ title: Frontmatter
4
4
  description:
5
5
  Learn how to use YAML frontmatter in Dev Portal markdown files to customize page titles, descriptions,
6
6
  navigation, and other document properties.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  Frontmatter is metadata written in [YAML](https://yaml.org/) format at the beginning of markdown
@@ -4,6 +4,9 @@ sidebar_icon: notebook-pen
4
4
  description:
5
5
  Learn how to use MDX in Dev Portal to create rich documentation pages with markdown and custom React
6
6
  components.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  Dev Portal supports MDX files for creating rich content pages. MDX is a markdown format that allows you
@@ -5,6 +5,9 @@ description:
5
5
  Comprehensive guide to using Markdown and MDX in Zudoku, including formatting, frontmatter, syntax
6
6
  highlighting, tables, lists, task lists, collapsible sections, and advanced documentation
7
7
  features.
8
+ applies_to:
9
+ product: developer-portal
10
+ hosting: all
8
11
  ---
9
12
 
10
13
  Dev Portal supports
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: x-code-samples
3
3
  sidebar_icon: code
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  Use `x-code-samples` (or `x-codeSamples`) to provide custom code snippets for an API operation. When
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: x-displayName
3
3
  sidebar_icon: tag
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  Use `x-displayName` to override the display label for a tag in the API navigation and documentation.