zuplo 7.2.3 → 7.2.4

package/docs/policies/data-loss-prevention-outbound/doc.md

@@ -33,7 +33,7 @@ identifiers, `secret-aws` enables both AWS entities. Two named groups (`pii`,
 | `id`        | `id-us-ssn`, `id-us-itin`, `id-us-passport`, `id-uk-nino`, `id-uk-nhs` (mod-11), `id-ca-sin` (Luhn), `id-au-abn`, `id-au-acn`, `id-au-tfn`, `id-au-medicare` (all checksummed), `id-in-aadhaar` (Verhoeff), `id-in-pan`, `id-sg-nric` (checksum), `id-es-nif` (checksum), `id-it-fiscal-code` (checksum), `id-pl-pesel` (checksum), `id-nl-bsn` (11-proef), `id-br-cpf` (checksum), `id-fr-nir` (mod-97)                                                                                                                                                                                                             |
 | `contact`   | `contact-email`, `contact-phone`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 | `network`   | `network-ipv4`, `network-ipv6`, `network-mac`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
-| `pii`       | `contact` + `id`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| `pii`       | `contact` + `id` + `finance-credit-card` + `finance-iban`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | Prefixes    | `id-us`, `id-uk`, `id-au`, `id-ca`, `id-in`, `id-sg`, `id-es`, `id-it`, `id-pl`, `id-nl`, `id-br`, `id-fr`, `finance-us`, `secret-aws` — everything whose id starts with that prefix                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 | `region-eu` | `id-es-nif`, `id-it-fiscal-code`, `id-pl-pesel`, `id-nl-bsn`, `id-fr-nir`, `finance-iban`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 
@@ -50,9 +50,12 @@ For example, with the `id-uk-nhs` entity enabled, `{"nhsNumber": "9434765919"}`
 is masked while the same digits in `{"orderId": "9434765919"}` pass through
 untouched.
 
-The threshold is configurable via `minConfidence` (default `0.5`): lower it to
-detect context-dependent entities everywhere, raise it to keep only prefix- and
-checksum-validated matches.
+The threshold is configurable via `minConfidence` (default `0.5`). Lowering it
+surfaces context-dependent entities without their context words. Raising it is
+not a precision filter: any recognizer whose base confidence falls below the
+threshold stops matching except near its context words, and most
+checksum-validated recognizers run at `0.85`, so high thresholds disable most
+of the catalog. To narrow detection, scope the `entities` list instead.
 
 ## Custom patterns
 
@@ -62,11 +65,24 @@ JavaScript regular expression `pattern`, and optionally a `confidence` and
 and skipped rather than failing the response. Remember to escape backslashes for
 JSON (for example `\\d` to match a digit).
 
+## Allowed values
+
+Use `allowValues` to exempt specific values that would otherwise match — for
+example the Stripe test card number `4242 4242 4242 4242` in a payments
+sandbox, or a public support email address. Entries are compared against the
+exact matched text (case-sensitive, separators included), so list every
+written form you want to allow.
+
 ## Content types
 
 Only text-based bodies (JSON, XML, form-encoded, and `text/*`) are scanned;
-binary bodies pass through untouched. Override the allow-list with the
-`contentTypes` option if you need to scan a different set of content types.
+binary bodies pass through untouched. Server-sent event streams
+(`text/event-stream`) are excluded from the default allow-list: scanning
+buffers the whole response, which would hold back every event until the
+stream ends — for an upstream SSE response, time-to-first-byte becomes the
+full stream duration. Override the allow-list with the `contentTypes` option
+if you need to scan a different set of content types (including
+`text/event-stream`, if you accept the buffering).
 
 ## Configuration
 
@@ -79,6 +95,7 @@ binary bodies pass through untouched. Override the allow-list with the
 - `action`: `mask`, `block`, or `log`. **Default:** `mask`
 - `mask`: Replacement string used when `action` is `mask`. **Default:**
   `[REDACTED]`
+- `allowValues`: Exact matched-text values that are never reported
 - `minConfidence`: Detection threshold (0-1). **Default:** `0.5`
 - `contentTypes`: Override the scannable content-type allow-list
 

package/docs/policies/data-loss-prevention-outbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "data-loss-prevention-outbound",
   "products": ["api-gateway"],
   "description": "Scans the upstream response body for sensitive data — PII, secrets, and financial identifiers — using an extensible catalog of built-in recognizers plus any custom patterns, and takes a configurable action when a match is found.\n\nThe action is one of `mask` (redact matches before returning the response), `block` (replace the response with a `422` listing the detected entity names only), or `log` (record a warning and return unchanged). Only text content types are inspected; binary bodies pass through untouched, and the body is read from a clone so the client still receives the original stream.",
   "deprecatedMessage": "",
@@ -187,6 +188,14 @@
                 }
               }
             },
+            "allowValues": {
+              "type": "array",
+              "x-advanced": true,
+              "description": "Values that are never reported as findings, compared against the exact matched text (case-sensitive, separators included). Use this to exempt well-known non-sensitive values that share a sensitive shape — for example the Stripe test card number `4242 4242 4242 4242` in a payments sandbox, or a public support email address. List every written form you want to allow (a spaced and an unspaced card number are different matches).",
+              "items": {
+                "type": "string"
+              }
+            },
             "minConfidence": {
               "type": "number",
               "minimum": 0,
@@ -194,7 +203,7 @@
               "default": 0.5,
               "x-show-example": false,
               "x-advanced": true,
-              "description": "Minimum confidence (0-1) a match must reach to count as a finding. Context-dependent recognizers (for example `finance-us-bank-account` or `finance-us-aba-routing`) sit below the default threshold of 0.5 until a context word near the match boosts them above it. Lower the threshold to surface them everywhere; raise it to keep only prefix- or checksum-validated matches."
+              "description": "Minimum confidence (0-1) a match must reach to count as a finding. Every match starts at its recognizer's base confidence and gains a fixed boost of 0.45 when one of the recognizer's context words appears near it. Ambiguous shapes (for example `finance-us-bank-account` or `finance-cvv`) have a low base confidence and only cross the default threshold of 0.5 with that boost; lower the threshold to surface them without context. Raising the threshold is not a precision filter: any recognizer whose base confidence falls below it stops matching entirely except near its context words, and most checksum-validated recognizers run at 0.85, so values above 0.85 disable most of the catalog. To narrow detection, scope the `entities` list instead."
             },
             "contentTypes": {
               "type": "array",

package/docs/policies/firebase-jwt-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "firebase-jwt-inbound",
   "products": ["api-gateway"],
   "description": "Authenticate users using Firebase issued JWT tokens.",
   "deprecatedMessage": "",

package/docs/policies/formdata-to-json-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "formdata-to-json-inbound",
   "products": ["api-gateway"],
   "description": "Converts form data in the incoming request to JSON.",
   "deprecatedMessage": "",

package/docs/policies/galileo-tracing-v2-inbound/doc.md

@@ -0,0 +1,72 @@
+# Galileo Tracing
+
+The Galileo Tracing policy integrates [Galileo](https://www.galileo.ai/) with
+the AI Gateway. It automatically records LLM inputs, outputs, model information,
+token usage, request metadata, and timing so you can debug applications and
+monitor quality in production.
+
+The policy supports Chat Completions, Responses, and Anthropic Messages. For a
+streaming response, it observes a clone of the original stream in the background
+when that stream is still readable; the client does not wait for trace delivery.
+If an earlier response hook has already consumed the original stream, output
+tracing is skipped and the client response continues unchanged.
+
+## Configure the policy
+
+Create a Galileo project and log stream, then generate an API key. The project
+ID and log stream ID appear in the Galileo log-stream URL. Declare the policy in
+`config/policies.json` and add it to each application chain that should emit
+traces:
+
+```json
+{
+  "name": "galileo-tracing-v2-inbound",
+  "policyType": "galileo-tracing-v2",
+  "handler": {
+    "export": "GalileoTracingV2InboundPolicy",
+    "module": "$import(@zuplo/runtime)",
+    "options": {
+      "apiKey": "$env(GALILEO_API_KEY)",
+      "projectId": "your-project-id",
+      "logStreamId": "your-log-stream-id"
+    }
+  }
+}
+```
+
+Place the policy near the end of the chain so the trace records request-body
+changes made by earlier policies. The recorded model label comes from the app
+configuration when available, then falls back to the request body. A model
+selected through request-scoped routing is not included in this trace label.
+
+## Options
+
+| Option           | Default                  | What it does                                           |
+| ---------------- | ------------------------ | ------------------------------------------------------ |
+| `apiKey`         | Required                 | Authenticates to Galileo.                              |
+| `projectId`      | Required                 | Selects the Galileo project.                           |
+| `logStreamId`    | Required                 | Selects the Galileo log stream.                        |
+| `baseUrl`        | `https://api.galileo.ai` | Overrides the Galileo API URL.                         |
+| `endpoints`      | All shapes               | Limits tracing to selected AI Gateway endpoint shapes. |
+| `onUnknownShape` | `skip`                   | Skips or denies a request whose shape cannot be read.  |
+
+As an observer, the policy fails open by default. A Galileo API failure is
+logged but does not fail the AI request. Setting `onUnknownShape` to `deny` only
+changes the behavior for an uninspectable request shape.
+
+## Trace structure
+
+Each request produces a hierarchy that Galileo can analyze:
+
+1. A top-level trace represents the complete AI Gateway request.
+2. A workflow span represents gateway processing.
+3. An LLM span records the provider interaction.
+
+Records include prompt and completion text, model parameters, finish reasons,
+input and output token counts, duration, Zuplo request ID, and route. This data
+supports trace inspection, model comparison, quality evaluation, cost analysis,
+and production monitoring.
+
+## Additional resources
+
+- [Galileo documentation](https://www.galileo.ai/docs)

package/docs/policies/galileo-tracing-v2-inbound/intro.md

@@ -0,0 +1,8 @@
+The Galileo Tracing policy sends AI Gateway requests, responses, token usage,
+and timing data to Galileo for observability and quality evaluation. It supports
+streaming and non-streaming traffic across all AI Gateway request shapes.
+
+Place it near the end of the application policy chain so traces reflect the
+request body after earlier policy changes. Trace delivery runs in the background
+and does not modify the client response. Streaming output tracing is skipped if
+an earlier response hook has already consumed the original stream.

package/docs/policies/{galileo-tracing-inbound → galileo-tracing-v2-inbound}/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://json-schema.org/draft-07/schema",
-  "$id": "https://cdn.zuplo.com/policies/runtime/schemas/galileo-tracing-inbound.json",
+  "$id": "https://cdn.zuplo.com/policies/runtime/schemas/galileo-tracing-v2-inbound.json",
   "type": "object",
   "title": "Galileo Tracing",
   "isDeprecated": false,
@@ -9,7 +9,8 @@
   "isInternal": false,
   "isBeta": false,
   "isHidden": false,
-  "requiresAI": false,
+  "requiresAI": true,
+  "policyType": "galileo-tracing-v2",
   "products": ["ai-gateway"],
   "description": "Galileo Tracing Inbound Policy",
   "deprecatedMessage": "",
@@ -21,7 +22,7 @@
       "required": ["export", "module", "options"],
       "properties": {
         "export": {
-          "const": "GalileoTracingInboundPolicy",
+          "const": "GalileoTracingV2InboundPolicy",
           "description": "The name of the exported type"
         },
         "module": {
@@ -29,9 +30,17 @@
           "description": "The module containing the policy"
         },
         "options": {
+          "x-zuplo-policy-type": "galileo-tracing-v2",
           "title": "Galileo Tracing",
           "description": "Track AI Gateway requests and responses using Galileo's LLM observability platform.",
           "type": "object",
+          "examples": [
+            {
+              "apiKey": "$env(GALILEO_API_KEY)",
+              "projectId": "your-project-id",
+              "logStreamId": "your-log-stream-id"
+            }
+          ],
           "properties": {
             "apiKey": {
               "description": "The Galileo API key for authentication.",
@@ -49,6 +58,28 @@
               "x-advanced": true,
               "description": "The base URL for the Galileo API (optional, defaults to https://api.galileo.ai).",
               "type": "string"
+            },
+            "endpoints": {
+              "type": "array",
+              "title": "Applicable Endpoints",
+              "x-advanced": true,
+              "description": "The endpoint shapes this policy applies to. Omit to apply to all (openai-chat, openai-responses, anthropic-messages).",
+              "items": {
+                "type": "string",
+                "enum": [
+                  "openai-chat",
+                  "openai-responses",
+                  "anthropic-messages"
+                ]
+              }
+            },
+            "onUnknownShape": {
+              "type": "string",
+              "title": "On Unknown Shape",
+              "x-advanced": true,
+              "description": "What to do on a shape the policy cannot read. As an observer this defaults to 'skip' (fail open — pass through untraced).",
+              "enum": ["deny", "skip"],
+              "default": "skip"
             }
           },
           "required": ["apiKey", "projectId", "logStreamId"],
@@ -57,9 +88,13 @@
       },
       "examples": [
         {
-          "export": "GalileoTracingInboundPolicy",
+          "export": "GalileoTracingV2InboundPolicy",
           "module": "$import(@zuplo/runtime)",
-          "options": {}
+          "options": {
+            "apiKey": "$env(GALILEO_API_KEY)",
+            "projectId": "your-project-id",
+            "logStreamId": "your-log-stream-id"
+          }
         }
       ]
     }

package/docs/policies/geo-filter-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "geo-filter-inbound",
   "products": ["api-gateway"],
   "description": "Block requests based on geo-location parameters: country, region code, and ASN",
   "deprecatedMessage": "",

package/docs/policies/graphql-analytics-outbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": true,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "graphql-analytics-outbound",
   "products": ["api-gateway"],
   "description": "Reports GraphQL errors returned in response bodies to Zuplo's GraphQL analytics. GraphQL servers following the standard Apollo / graphql-yoga pattern return `200 OK` with an `errors[]` array in the body when an operation fails, which HTTP-level analytics alone report as a success — add this policy to a GraphQL route and failed operations show up as failures on the GraphQL dashboard, classified by error type.\n\nEach error in `errors[]` is classified from its `extensions.code` following the Apollo Server conventions (`GRAPHQL_PARSE_FAILED` → `syntax`, `GRAPHQL_VALIDATION_FAILED` → `validation`, `UNAUTHENTICATED` / `FORBIDDEN` → `auth`, timeout codes → `timeout`); custom codes can be mapped with `errorCodeClassification`, and anything unrecognized falls back to `defaultErrorClass` (`resolver`). Optionally set `logErrors` to also write a structured warning per errored response. The policy reads up to `maxScanBytes` of the body (128 KiB by default, 5 MiB maximum), scanning it for the `errors` token; a response larger than that is treated as error-free. When the token is found and the body fits, it is parsed and its errors reported.\n\nThe response always passes through unchanged — the body is read from a clone, and any internal failure is swallowed so reporting can never break the request. The route must be marked `x-graphql: true` in `routes.oas.json` (which enables GraphQL analytics for the route); without the marker the policy logs a warning and does nothing.",
   "deprecatedMessage": "",

package/docs/policies/graphql-cache-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "graphql-cache-inbound",
   "products": ["api-gateway"],
   "description": "Caches GraphQL query responses at the edge so identical queries are served without a round-trip to the origin.\n\nUnlike CDN caching that keys on the raw request body, this policy parses the GraphQL document and normalizes it before hashing: insignificant whitespace, field formatting, and fragment layout are collapsed, and variable object keys are sorted. Two requests that are semantically identical therefore share a cache entry even when their bodies differ byte-for-byte. There is no query size or nesting-depth limit.\n\nOnly `query` operations are cached. Mutations, subscriptions, malformed documents, and non-JSON bodies are forwarded to the origin untouched. Cache hits and misses are reported on the `x-cache` response header, with a short key fingerprint on `x-cache-key`.\n\nTo avoid serving one user's data to another, requests carrying an `authorization` or `cookie` header are not cached by default. Use `cacheKeyHeaders` to opt into caching them: each listed header's value is included in the cache key, so distinct credentials get distinct cache entries.",
   "deprecatedMessage": "",

package/docs/policies/graphql-complexity-limit-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "graphql-complexity-limit-inbound",
   "products": ["api-gateway"],
   "description": "Policy that limits the complexity and depth of GraphQL queries to prevent abuse. Protects your GraphQL API from expensive queries that could cause performance issues or denial of service attacks.",
   "deprecatedMessage": "",

package/docs/policies/graphql-disable-introspection-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "graphql-disable-introspection-inbound",
   "products": ["api-gateway"],
   "description": "Policy that disables GraphQL introspection queries in production. Introspection allows clients to discover the schema, which can be a security risk as it exposes your entire API structure.",
   "deprecatedMessage": "",

package/docs/policies/graphql-introspection-filter-outbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "graphql-introspection-filter-outbound",
   "products": ["api-gateway"],
   "description": "Filters GraphQL introspection responses to exclude specific types and fields.\n\nThis policy intercepts GraphQL introspection query responses and removes configured types and fields from the schema. Useful for hiding internal types or sensitive fields from the public schema.",
   "deprecatedMessage": "",

package/docs/policies/http-deprecation-outbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "http-deprecation-outbound",
   "products": ["api-gateway"],
   "description": "Sets HTTP deprecation headers on the outgoing response following the IETF HTTP Deprecation Header standard. Supports the Deprecation, Sunset, and Link headers.",
   "deprecatedMessage": "",

package/docs/policies/ip-address-restriction-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "ip-address-restriction-inbound",
   "products": ["api-gateway"],
   "description": "Restricts which client IP addresses can call a route using an allow list, a deny list, or both. Entries are individual IP addresses or CIDR ranges, in IPv4 or IPv6.",
   "deprecatedMessage": "",

package/docs/policies/jwt-scopes-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "jwt-scopes-inbound",
   "products": ["api-gateway"],
   "description": "Validates that the JWT token includes specific scopes",
   "deprecatedMessage": "",

package/docs/policies/ldap-auth-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "ldap-auth-inbound",
   "products": ["api-gateway"],
   "description": "Authenticate requests using an LDAP server.",
   "deprecatedMessage": "",

package/docs/policies/mcp-auth0-oauth-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "mcp-auth0-oauth-inbound",
   "products": ["mcp-gateway"],
   "description": "Authenticate MCP gateway requests using a gateway-issued OAuth access token, with browser login delegated to Auth0.\n\nAuth0-friendly wrapper around `McpOAuthInboundPolicy`. Provide `auth0Domain` and `clientId`; the constructor derives the OIDC issuer, JWKS URL, and Auth0 authorize/token endpoints automatically and runs the resulting shape through the same Zod schema as the generic policy.\n\nValidation runs lazily inside the policy constructor, which the runtime caches per policy name — so a misconfigured policy fails the first request with a `ConfigurationError` (surfaced in the 500 problem body) rather than crashing boot.",
   "deprecatedMessage": "",

package/docs/policies/mcp-capability-filter-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "mcp-capability-filter-inbound",
   "products": ["mcp-gateway"],
   "description": "Curate MCP capabilities advertised and reachable through `McpProxyHandler`.\n\nValidation runs lazily inside the policy constructor, which the runtime caches per policy name. Misconfigured options therefore fail on first use with a customer-facing `ConfigurationError` instead of failing at module load.\n\nOptional per-caller access control (`accessControl`) narrows the curated catalog. See `claimsCapabilityResolver` for built-in role/group matching and `McpCapabilityResolver` for custom resolvers.",
   "deprecatedMessage": "",

package/docs/policies/mcp-clerk-oauth-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "mcp-clerk-oauth-inbound",
   "products": ["mcp-gateway"],
   "description": "Authenticate MCP gateway requests using a gateway-issued OAuth access token, with browser login delegated to Clerk.\n\nClerk-friendly wrapper around `McpOAuthInboundPolicy`. Provide Clerk's Frontend API URL plus the OAuth application client id and secret; the constructor derives the Clerk issuer, JWKS URL, authorize URL, and token URL.",
   "deprecatedMessage": "",

package/docs/policies/mcp-cognito-oauth-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "mcp-cognito-oauth-inbound",
   "products": ["mcp-gateway"],
   "description": "Authenticate MCP gateway requests using a gateway-issued OAuth access token, with browser login delegated to Amazon Cognito.\n\nCognito-friendly wrapper around `McpOAuthInboundPolicy`. Provide an AWS region, user pool id, user pool domain, client id, and client secret; the constructor derives the Cognito issuer, JWKS URL, authorize URL, and token URL.",
   "deprecatedMessage": "",

package/docs/policies/mcp-entra-oauth-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "mcp-entra-oauth-inbound",
   "products": ["mcp-gateway"],
   "description": "Authenticate MCP gateway requests using a gateway-issued OAuth access token, with browser login delegated to Microsoft Entra ID.\n\nEntra-friendly wrapper around `McpOAuthInboundPolicy`. Provide a tenant UUID, application client id, and client secret; the constructor derives the Entra v2 issuer, JWKS URL, authorize URL, and token URL.",
   "deprecatedMessage": "",

package/docs/policies/mcp-google-oauth-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "mcp-google-oauth-inbound",
   "products": ["mcp-gateway"],
   "description": "Authenticate MCP gateway requests using a gateway-issued OAuth access token, with browser login delegated to Google.\n\nGoogle-friendly wrapper around `McpOAuthInboundPolicy`. Provide `clientId` and `clientSecret`; the constructor uses Google's fixed OIDC issuer, JWKS URL, authorize URL, and token URL, then runs the resulting shape through the same Zod schema as the generic policy.",
   "deprecatedMessage": "",

package/docs/policies/mcp-keycloak-oauth-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "mcp-keycloak-oauth-inbound",
   "products": ["mcp-gateway"],
   "description": "Authenticate MCP gateway requests using a gateway-issued OAuth access token, with browser login delegated to Keycloak.\n\nKeycloak-friendly wrapper around `McpOAuthInboundPolicy`. Provide the Keycloak server root, realm, client id, and client secret; the constructor derives the realm issuer, JWKS URL, authorize URL, and token URL from Keycloak's documented OIDC endpoint layout.",
   "deprecatedMessage": "",

package/docs/policies/mcp-logto-oauth-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "mcp-logto-oauth-inbound",
   "products": ["mcp-gateway"],
   "description": "Authenticate MCP gateway requests using a gateway-issued OAuth access token, with browser login delegated to Logto.\n\nLogto-friendly wrapper around `McpOAuthInboundPolicy`. Provide the Logto tenant endpoint, client id, and client secret; the constructor derives the Logto `/oidc` issuer, JWKS URL, authorize URL, and token URL.",
   "deprecatedMessage": "",

package/docs/policies/mcp-oauth-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "mcp-oauth-inbound",
   "products": ["mcp-gateway"],
   "description": "Authenticate MCP gateway requests using a gateway-issued OAuth access token.\n\nThe gateway hosts its own OAuth authorization server endpoints (DCR, `/authorize`, `/token`, `/callback`) — registered automatically when this policy is present in `policies.json`. End-user browser login is delegated to the OpenID Connect identity provider configured via the `oidc` and `browserLogin` policy options.\n\nValidation runs lazily inside the policy constructor, which the runtime caches per policy name — so a misconfigured policy fails the first request with a `ConfigurationError` (surfaced in the 500 problem body) rather than crashing boot.",
   "deprecatedMessage": "",

package/docs/policies/mcp-okta-oauth-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "mcp-okta-oauth-inbound",
   "products": ["mcp-gateway"],
   "description": "Authenticate MCP gateway requests using a gateway-issued OAuth access token, with browser login delegated to Okta.\n\nOkta-friendly wrapper around `McpOAuthInboundPolicy`. Provide an Okta org domain, optional authorization server id, client id, and client secret; the constructor derives the Okta issuer, JWKS URL, authorize URL, and token URL.",
   "deprecatedMessage": "",

package/docs/policies/mcp-onelogin-oauth-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "mcp-onelogin-oauth-inbound",
   "products": ["mcp-gateway"],
   "description": "Authenticate MCP gateway requests using a gateway-issued OAuth access token, with browser login delegated to OneLogin.\n\nOneLogin-friendly wrapper around `McpOAuthInboundPolicy`. Provide the OneLogin account subdomain, client id, and client secret; the constructor derives OneLogin's OIDC issuer, JWKS URL, authorize URL, and token URL.",
   "deprecatedMessage": "",

package/docs/policies/mcp-ping-oauth-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "mcp-ping-oauth-inbound",
   "products": ["mcp-gateway"],
   "description": "Authenticate MCP gateway requests using a gateway-issued OAuth access token, with browser login delegated to PingOne.\n\nPingOne-friendly wrapper around `McpOAuthInboundPolicy`. Provide a PingOne environment ID plus optional region, or a PingOne custom domain, with client ID and client secret; the constructor derives the PingOne issuer, JWKS URL, authorize URL, and token URL.",
   "deprecatedMessage": "",

package/docs/policies/mcp-token-exchange-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "mcp-token-exchange-inbound",
   "products": ["mcp-gateway"],
   "description": "Resolve a gateway-managed upstream MCP credential and apply it to the request before the normal Zuplo route handler forwards the request.\n\nValidation runs lazily inside the policy constructor, which the runtime caches per policy name — so a misconfigured policy fails the first request with a `ConfigurationError` (surfaced in the 500 problem body) rather than crashing boot.",
   "deprecatedMessage": "",

package/docs/policies/mcp-workos-oauth-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "mcp-workos-oauth-inbound",
   "products": ["mcp-gateway"],
   "description": "Authenticate MCP gateway requests using a gateway-issued OAuth access token, with browser login delegated to WorkOS.\n\nWorkOS-friendly wrapper around `McpOAuthInboundPolicy`. Provide `clientId` and `clientSecret`; the constructor derives the WorkOS OIDC issuer, JWKS URL, authorize URL, and token URL automatically and runs the resulting shape through the same Zod schema as the generic policy.",
   "deprecatedMessage": "",

package/docs/policies/mock-api-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "mock-api-inbound",
   "products": ["api-gateway"],
   "description": "Returns example responses from the OpenAPI document associated with this route.",
   "deprecatedMessage": "",

package/docs/policies/moesif-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "moesif-inbound",
   "products": ["api-gateway"],
   "description": "Moesif is an API analytics and billing service. This policy allows you to send metering calls for each API to their events batch endpoint.",
   "deprecatedMessage": "",

package/docs/policies/monetization-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "monetization-inbound",
   "products": ["api-gateway"],
   "description": "Monetization inbound policy for API key validation and usage metering.",
   "deprecatedMessage": "",

package/docs/policies/mtls-auth-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "mtls-auth-inbound",
   "products": ["api-gateway"],
   "description": "Authenticate requests based on the mTLS protocol.",
   "deprecatedMessage": "",

package/docs/policies/okta-fga-authz-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "okta-fga-authz-inbound",
   "products": ["api-gateway"],
   "description": "Authorize requests using Okta FGA.",
   "deprecatedMessage": "",

package/docs/policies/okta-jwt-auth-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "okta-jwt-auth-inbound",
   "products": ["api-gateway"],
   "description": "Authenticate users using Okta issued JWT tokens.",
   "deprecatedMessage": "",

package/docs/policies/open-id-jwt-auth-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "open-id-jwt-auth-inbound",
   "products": ["api-gateway"],
   "description": "The Open ID JWT Authentication policy allows you to authenticate incoming requests using an Open ID compliant bearer token.",
   "deprecatedMessage": "",

package/docs/policies/openfga-authz-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "openfga-authz-inbound",
   "products": ["api-gateway"],
   "description": "Authorize requests using OpenFGA.",
   "deprecatedMessage": "",

package/docs/policies/openmeter-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "openmeter-inbound",
   "products": ["api-gateway"],
   "description": "OpenMeter is a usage metering service. This policy allows you to send metering calls for each API to their event ingest endpoint. It also supports entitlement checking to verify if a subject has access to a feature.",
   "deprecatedMessage": "",

package/docs/policies/prompt-injection-outbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": true,
+  "policyType": "prompt-injection",
   "products": ["ai-gateway", "mcp-gateway"],
   "description": "Uses an LLM agent to detect prompt injection attempts in user provided content or potentially poisoned response bodies. This is primarily intended to be used with downstream LLM agents who are at risk of having prompt injection attacks executed against them.",
   "deprecatedMessage": "",

package/docs/policies/propel-auth-jwt-inbound/schema.json

@@ -10,6 +10,7 @@
   "isBeta": false,
   "isHidden": false,
   "requiresAI": false,
+  "policyType": "propel-auth-jwt-inbound",
   "products": ["api-gateway"],
   "description": "Authenticate users using PropelAuth issued JWT tokens.",
   "deprecatedMessage": "",