docs: update the docs of admin API #8191

Hazel6869 · 2022-10-27T09:44:18Z

Description

Fixes #8114
the code pr #8180

Checklist

I have explained the need for this PR and the problem it solves
I have explained the changes or the new features added to this PR
I have added tests corresponding to this change
I have updated the documentation to reflect this change
I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

# Conflicts: # docs/zh/latest/admin-api.md

…o doc_upstream_schema # Conflicts: # docs/zh/latest/admin-api.md

guitu168

please update the local fork, Admin API Chinese doc was updated yesterday. please refer to: #8145

guitu168 · 2022-10-28T06:06:03Z

docs/zh/latest/admin-api.md

- `least_conn`: 选择 `(active_conn + 1) / weight` 最小的节点。此处的 `active connection` 概念跟 NGINX 的相同，它是当前正在被请求使用的连接。
+| 名字           | 可选项                             | 类型           | 说明                                                                                                                                                                                                                                                                                         | 示例                                             |
+| -------------- | ---------------------------------- | -------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ------------------------------------------------ |
+| type           | 可选                               | 枚举           | 负载均衡算法，默认值是`roundrobin`。                                                                                                                                                                                                                                                                   |                                      |     |


Suggested change

| type | 可选 | 枚举 | 负载均衡算法，默认值是`roundrobin`。 | | |

| type |否 | 枚举 | 负载均衡算法，默认值是`roundrobin`。 | | |

has done, thanks

guitu168 · 2022-10-28T07:16:26Z

docs/zh/latest/admin-api.md

-|keepalive_pool.requests  | 否 | 辅助 | 动态设置 `keepalive_requests` 指令，详细信息请参考下文。 |
+| 名称           | 必选项                                           | 类型           | 描述                                                                                                                                                                                                                                                                                                                                                        | 示例                                             |
+| -------------- |-----------------------------------------------| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
+| type           | 否                                             | 枚举           | 负载均衡算法，默认值是`roundrobin`                                                                                                                                                                                                                                                                                                                                                            |                                      |     |


Suggested change

| type | 否 | 枚举 | 负载均衡算法，默认值是`roundrobin` | | |

| type | 否 | 枚举 | 负载均衡算法，默认值是 `roundrobin`。 | | |

docs/zh/latest/admin-api.md

spacewander

Maybe we can remove the type in the example now?
Like https://github.com/apache/apisix/pull/8191/files#diff-de04caa451665cf4137cdde9804ab1f53de08dedd08fc3d51a2143bb18d46f71R731

Hazel6869 · 2022-11-02T08:31:22Z

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 😳

spacewander · 2022-11-03T06:28:16Z

Maybe we can remove the type in the example now? Like #8191 (files)

@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 type field in one example.

spacewander · 2022-11-03T06:44:07Z

We can only update the example of upstream API:

apisix/docs/en/latest/admin-api.md

Line 731 in 03e7606

"type":"roundrobin",

apisix/docs/en/latest/admin-api.md

Line 814 in 03e7606

"type": "roundrobin",

Hazel6869 · 2022-11-03T11:06:39Z

We can only update the example of upstream API:

apisix/docs/en/latest/admin-api.md

Line 731 in 03e7606

"type":"roundrobin",

apisix/docs/en/latest/admin-api.md

Line 814 in 03e7606

"type": "roundrobin",

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) ...

fix doc for upstream schema

f658c5b

Hazel6869 mentioned this pull request Oct 27, 2022

feat: add dafault value roundrobin for upstream_schema #8180

Merged

5 tasks

Hazel6869 marked this pull request as draft October 27, 2022 09:48

Hazel6869 added 6 commits October 27, 2022 18:16

fix text

a9552ea

fix doc for upstream schema

3ff186a

fix text

21f02b5

Merge branch 'apisix_master' into doc_upstream_schema

676cefb

# Conflicts: # docs/zh/latest/admin-api.md

Merge branch 'doc_upstream_schema' of github.com:Hazel6869/apisix int…

d4e0b2f

…o doc_upstream_schema # Conflicts: # docs/zh/latest/admin-api.md

fix line

47c38af

Hazel6869 marked this pull request as ready for review October 28, 2022 01:30

SylviaBABY previously approved these changes Oct 28, 2022

View reviewed changes

guitu168 suggested changes Oct 28, 2022

View reviewed changes

fix type

6d5e48b

Hazel6869 dismissed SylviaBABY’s stale review via 6d5e48b October 28, 2022 06:36

fix type

c38c01d

guitu168 reviewed Oct 28, 2022

View reviewed changes

fix 。

ce2867a

guitu168 previously approved these changes Oct 28, 2022

View reviewed changes

SylviaBABY previously approved these changes Oct 28, 2022

View reviewed changes

juzhiyuan reviewed Oct 31, 2022

View reviewed changes

docs/zh/latest/admin-api.md Show resolved Hide resolved

spacewander reviewed Nov 2, 2022

View reviewed changes

Hazel6869 added 2 commits November 3, 2022 19:22

Merge branch 'apisix_master' into doc_upstream_schema

5a6ed68

delete the type in the example

74a4b05

Hazel6869 dismissed stale reviews from SylviaBABY and guitu168 via 74a4b05 November 3, 2022 11:25

Hazel6869 requested a review from juzhiyuan November 3, 2022 11:27

Hazel6869 requested review from spacewander, juzhiyuan and SylviaBABY and removed request for juzhiyuan and spacewander November 3, 2022 11:27

juzhiyuan approved these changes Nov 3, 2022

View reviewed changes

SylviaBABY approved these changes Nov 3, 2022

View reviewed changes

guitu168 approved these changes Nov 3, 2022

View reviewed changes

spacewander approved these changes Nov 4, 2022

View reviewed changes

juzhiyuan merged commit 3c4d357 into apache:master Nov 4, 2022

Liu-Junlin pushed a commit to Liu-Junlin/apisix that referenced this pull request Nov 4, 2022

docs: update the docs of admin API (apache#8191)

82123cf

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update the docs of admin API #8191

docs: update the docs of admin API #8191

Hazel6869 commented Oct 27, 2022 •

edited

Loading

guitu168 left a comment •

edited

Loading

guitu168 Oct 28, 2022

Hazel6869 Oct 28, 2022

guitu168 Oct 28, 2022

spacewander left a comment

Hazel6869 commented Nov 2, 2022 •

edited

Loading

spacewander commented Nov 3, 2022

spacewander commented Nov 3, 2022

Hazel6869 commented Nov 3, 2022 •

edited

Loading

	\| type \| 可选 \| 枚举 \| 负载均衡算法，默认值是`roundrobin`。 \| \| \|
	\| type \|否 \| 枚举 \| 负载均衡算法，默认值是`roundrobin`。 \| \| \|

	\| type \| 否 \| 枚举 \| 负载均衡算法，默认值是`roundrobin` \| \| \|
	\| type \| 否 \| 枚举 \| 负载均衡算法，默认值是 `roundrobin`。 \| \| \|

docs: update the docs of admin API #8191

docs: update the docs of admin API #8191

Conversation

Hazel6869 commented Oct 27, 2022 • edited Loading

Description

Checklist

guitu168 left a comment • edited Loading

Choose a reason for hiding this comment

guitu168 Oct 28, 2022

Choose a reason for hiding this comment

Hazel6869 Oct 28, 2022

Choose a reason for hiding this comment

guitu168 Oct 28, 2022

Choose a reason for hiding this comment

spacewander left a comment

Choose a reason for hiding this comment

Hazel6869 commented Nov 2, 2022 • edited Loading

spacewander commented Nov 3, 2022

spacewander commented Nov 3, 2022

Hazel6869 commented Nov 3, 2022 • edited Loading

Hazel6869 commented Oct 27, 2022 •

edited

Loading

guitu168 left a comment •

edited

Loading

Hazel6869 commented Nov 2, 2022 •

edited

Loading

Hazel6869 commented Nov 3, 2022 •

edited

Loading