npm - zuplo - Versions diffs - 7.12.6 → 7.13.1 - Mend

zuplo 7.12.6 → 7.13.1

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 (580) hide show

package/docs/articles/local-development-env-variables.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: "Configuring Environment Variables Locally"
 sidebar_label: Environment variables
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 For security reasons, local development doesn't have access to the environment

package/docs/articles/local-development-installing-packages.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: "Installing Packages"
+applies_to:
+  product: gateway
+  hosting: all
 ---
 You can install packages from npm to use in your Zuplo Gateway. This can help

package/docs/articles/local-development-routes-designer.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: "Routes Designer"
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The Routes Designer is a visual tool that allows you to create and edit routes,

package/docs/articles/local-development-services.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: "Connecting to Zuplo Services Locally"
 sidebar_label: Zuplo Services
+applies_to:
+  product: gateway
+  hosting: all
 ---
 To use Zuplo services such as API keys and rate limiting locally, you must have

package/docs/articles/local-development-troubleshooting.mdx CHANGED Viewed

@@ -1,5 +1,12 @@
 ---
 title: "Troubleshooting"
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-edge: >-
+      Local mTLS client certificates aren't available in `zuplo dev`. mTLS to
+      your backend works only in deployed environments.
 ---
 ## Changing the port numbers

package/docs/articles/local-development.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Running your Zuplo Gateway locally
 sidebar_label: Quickstart
+applies_to:
+  product: gateway
+  hosting: all
 ---
 You can configure and run your Zuplo Gateway locally on your machine for

package/docs/articles/log-plugin-aws-cloudwatch.mdx CHANGED Viewed

@@ -1,6 +1,20 @@
 ---
 title: AWS CloudWatch Plugin
 sidebar_label: AWS CloudWatch Logging
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      `rayId` comes from the hosting network and maps to its request ID where
+      one exists, and `environmentType` values also depend on the hosting
+      environment. Don't rely on either having the same format across hosting
+      options.
+    self-hosted: >-
+      `rayId` comes from the hosting network and maps to its request ID where
+      one exists, and `environmentType` values also depend on the hosting
+      environment. Don't rely on either having the same format across hosting
+      options.
 ---
 The AWS CloudWatch Log plugin enables pushing logs to AWS CloudWatch.

package/docs/articles/log-plugin-datadog.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Datadog Plugin
 sidebar_label: Datadog Logging
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The Datadog Log plugin enables pushing logs to Datadog.

package/docs/articles/log-plugin-dynatrace.mdx CHANGED Viewed

@@ -1,6 +1,20 @@
 ---
 title: Dynatrace Plugin
 sidebar_label: Dynatrace Logging
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      `rayId` comes from the hosting network and maps to its request ID where
+      one exists, and `environmentType` values also depend on the hosting
+      environment. Don't rely on either having the same format across hosting
+      options.
+    self-hosted: >-
+      `rayId` comes from the hosting network and maps to its request ID where
+      one exists, and `environmentType` values also depend on the hosting
+      environment. Don't rely on either having the same format across hosting
+      options.
 ---
 The Dynatrace Log plugin enables pushing logs to Dynatrace.

package/docs/articles/log-plugin-gcp.mdx CHANGED Viewed

@@ -1,6 +1,20 @@
 ---
 title: Google Cloud Logging Plugin
 sidebar_label: Google Cloud Logging
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      `rayId` comes from the hosting network and maps to its request ID where
+      one exists, and `environmentType` values also depend on the hosting
+      environment. Don't rely on either having the same format across hosting
+      options.
+    self-hosted: >-
+      `rayId` comes from the hosting network and maps to its request ID where
+      one exists, and `environmentType` values also depend on the hosting
+      environment. Don't rely on either having the same format across hosting
+      options.
 ---
 The Google Cloud Log plugin enables pushing logs to your Google Cloud project.

package/docs/articles/log-plugin-loki.mdx CHANGED Viewed

@@ -1,6 +1,20 @@
 ---
 title: Loki Logging Plugin
 sidebar_label: Loki Logging
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      `rayId` comes from the hosting network and maps to its request ID where
+      one exists, and `environmentType` values also depend on the hosting
+      environment. Don't rely on either having the same format across hosting
+      options.
+    self-hosted: >-
+      `rayId` comes from the hosting network and maps to its request ID where
+      one exists, and `environmentType` values also depend on the hosting
+      environment. Don't rely on either having the same format across hosting
+      options.
 ---
 The Loki Log plugin enables pushing logs to your Loki server.

package/docs/articles/log-plugin-new-relic.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: New Relic Plugin
 sidebar_label: New Relic Logging
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The New Relic Log plugin enables pushing logs to New Relic.

package/docs/articles/log-plugin-splunk.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Splunk Plugin
 sidebar_label: Splunk Logging
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The Splunk Log plugin enables pushing logs to Splunk using the HTTP Event

package/docs/articles/log-plugin-sumo.mdx CHANGED Viewed

@@ -1,6 +1,20 @@
 ---
 title: SumoLogic Plugin
 sidebar_label: SumoLogic Logging
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      `rayId` comes from the hosting network and maps to its request ID where
+      one exists, and `environmentType` values also depend on the hosting
+      environment. Don't rely on either having the same format across hosting
+      options.
+    self-hosted: >-
+      `rayId` comes from the hosting network and maps to its request ID where
+      one exists, and `environmentType` values also depend on the hosting
+      environment. Don't rely on either having the same format across hosting
+      options.
 ---
 The SumoLogic Log plugin enables pushing logs to SumoLogic.

package/docs/articles/log-plugin-vmware-log-insight.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: VMware Log Insight Log Plugin
 sidebar_label: VMware Log Insight
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The VMware Log Insight plugin enables pushing logs to your VMware Log Insights

package/docs/articles/log-request-response-data.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Log Custom Request and Response Data
 sidebar_label: Log Request/Response Data
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Logging request and response data is useful for debugging API issues, monitoring

package/docs/articles/logging.mdx CHANGED Viewed

@@ -1,6 +1,20 @@
 ---
 title: Logging
 sidebar_label: Overview
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      `rayId` comes from the hosting network and maps to its request ID where
+      one exists, and `environmentType` values also depend on the hosting
+      environment. Don't rely on either having the same format across hosting
+      options.
+    self-hosted: >-
+      `rayId` comes from the hosting network and maps to its request ID where
+      one exists, and `environmentType` values also depend on the hosting
+      environment. Don't rely on either having the same format across hosting
+      options.
 ---
 Zuplo provides real-time logging out of the box. If you would like your logs to

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

@@ -7,6 +7,9 @@ description:
 tags:
   - authentication
   - testing
+applies_to:
+  product: gateway
+  hosting: all
 ---
 MCP client OAuth support is evolving rapidly and many clients don't yet support

package/docs/articles/metrics-plugins.mdx CHANGED Viewed

@@ -1,5 +1,15 @@
 ---
 title: Metrics Plugins
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Your gateway runs in the regions of your dedicated instance instead of
+      many edge locations, so fewer locations send metrics independently.
+    self-hosted: >-
+      Your gateway runs in your own Kubernetes cluster instead of edge
+      locations.
 ---
 An essential part of any application is the ability to continuously monitor its

package/docs/articles/migrate-from-apigee.md CHANGED Viewed

@@ -1,6 +1,16 @@
 ---
 title: Migrate from Google Apigee to Zuplo
 sidebar_label: Migrate from Apigee
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Your gateway runs in the regions of your dedicated instance instead of
+      300+ edge locations.
+    self-hosted: >-
+      Your gateway runs in your own Kubernetes cluster instead of 300+ edge
+      locations. You manage the infrastructure and apply updates.
 ---
 This guide walks through migrating from Google Apigee (including Apigee X,

package/docs/articles/migrate-from-aws-api-gateway.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Migrate from AWS API Gateway to Zuplo
 sidebar_label: Migrate from AWS API Gateway
+applies_to:
+  product: gateway
+  hosting: all
 ---
 This guide walks through migrating from AWS API Gateway (REST API, HTTP API, or

package/docs/articles/migrate-from-azure-apim.md CHANGED Viewed

@@ -1,6 +1,16 @@
 ---
 title: Migrate from Azure API Management to Zuplo
 sidebar_label: Migrate from Azure APIM
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Your gateway runs in the regions of your dedicated instance instead of
+      300+ edge locations.
+    self-hosted: >-
+      Your gateway runs in your own Kubernetes cluster instead of 300+ edge
+      locations. You manage the infrastructure and apply updates.
 ---
 This guide walks through migrating from Azure API Management (APIM) to Zuplo. It

package/docs/articles/migrate-from-kong.md CHANGED Viewed

@@ -1,6 +1,16 @@
 ---
 title: Migrate from Kong Gateway to Zuplo
 sidebar_label: Migrate from Kong
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Your gateway runs in the regions of your dedicated instance instead of
+      300+ edge locations.
+    self-hosted: >-
+      Your gateway runs in your own Kubernetes cluster instead of 300+ edge
+      locations. You manage the infrastructure and apply updates.
 ---
 This guide walks through migrating from Kong Gateway (Community Edition or

package/docs/articles/migration-overview.md CHANGED Viewed

@@ -1,6 +1,16 @@
 ---
 title: Migrate to Zuplo from Other API Gateways
 sidebar_label: Migration Overview
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Your gateway runs in the regions of your dedicated instance instead of
+      300+ edge locations.
+    self-hosted: >-
+      Your gateway runs in your own Kubernetes cluster instead of 300+ edge
+      locations. You manage the infrastructure and apply updates.
 ---
 Moving to Zuplo from another gateway is straightforward. Zuplo is

package/docs/articles/monetization/api-access.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: API Access
 sidebar_label: API Access
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 ## Buckets

package/docs/articles/monetization/billing-models.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Billing Models Guide
 sidebar_label: Billing Models
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 Zuplo supports four billing models, each targeting different business needs. You

package/docs/articles/monetization/developer-portal.md CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: Developer Portal Setup
 sidebar_label: Developer Portal
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Zuplo configures custom domains for your instance instead of **Account
+      Settings → Custom Domains**. See [Managed Dedicated: Custom
+      Domains](../../dedicated/custom-domains.mdx).
 ---
 The Developer Portal is the self-serve storefront for your monetized API.

package/docs/articles/monetization/dynamic-metering.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Dynamic Metering
 sidebar_label: Dynamic Metering
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Most routes meter a fixed amount per request through the policy's

package/docs/articles/monetization/features.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Features
 sidebar_label: Features
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 Features describe what your API offers to customers. They represent the

package/docs/articles/monetization/going-to-production.mdx CHANGED Viewed

@@ -4,6 +4,9 @@ sidebar_label: Going to Production
 description:
   Pre-production checklist, Stripe live-mode cutover, billing model readiness,
   and known limitations for launching Zuplo API monetization.
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 You have built out your monetization configuration in Stripe test mode and your

package/docs/articles/monetization/index.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: API Monetization with Zuplo
 sidebar_label: Overview
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 Zuplo's API Monetization lets you charge for your API directly from your gateway

package/docs/articles/monetization/meters.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Meters
 sidebar_label: Meters
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 Meters aggregate usage data from your API. They watch for specific event types,

package/docs/articles/monetization/monetization-policy.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Monetization Policy Reference
 sidebar_label: Monetization Policy
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The `MonetizationInboundPolicy` is the gateway enforcement mechanism. It runs on

package/docs/articles/monetization/plan-examples.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Plan Examples
 sidebar_label: Plan Examples
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 This guide walks through progressively building a plan, starting simple and

package/docs/articles/monetization/plans.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Plans
 sidebar_label: Plans
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 Plans are subscription tiers that package features together. They represent the

package/docs/articles/monetization/pricing-models.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Pricing Models
 sidebar_label: Pricing Models
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 Pricing models define how charges are calculated within a

package/docs/articles/monetization/private-plans.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Private Plans — Invite-Only Subscriptions
 sidebar_label: Private Plans
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 Private plans are hidden from the public pricing table and can only be accessed

package/docs/articles/monetization/programmatic-monetization.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Programmatic Monetization
 sidebar_label: Programmatic Monetization
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Pricing rules often depend on _who's_ calling or _what_ your API returns. A few

package/docs/articles/monetization/quickstart.md CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: Quickstart — Monetize Your API
 sidebar_label: Quickstart
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Working copy environments aren't available, so make the code changes in
+      [local development](../local-development.mdx) and deploy them through
+      source control instead of the **Code** tab.
 ---
 This guide walks you through setting up API monetization from scratch.

package/docs/articles/monetization/rate-cards.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Rate Cards
 sidebar_label: Rate Cards
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 Rate cards define the pricing and entitlements for features within a plan. Each

package/docs/articles/monetization/stripe-integration.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Stripe Integration
 sidebar_label: Stripe Integration
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 Zuplo uses Stripe to collect payments. Zuplo is the system of record for plans,
@@ -173,13 +176,23 @@ Stripe dashboard.
 When a customer clicks "Subscribe" in your Developer Portal:
-1. A Stripe Checkout Session is created so the customer can enter a payment
+1. The customer is redirected to Stripe Checkout, where they enter and save a
+   payment method
+2. The customer returns to the Developer Portal and confirms the subscription
+3. The subscription is created, and an API key is generated scoped to the plan's
+   entitlements
+4. Stripe issues an invoice for the subscription and charges the saved payment
    method
-2. The customer is redirected to Stripe Checkout to enter payment details
-3. On successful payment, the subscription is created
-4. An API key is generated scoped to the subscription's plan entitlements
-5. The customer is redirected back to the Developer Portal, where they can
-   immediately see their subscription, usage dashboard, and API key
+5. The customer can immediately see their subscription, usage dashboard, and API
+   key in the Developer Portal
+:::note
+Stripe Checkout only collects a payment method, so the Checkout page doesn't
+show the plan name, price, or line items. Customers see the charge on the
+subscription's invoice.
+:::
 ### Plan changes (upgrades/downgrades)

package/docs/articles/monetization/subscription-data.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Reading Subscription Data
 sidebar_label: Subscription Data
+applies_to:
+  product: gateway
+  hosting: all
 ---
 When the `MonetizationInboundPolicy` authenticates a request, it looks up the

package/docs/articles/monetization/subscription-lifecycle.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Subscription Lifecycle
 sidebar_label: Subscription Lifecycle
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 This guide covers the full lifecycle of a customer subscription: creation,

package/docs/articles/monetization/tax-collection.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Tax Collection — Enabling Stripe Tax
 sidebar_label: Tax Collection
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 Zuplo supports automatic tax collection through Stripe Tax. When enabled, taxes

package/docs/articles/monetization/troubleshooting.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Troubleshooting & FAQ
 sidebar_label: Troubleshooting
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 ## Common issues

package/docs/articles/monetization-custom.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Custom API Monetization
 sidebar_label: Custom Monetization
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 Zuplo's [Monetization](./monetization/index.mdx) supports advanced requirements

package/docs/articles/monetization-integrations.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Third-Party Monetization Integrations
 sidebar_label: Third-Party Integrations
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Zuplo's [built-in Monetization](./monetization/index.mdx) handles metering,