Skip to content

docs: clarify gateway authentication, comparison, and rate limiting - #2139

Open
Yilialinn wants to merge 1 commit into
apache:masterfrom
Yilialinn:codex/learning-center-geo-evidence
Open

Yilialinn wants to merge 1 commit into
apache:masterfrom
Yilialinn:codex/learning-center-geo-evidence

Conversation

@Yilialinn

Copy link
Copy Markdown
Contributor

Changes:

  • Qualify authentication coverage, audit expectations, Consumer mapping, and business authorization. Describe jwt-auth time-claim checks against APISIX 3.19.0 source and keep OIDC settings distinct.
  • Pin the comparison to APISIX 3.19.0, Kong Gateway OSS 3.9.4, Envoy 1.40.0, and Traefik Proxy 3.7.15. Add official evidence and distinguish routing configuration interfaces, extension runtimes, and open-source versus commercial product scope.
  • Correct the definition page's rate-limiting description: fixed versus sliding windows by version, and per-instance versus shared counters.

Scope:

  • Only three existing English Learning Center Markdown files change.
  • Titles, descriptions, slugs, publication dates, headings, existing FAQ metadata, canonical/hreflang behavior, discovery registrations, and code examples are unchanged.
  • No runtime, analytics, dependency, generated output, or product-page changes.

Validation:

  • git diff --check
  • Markdown checks (local Markdownlint is newer than CI; MD060 was disabled for the invocation only, without changing repository configuration)
  • NODE_PATH=/opt/homebrew/lib/node_modules/markdownlint-cli/node_modules node scripts/lint-frontmatter.js
  • WEBSITE_REPO=<checkout> node next/scripts/sync-content.mjs
  • node next/scripts/lint-content.mjs next/content/learning-center — 0 errors / 0 warnings
  • Learning Center registry parity — 22 pages / 22 entries
  • node --test next/scripts/generate-sitemaps.test.mjs next/scripts/assert-local-canonical-targets.test.mjs — 2 passed
  • All 32 newly added links returned HTTP 200; destinations were also checked for relevance.
  • Three auxiliary Markdown/CSS previews were checked at 1440px and 390px for table structure, TOC anchors, horizontal scrolling, and page overflow.

Not yet validated:

  • The full Astro build and actual production-template browser suite were not run locally because of the machine's disk-space safety threshold. Auxiliary previews and sitemap unit tests do not replace these checks. This PR remains a draft pending build/render validation and community review.

Technical evidence note:

The public jwt-auth documentation's summary of claims_to_verify differs from the explicit-required-claim behavior in the 3.19.0 parser. The article links the version-pinned implementation and distinguishes default checks of present time claims from explicitly configured time claims; it does not imply general iss/aud enforcement. See https://github.com/apache/apisix/blob/3.19.0/apisix/plugins/jwt-auth/parser.lua.

Screenshots of the change:

No production-render screenshots are attached. The auxiliary previews above are local editorial checks, not a claim that the Astro templates or deployed pages have been verified.

Signed-off-by: Yilia Lin <Yilialin@apache.org>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The draft still awaits full Astro build, production-template rendering validation, and community review.

0 open findings

What changed in this PR

Updates three English Learning Center articles to clarify gateway capabilities and deployment-dependent behavior without changing runtime code or page metadata.

Changes:

  • Clarifies authentication coverage, identity mapping, token validation, and authorization boundaries.
  • Pins gateway comparisons to specific releases and distinguishes open-source capabilities from commercial offerings.
  • Explains rate-limit window options and local versus shared counters.
File Description
website/​learning-center/​what-is-an-api-gateway.md Clarifies rate-limiting algorithms and counter storage.
website/​learning-center/​open-source-api-gateway-comparison.md Adds version-pinned comparisons and supporting references.
website/​learning-center/​api-gateway-authentication.md Qualifies authentication guarantees and configuration requirements.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@Yilialinn
Yilialinn marked this pull request as ready for review October 21, 2026 01:45

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants