docs: Update admin-api.md #10056
Merged
docs: Update admin-api.md #10056
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added note on ID syntax
SylviaBABY
reviewed
Aug 18, 2023
docs/en/latest/admin-api.md
Outdated
| @@ -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: | |||
There was a problem hiding this comment.
is this right？ maybe After executed successfully？ i dont think executiis is the correct word
There was a problem hiding this comment.
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
Revolyssup
previously approved these changes
Aug 21, 2023
shreemaan-abhishek
requested changes
Aug 21, 2023
docs/en/latest/admin-api.md
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
It also accepts periods ".". Please include this as well.
There was a problem hiding this comment.
I've included that too. Should I squash the commits?
Periods can be added as special characters too
shreemaan-abhishek
approved these changes
Aug 21, 2023
shreemaan-abhishek
requested review from
Revolyssup
and removed request for
bzp2010 and
monkeyDluffy6017
Revolyssup
approved these changes
Aug 21, 2023
hongbinhsu
pushed a commit
to fitphp/apix
that referenced
this pull request
Aug 22, 2023
* upstream/master: (77 commits) docs: Update admin-api.md (apache#10056) ci: fix a bug that can not open nginx.pid (apache#10061) feat: remove rust dependency by rollback lua-resty-ldap on master (apache#9936) docs: fix grpc-transcode.md error (apache#10059) feat: upgrade lua dependencies (apache#10051) fix: rollback lua-resty-session to 3.10 (apache#10046) feat: upgrade resty-redis-cluster from 1.02-4->1.05-1 (apache#10041) feat: update lua library (apache#10037) fix: worker not exited when executing quit or reload command (apache#9909) fix: traffic split plugin not validating upstream_id (apache#10008) ci: update the timeout value in cli.yml (apache#10026) fix(tencent-cloud-cls): DNS parsing failure (apache#9843) chore(deps): bump actions/setup-node from 3.7.0 to 3.8.0 (apache#10025) feat(openid-connect): add proxy_opts attribute (apache#9948) perf(log-rotate): replace string.sub with string.byte (apache#9984) fix(ci): replace github action in update-labels.yml (apache#9987) fix: can't sync etcd data if key has special character (apache#9967) perf(aws-lambda): cache the index of the array (apache#9944) fix: add support for dependency installation on endeavouros (apache#9985) chore(ci): automate management of unresponded issues (apache#9927) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added note on ID syntax in admin-api.md
Description
Added note on ID syntax and links to this part in the areas where a clearer understanding was stated as needed (Upstream and SSL sections). Made this change as there was no explanation for the rules around this part of the API.
Fixes #10047