Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Update admin-api.md #10056

Merged
merged 3 commits into from
Aug 21, 2023
Merged

docs: Update admin-api.md #10056

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
302b218
Update admin-api.md
ja3090 Aug 18, 2023
a712bf0
docs: Update admin-api.md
ja3090 Aug 18, 2023
aca48a0
Update admin-api.md
ja3090 Aug 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/en/latest/admin-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,10 @@ curl 'http://127.0.0.1:9180/apisix/admin/routes?name=test&uri=foo&label=' \

Route resource request address: /apisix/admin/routes/{id}?ttl=0

### Quick Note on ID Syntax

ID's as a text string must be of a length between 1 and 64 characters and they should only contain uppercase, lowercase, numbers and no special characters apart from dashes ( - ) and underscores ( _ ). For integer values they simply must have a minimum character count of 1.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It also accepts periods ".". Please include this as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've included that too. Should I squash the commits?


### Request Methods

| Method | Request URI | Request Body | Description |
Expand Down Expand Up @@ -871,6 +875,8 @@ An Upstream configuration can be directly bound to a Route or a Service, but the

Upstream resource request address: /apisix/admin/upstreams/{id}

For notes on ID syntax please refer to: [ID Syntax](#quick-note-on-id-syntax)

### Request Methods

| Method | Request URI | Request Body | Description |
Expand Down Expand Up @@ -1078,7 +1084,7 @@ Example Configuration:
...
```

After the execution is successful, nodes will not retain the original data, and the entire update is:
After the executiis successful, nodes will not retain the original data, and the entire update is:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this right？ maybe After executed successfully？ i dont think executiis is the correct word

Copy link
Contributor Author

@ja3090 ja3090 Aug 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry about that, I'm not sure how that was changed, it shouldn't have been. I have changed it back to how it was in the recent commit


```shell
{
Expand Down Expand Up @@ -1180,6 +1186,8 @@ Currently, the response is returned from etcd.

SSL resource request address: /apisix/admin/ssls/{id}

For notes on ID syntax please refer to: [ID Syntax](#quick-note-on-id-syntax)

### Request Methods

| Method | Request URI | Request Body | Description |
Expand Down
Loading