Repository navigation
Document global Backends for the next API Gateway release - #840
Open
CrowleyRajapakse wants to merge 2 commits into
Open
CrowleyRajapakse wants to merge 2 commits into
CrowleyRajapakse wants to merge 2 commits into
Conversation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
API Platform Gateway gains a gateway-wide
Backendresource: a backend defined once for the whole gateway that any API can route to by name, or by a value taken from the request, through thedynamic-endpointpolicy (v1.1), without editing or redeploying the API. The next release's documentation has no page for it, and the management API reference, release notes and policies overview don't mention it.Checklist
llms.txt(located aten/docs/llms.txt) is updated for AI readiness content. Not updated:llms.txtlists the released API Gateway versions only and has nonextentries; the pages should be added when this release is published.Goals
/backends, consistent with the other reference pages.Approach
All changes are in the
nextversion of the API Gateway docs.api-gateway/next/backends/global-backends.md(new, nav: API Gateway → next → Backends → Global Backends):apiVersion: gateway.choreolabs.com/v1) and a field reference;ap gateway applyorPOST /backends, and the roles that may change it;backendExpressionandbackendSelector(withremove-headerskeeping the routing header from the backend),onMissingValue, a fixedtargetUpstream, and adding a Backend without changing the API;identity,trustedCAs,verifyHostName) and its warnings, update and delete (including the409while an API names it), immutable gateways, errors (400,503/905008,500/905005,409) and limitations.https://wso2.com/api-platform/policy-hub/policies/dynamic-endpoint, which serves v1.1 once that version is published (same link).BackendRequest,BackendandBackendConfigurationschemas and theTLS_NO_TRUST_SOURCEwarning code inschemas.mdand the GraphQL API page's warning codes; a Backend Management section in the management API overview.mkdocs.ymlentries for the two pages.The pages follow the style rules in
.claude/rules/doc-*.md. A glossary entry for "Backend" is left for the release itself, because the glossary isn't versioned and would otherwise describe an unreleased feature.User stories
Release note
Global Backends: define a backend once for the whole gateway with the
Backendresource and route API requests to it with the Dynamic Endpoint policy, by name or by a CEL expression over the request context.Documentation
This PR is the documentation.
Training
N/A
Certification
N/A — documentation for a feature not yet released.
Marketing
N/A
Automation tests
Security checks
Samples
The guide includes a Backend definition, a REST API that routes by an
x-tenantheader, a fixed-target configuration and a mutual-TLS Backend.Related PRs
Migrations (if applicable)
N/A
Test environment
MkDocs 1.4.2 with the repository's
requirements.txton Python 3.12, macOS.Learning
N/A
🤖 Generated with Claude Code