npm - zuplo - Versions diffs - 7.12.5 → 7.12.7 - Mend

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

package/docs/dev-portal/zudoku/openapi-extensions/x-internal.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: x-internal
 sidebar_icon: eye-off
+applies_to:
+  product: developer-portal
+  hosting: all
 ---
 Use `x-internal` to hide internal endpoints and parameters from your API documentation. Anything

package/docs/dev-portal/zudoku/openapi-extensions/x-mcp-server.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: x-mcp-server
 sidebar_icon: bot
+applies_to:
+  product: developer-portal
+  hosting: all
 ---
 Use `x-mcp-server` to mark an individual OpenAPI operation as an

package/docs/dev-portal/zudoku/openapi-extensions/x-mcp.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: x-mcp
 sidebar_icon: bot
+applies_to:
+  product: developer-portal
+  hosting: all
 ---
 Use `x-mcp` to document [MCP](https://modelcontextprotocol.io/) (Model Context Protocol) server

package/docs/dev-portal/zudoku/openapi-extensions/x-tag-groups.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: x-tagGroups
 sidebar_icon: folder-tree
+applies_to:
+  product: developer-portal
+  hosting: all
 ---
 Use `x-tagGroups` to organize tags into named groups in the API navigation sidebar. Without this

package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-collapsed.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: x-zudoku-collapsed
 sidebar_icon: chevrons-down-up
+applies_to:
+  product: developer-portal
+  hosting: all
 ---
 Use `x-zudoku-collapsed` to control whether a tag category starts expanded or collapsed in the API

package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-collapsible.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: x-zudoku-collapsible
 sidebar_icon: panel-top-close
+applies_to:
+  product: developer-portal
+  hosting: all
 ---
 Use `x-zudoku-collapsible` to control whether a tag category can be collapsed or expanded by users

package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-playground-enabled.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: x-zudoku-playground-enabled
 sidebar_icon: toggle-right
+applies_to:
+  product: developer-portal
+  hosting: all
 ---
 Use `x-zudoku-playground-enabled` to show or hide the interactive API playground for a specific

package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-request-box-enabled.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: x-zudoku-request-box-enabled
 sidebar_icon: square-code
+applies_to:
+  product: developer-portal
+  hosting: all
 ---
 Use `x-zudoku-request-box-enabled` to show or hide the request box at the top of an operation's

package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-seo.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: x-zudoku-seo
 sidebar_icon: search
+applies_to:
+  product: developer-portal
+  hosting: all
 ---
 Use `x-zudoku-seo` to set the browser title and meta description of a tag's page without changing

package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-type.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: x-zudoku-type
 sidebar_icon: layout-grid
+applies_to:
+  product: developer-portal
+  hosting: all
 ---
 Use `x-zudoku-type` to change how Dev Portal renders an entire OpenAPI document, instead of the default

package/docs/dev-portal/zudoku/plugins.md CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: Dev Portal Plugins
+applies_to:
+  product: developer-portal
+  hosting: all
 ---
 Dev Portal can be extended using plugins.

package/docs/dev-portal/zudoku/writing.mdx CHANGED Viewed

@@ -2,6 +2,9 @@
 title: Writing
 sidebar_icon: book-open-text
 description: A guide to writing documentation in Dev Portal using Markdown and MDX.
+applies_to:
+  product: developer-portal
+  hosting: all
 ---
 Get started with creating rich documentation in Dev Portal using Markdown and MDX. This guide covers the

package/docs/errors/bad-request.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: Bad Request (BAD_REQUEST)
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The request was invalid. The response body typically contains specific error

package/docs/errors/build-error.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: Build Error (BUILD_ERROR)
+applies_to:
+  product: gateway
+  hosting: all
 ---
 There was an error building your project. The gateway returns this error when

package/docs/errors/fatal-project-error.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: Zuplo Fatal Project Error (FATAL_PROJECT_ERROR)
+applies_to:
+  product: gateway
+  hosting: all
 ---
 There was a fatal error loading your Zuplo project. This error indicates a

package/docs/errors/gateway-timeout.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: Gateway Timeout (GATEWAY_TIMEOUT)
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The upstream server did not respond within the allowed time.

package/docs/errors/main-mod-error.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: Zuplo Main Module Error (MAIN_MOD_ERROR)
+applies_to:
+  product: gateway
+  hosting: all
 ---
 There was an error loading your Zuplo project. This error occurs at runtime when

package/docs/errors/no-project-set.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: No Project Set Error (NO_PROJECT_SET)
+applies_to:
+  product: gateway
+  hosting: all
 ---
 This is a local development error that occurs when the Zuplo development server

package/docs/errors/not-found.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: Not Found Error (NOT_FOUND)
+applies_to:
+  product: gateway
+  hosting: all
 ---
 No route matched this request. The gateway could not find a configured route

package/docs/errors/rate-limit-exceeded.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: Rate Limit Exceeded (RATE_LIMIT_EXCEEDED)
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The request was rejected because the client exceeded the configured rate limit.

package/docs/errors/schema-validation-failed.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: Schema Validation Failed (SCHEMA_VALIDATION_FAILED)
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The incoming request body did not pass schema validation. The gateway validates

package/docs/errors/system-configuration-error.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: System Configuration Error (SYSTEM_CONFIGURATION_ERROR)
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The runtime environment is not correctly configured. One or more required

package/docs/errors/unauthorized.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: Unauthorized Error (UNAUTHORIZED)
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The request failed authentication. The gateway could not verify the identity of

package/docs/errors/unknown-error.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: Unknown Error (UNKNOWN_ERROR)
+applies_to:
+  product: gateway
+  hosting: all
 ---
 This is an unhandled error in the Zuplo runtime. The error does not match any

package/docs/errors.mdx CHANGED Viewed

@@ -1,3 +1,9 @@
+---
+applies_to:
+  product: gateway
+  hosting: all
+---
 # Zuplo Errors
 import { errors } from "../src/errors.ts";

package/docs/guides/canary-routing-for-employees.mdx CHANGED Viewed

@@ -8,6 +8,9 @@ tags:
   - backends
   - custom-code
   - testing
+applies_to:
+  product: gateway
+  hosting: all
 ---
 This guide explains how to create a Zuplo policy that routes employee requests

package/docs/guides/geolocation-backend-routing.mdx CHANGED Viewed

@@ -8,6 +8,18 @@ tags:
   - custom-code
   - backends
   - deployment
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Geolocation data, such as country, region, and `colo`, comes from your
+      instance's hosting environment. It's usually available, but which fields
+      are populated can vary.
+    self-hosted: >-
+      Geolocation data, such as country, region, and `colo`, comes from the
+      environment your cluster runs in. It's usually available, but which fields
+      are populated can vary.
 ---
 This guide explains how to create a Zuplo policy that routes requests to

package/docs/guides/modify-openapi-paths.mdx CHANGED Viewed

@@ -9,6 +9,9 @@ tags:
   - openapi
   - deployment
   - custom-code
+applies_to:
+  product: gateway
+  hosting: all
 ---
 There are many scenarios where you need to modify all paths in your OpenAPI

package/docs/guides/openapi-overlays.mdx CHANGED Viewed

@@ -8,6 +8,9 @@ tags:
   - openapi
   - custom-code
   - deployment
+applies_to:
+  product: gateway
+  hosting: all
 ---
 OpenAPI Overlays provide a powerful way to modify OpenAPI specifications without

package/docs/guides/overview.mdx CHANGED Viewed

@@ -3,6 +3,9 @@ title: Guides
 description:
   Discover step-by-step guides to help you build and deploy with Zuplo.
 sidebar_label: Overview
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Discover step-by-step guides to help you build and deploy with Zuplo. Browse the

package/docs/guides/proxying-between-zuplo-gateways.mdx CHANGED Viewed

@@ -9,6 +9,14 @@ tags:
   - deployment
   - custom-code
   - authentication
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Gateways in the same dedicated instance can call each other over
+      `local://` with [Federated Gateways](../dedicated/federated-gateways.mdx),
+      an enterprise add-on, instead of the public internet.
 ---
 Some architectures call for one Zuplo gateway to sit in front of one or more
@@ -119,6 +127,8 @@ export default async function (
 ### Pattern C: Federated Gateways (Managed Dedicated)
+<AppliesTo hosting="managed-dedicated" />
 On a [Managed Dedicated](../dedicated/federated-gateways.mdx) plan, use the
 `local://` protocol to call other environments in the same instance:

package/docs/guides/transform-route-params-url-rewrite.mdx CHANGED Viewed

@@ -7,6 +7,9 @@ description:
 tags:
   - custom-code
   - backends
+applies_to:
+  product: gateway
+  hosting: all
 ---
 This guide explains how to transform incoming route parameter values in an

package/docs/guides/user-based-backend-routing.mdx CHANGED Viewed

@@ -9,6 +9,9 @@ tags:
   - backends
   - custom-code
   - authentication
+applies_to:
+  product: gateway
+  hosting: all
 ---
 This guide explains how to create a Zuplo policy that routes requests to

package/docs/handlers/aws-lambda.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: AWS Lambda Handler
 sidebar_label: AWS Lambda
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The AWS Lambda handler is used to send requests to AWS Lambda. This handler can

package/docs/handlers/custom-handler.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Function Handler (Custom Handler)
 sidebar_label: Function Handler
+applies_to:
+  product: gateway
+  hosting: all
 ---
 As a unified gateway for APIs, AI, and MCP, the Request Handler is the most

package/docs/handlers/legacy-dev-portal-handler.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Legacy Dev Portal Handler
 sidebar_label: Legacy Dev Portal Handler
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 The Legacy Dev Portal Handler helps you maintain compatibility with the legacy

package/docs/handlers/mcp-server.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: MCP Server Handler
 sidebar_label: MCP Server
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The MCP (Model Context Protocol) Server handler allows you to run a lightweight,
@@ -324,7 +327,8 @@ define the type of MCP capability and provide specific metadata.
   `graphql`). Defaults to `tool` if not specified.
 - `name`: Override the name shown to AI systems (defaults to `operationId`)
 - `description`: Override the description for AI consumption (defaults to route
-  description/summary)
+  description/summary). The default uses at most the first 350 characters of the
+  route description, while an override has no length limit.
 - `enabled`: Whether this operation should be available in the MCP server.
 See the respective [tools](../mcp-server/tools.mdx),

package/docs/handlers/openapi.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: OpenAPI Spec Handler
 sidebar_label: OpenAPI Spec Handler
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The OpenAPI Spec handler serves a public version of your OpenAPI specification

package/docs/handlers/redirect.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Redirect Handler
 sidebar_label: Redirect
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The Redirect Handler sends a redirect HTTP response to the client. Use it to

package/docs/handlers/system-handlers.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Internal Route Handlers
 sidebar_label: Internal Route Handlers
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The Zuplo Runtime automatically registers certain routes on your gateway to

package/docs/handlers/url-forward.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: URL Forward Handler
 sidebar_label: URL Forward
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The URL Forward handler proxies requests to a different API without writing any

package/docs/handlers/url-rewrite.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: URL Rewrite Handler
 sidebar_label: URL Rewrite
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The URL Rewrite handler proxies and rewrites requests to different APIs without

package/docs/handlers/websocket-handler.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: WebSocket Handler
 sidebar_label: WebSocket Handler
+applies_to:
+  product: gateway
+  hosting: all
 ---
 :::note

package/docs/handlers/websocket-pipeline-handler.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: WebSocket Pipeline Handler
 sidebar_label: WebSocket Pipeline Handler
+applies_to:
+  product: gateway
+  hosting: all
 ---
 :::note

package/docs/managed-edge/overview.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Zuplo Managed Edge
 sidebar_label: Overview
+applies_to:
+  product: gateway
+  hosting: [managed-edge]
 ---
 Zuplo Managed Edge is a serverless deployment model where your Zuplo projects

package/docs/mcp-gateway/auth/configuring-auth0.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Configure Auth0 to back the MCP Gateway's downstream OAuth using the
   mcp-auth0-oauth-inbound policy. Covers tenant setup, application
   configuration, and wiring the policy in your gateway project.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The MCP Gateway can use Auth0 as the identity provider behind its downstream

package/docs/mcp-gateway/auth/configuring-clerk.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Configure Clerk to back the MCP Gateway's downstream OAuth using the
   mcp-clerk-oauth-inbound policy. Covers OAuth application setup and wiring the
   policy in your gateway project.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The MCP Gateway can use [Clerk](https://clerk.com/) as the identity provider

package/docs/mcp-gateway/auth/configuring-cognito.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Configure Amazon Cognito to back the MCP Gateway's downstream OAuth using the
   mcp-cognito-oauth-inbound policy. Covers user pool setup, hosted UI domain,
   and wiring the policy in your gateway project.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The MCP Gateway can use Amazon Cognito as the identity provider behind its

package/docs/mcp-gateway/auth/configuring-entra.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Configure Microsoft Entra ID to back the MCP Gateway's downstream OAuth using
   the mcp-entra-oauth-inbound policy. Covers app registration and wiring the
   policy in your gateway project.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The MCP Gateway can use Microsoft Entra ID (formerly Azure AD) as the identity

package/docs/mcp-gateway/auth/configuring-generic-oidc.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Configure any OIDC-compatible identity provider — Ory Hydra, Authentik,
   ZITADEL, FusionAuth, PingFederate, or a custom OIDC server — to back the MCP
   Gateway's downstream OAuth using the mcp-oauth-inbound policy.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The `mcp-oauth-inbound` policy is the catch-all for OIDC identity providers that

package/docs/mcp-gateway/auth/configuring-google.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Configure Google as the identity provider behind the MCP Gateway's downstream
   OAuth using the mcp-google-oauth-inbound policy. Covers OAuth client setup in
   Google Cloud and wiring the policy in your gateway project.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The MCP Gateway can use Google as the identity provider behind its downstream

package/docs/mcp-gateway/auth/configuring-keycloak.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Configure Keycloak to back the MCP Gateway's downstream OAuth using the
   mcp-keycloak-oauth-inbound policy. Covers realm client setup and wiring the
   policy in your gateway project.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The MCP Gateway can use Keycloak as the identity provider behind its downstream

package/docs/mcp-gateway/auth/configuring-logto.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Configure Logto to back the MCP Gateway's downstream OAuth using the
   mcp-logto-oauth-inbound policy. Covers application setup and wiring the policy
   in your gateway project.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The MCP Gateway can use [Logto](https://logto.io/) as the identity provider

package/docs/mcp-gateway/auth/configuring-okta.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Configure Okta to back the MCP Gateway's downstream OAuth using the
   mcp-okta-oauth-inbound policy. Covers Okta application setup and wiring the
   policy in your gateway project.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The MCP Gateway can use Okta as the identity provider behind its downstream

package/docs/mcp-gateway/auth/configuring-onelogin.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Configure OneLogin to back the MCP Gateway's downstream OAuth using the
   mcp-onelogin-oauth-inbound policy. Covers OIDC app setup and wiring the policy
   in your gateway project.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The MCP Gateway can use OneLogin as the identity provider behind its downstream

package/docs/mcp-gateway/auth/configuring-ping.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Configure PingOne to back the MCP Gateway's downstream OAuth using the
   mcp-ping-oauth-inbound policy. Covers application setup and wiring the policy
   in your gateway project.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The MCP Gateway can use PingOne as the identity provider behind its downstream

package/docs/mcp-gateway/auth/configuring-workos.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Configure WorkOS to back the MCP Gateway's downstream OAuth using the
   mcp-workos-oauth-inbound policy. Covers AuthKit setup and wiring the policy in
   your gateway project.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The MCP Gateway can use [WorkOS](https://workos.com/) as the identity provider

package/docs/mcp-gateway/auth/manual-oauth-testing.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Walk through every step of the MCP Gateway's downstream OAuth flow with curl,
   openssl, and jq. Useful for debugging discovery, registration, authorize,
   token exchange, refresh, and the first authenticated MCP request.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 When an MCP client's OAuth integration goes wrong, exercising the gateway's