Copilot commented on code in PR #13168: URL: https://github.com/apache/apisix/pull/13168#discussion_r3056242417
########## docs/zh/latest/plugins/request-id.md: ########## @@ -26,9 +26,15 @@ description: request-id 插件为通过 APISIX 代理的每个请求添加一个 # --> +<head> + <link rel="canonical" href="https://docs.api7.ai/hub/request-id"; /> +</head> Review Comment: Embedding a raw `<head>` element inside a Markdown doc often won’t be processed as intended by static site generators (and can produce invalid HTML structure). Prefer the documentation framework’s supported mechanism for canonical URLs (e.g., a front-matter field or an MDX `Head` export/component), so the canonical link is reliably emitted. ########## docs/zh/latest/plugins/request-id.md: ########## @@ -47,14 +53,86 @@ description: request-id 插件为通过 APISIX 代理的每个请求添加一个 :::note -您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： +你可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： Review Comment: This change switches parts of the Chinese doc from the formal address (“您”) to the informal (“你”). Unless the entire ZH documentation set is intentionally moving to “你”, this creates an inconsistent tone within the page and across pages. Recommend standardizing on one form (typically “您” in technical docs) and applying it consistently throughout this document. ```suggestion 您可以这样从 `config.yaml` 中获取 `admin_key` 并存入环境变量： ``` ########## docs/zh/latest/plugins/request-id.md: ########## @@ -337,7 +415,7 @@ curl "http://127.0.0.1:9180/apisix/admin/routes"; -X PUT \ curl -i "http://127.0.0.1:9080/anything"; ``` -您应该会收到 `HTTP/1.1 200 OK` 响应，并看到响应包含以下标头： +你应该会收到 `HTTP/1.1 200 OK` 响应，并看到响应包含以下标头： Review Comment: This change switches parts of the Chinese doc from the formal address (“您”) to the informal (“你”). Unless the entire ZH documentation set is intentionally moving to “你”, this creates an inconsistent tone within the page and across pages. Recommend standardizing on one form (typically “您” in technical docs) and applying it consistently throughout this document. ```suggestion 您应该会收到 `HTTP/1.1 200 OK` 响应，并看到响应包含以下标头： ``` ########## docs/zh/latest/plugins/request-id.md: ########## @@ -89,7 +167,7 @@ curl "http://127.0.0.1:9180/apisix/admin/routes"; -X PUT \ curl -i "http://127.0.0.1:9080/anything"; ``` -您应该会收到一个 `HTTP/1.1 200 OK` 响应，并且会看到响应包含 `X-Request-Id` 标头和生成的 ID： +你应该会收到一个 `HTTP/1.1 200 OK` 响应，并且会看到响应包含 `X-Request-Id` 标头和生成的 ID： Review Comment: This change switches parts of the Chinese doc from the formal address (“您”) to the informal (“你”). Unless the entire ZH documentation set is intentionally moving to “你”, this creates an inconsistent tone within the page and across pages. Recommend standardizing on one form (typically “您” in technical docs) and applying it consistently throughout this document. ########## docs/en/latest/plugins/request-id.md: ########## @@ -32,7 +32,9 @@ description: The request-id Plugin adds a unique ID to each request proxied thro ## Description -The `request-id` Plugin adds a unique ID to each request proxied through APISIX, which can be used to track API requests. If a request carries an ID in the header and is not empty ("") corresponding to `header_name`, the Plugin will use the header value as the unique ID and will not overwrite with the automatically generated ID. +The `request-id` Plugin assigns a unique ID to each request proxied through the gateway, which can be used for request tracking and debugging. If a request already includes an ID in the header specified by `header_name`, the Plugin uses that value instead of generating a new one. Review Comment: The updated wording drops the previous nuance that an empty header value (\"\") should not be treated as a valid request ID. If the plugin still ignores empty values (as the old text implied), this becomes less precise and could mislead users. Consider reintroducing the empty-value behavior in the description (or explicitly stating how empty header values are handled). -- 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]
