Skip to content

docs: Update admin-api.md#10056

Merged
shreemaan-abhishek merged 3 commits into
apache:masterfrom
ja3090:jaw163-patch-1
Aug 21, 2023
Merged

docs: Update admin-api.md#10056
shreemaan-abhishek merged 3 commits into
apache:masterfrom
ja3090:jaw163-patch-1

Conversation

@ja3090

@ja3090 ja3090 commented Aug 18, 2023

Copy link
Copy Markdown
Contributor

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

Added note on ID syntax
@ja3090 ja3090 changed the title Update admin-api.md docs: Update admin-api.md Aug 18, 2023
Comment thread docs/en/latest/admin-api.md Outdated
```

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
Copy Markdown
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

@ja3090 ja3090 Aug 18, 2023

Copy link
Copy Markdown
Contributor Author

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

Revolyssup
Revolyssup previously approved these changes Aug 21, 2023
Comment thread docs/en/latest/admin-api.md Outdated

### 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
Copy Markdown
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
Copy Markdown
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?

@shreemaan-abhishek
shreemaan-abhishek self-requested a review August 21, 2023 09:39
Periods can be added as special characters too
@shreemaan-abhishek
shreemaan-abhishek requested review from Revolyssup and removed request for bzp2010 and juststillthinking August 21, 2023 14:58
@shreemaan-abhishek
shreemaan-abhishek merged commit 9a11b90 into apache:master 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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: what is the syntax of {id} in apisix-admin api?

4 participants