docs: update the docs of admin API #8191
Conversation
# Conflicts: # docs/zh/latest/admin-api.md
…o doc_upstream_schema # Conflicts: # docs/zh/latest/admin-api.md
| - `least_conn`: 选择 `(active_conn + 1) / weight` 最小的节点。此处的 `active connection` 概念跟 NGINX 的相同,它是当前正在被请求使用的连接。 | ||
| | 名字 | 可选项 | 类型 | 说明 | 示例 | | ||
| | -------------- | ---------------------------------- | -------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ------------------------------------------------ | | ||
| | type | 可选 | 枚举 | 负载均衡算法,默认值是`roundrobin`。 | | | |
There was a problem hiding this comment.
| | type | 可选 | 枚举 | 负载均衡算法,默认值是`roundrobin`。 | | | | |
| | type |否 | 枚举 | 负载均衡算法,默认值是`roundrobin`。 | | | |
| |keepalive_pool.requests | 否 | 辅助 | 动态设置 `keepalive_requests` 指令,详细信息请参考下文。 | | ||
| | 名称 | 必选项 | 类型 | 描述 | 示例 | | ||
| | -------------- |-----------------------------------------------| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | | ||
| | type | 否 | 枚举 | 负载均衡算法,默认值是`roundrobin` | | | |
There was a problem hiding this comment.
| | type | 否 | 枚举 | 负载均衡算法,默认值是`roundrobin` | | | | |
| | type | 否 | 枚举 | 负载均衡算法,默认值是 `roundrobin`。 | | | |
spacewander
left a comment
There was a problem hiding this comment.
Maybe we can remove the type in the example now?
Like https://github.com/apache/apisix/pull/8191/files#diff-de04caa451665cf4137cdde9804ab1f53de08dedd08fc3d51a2143bb18d46f71R731
@spacewander ok i will do this in another pr? because there are lots of work 😳 |
Do we discuss the same thing? I think we can just remove the |
|
We can only update the example of upstream API: apisix/docs/en/latest/admin-api.md Line 731 in 03e7606 apisix/docs/en/latest/admin-api.md Line 814 in 03e7606 |
ok i see 😂 , i have done @spacewander |
* upstream/master: (94 commits) test: add test cases for ai module (apache#8222) fix(ai): typo key name (apache#8232) docs: update the docs of admin API (apache#8191) Update standalone docs for change in SSL parameter (apache#8242) fix: can not modify x-forwarded-host in proxy rewrite (apache#8200) chore: export the set cert/key process so we can hook it (apache#8228) test: add cases of ai module (apache#8214) feat: add dafault value roundrobin for upstream_schema (apache#8180) docs: update limit plugin docs (apache#8154) dix remote_addr (apache#8210) fix(zipkin): send trace IDs with a reject sampling decision (apache#8099) docs: update hmac-auth doc (apache#8192) docs: update limit count plugin doc (apache#8196) docs: fix building apisix misled (apache#8189) fix: meta.filter in plugin doesn't work in response-rewrite plugin (apache#8162) feat: release 3.0 (apache#8179) docs: refactor admin api doc (apache#8145) docs: refactor health check doc (apache#8129) docs: protect-api.md typo, remove redundant braces. (apache#8139) feat: renew route lrucache when the routes change (apache#8157) ...
Description
Fixes #8114
the code pr #8180
Checklist