kayx23 opened a new pull request, #14109:
URL: https://github.com/apache/apisix/pull/14109

   ## Dependency
   
   This is the `release/3.18` backport of the relevant terminology corrections 
in apache/apisix#14105. The master PR should merge first so the maintained 
release does not become more accurate than the development branch.
   
   apache/apisix#14081 links its Admin API contract to these pages and should 
merge after this terminology backport.
   
   ## Why these corrections are needed
   
   - **Consumer:** the page treats a Consumer ID as its operational identity 
and shows an Upstream attached to the Consumer. The Admin API resource key and 
runtime identity use `username`; the schema supports plugins and an optional 
Consumer Group but no Consumer Upstream.
   - **Credential:** the page implies multiple credentials are only for 
different authentication types. A Consumer can also have multiple Credentials 
for the same authentication plugin when their identifying values differ, while 
each Credential contains at most one authentication plugin.
   - **Plugin Metadata:** the existing explanation implies universal override 
behavior. Only plugins with a metadata schema support metadata, and an instance 
setting overrides metadata only where the plugin implements that fallback.
   - **Stream Route:** the filtering overview omits the supported `sni` and 
`snis` fields.
   - **Secret:** the page claims secrets never exist in plaintext throughout 
the platform, but provider connection credentials can still be configured 
literally.
   - **Router expressions and examples:** the page depends on API7-owned 
repository links and an iRESTY hostname when the behavior can be explained 
locally.
   
   ## Changes
   
   - backport the six version-relevant Markdown corrections
   - remove the obsolete Consumer diagram
   - remove API7 repository links and the iRESTY example from the corrected 
scope
   - preserve version-specific behavior and avoid copying unrelated master 
content
   
   ## Validation
   
   - one commit containing only six Markdown files
   - markdownlint on all changed files
   - repository-wide internal link checker
   - `git diff --check origin/release/3.18...HEAD`
   - verified that the corrected scope contains no `api7`, `apiseven`, or 
`iresty` literals
   - source audit against the 3.18 schemas, Admin API handlers, tests, and 
runtime execution paths


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to