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.

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

docs: add more secret information to the admin api #11569

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

HuanXin-Chen
Copy link
Contributor

Description

Due to changes in this two pull requests, it is necessary to synchronize the latest information to the relevant documentation of the admin API.

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)

@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. doc Documentation things labels Sep 11, 2024
docs/en/latest/admin-api.md Outdated Show resolved Hide resolved
docs/en/latest/admin-api.md Outdated Show resolved Hide resolved
docs/en/latest/admin-api.md Outdated Show resolved Hide resolved
kayx23
kayx23 previously approved these changes Sep 12, 2024
Comment on lines 1502 to 1508
| Parameter | Required | Type | Description | Example |
| --- | --- | --- | --- | --- |
| access_key_id | True | string | AWS Access Key ID | |
| secret_access_key | True | string | AWS Secret Access Key | |
| session_token | False | string | Temporary access credential information | |
| region | False | string | AWS Region | |
| endpoint_url | False | URI | AWS Secret Manager URL | https://secretsmanager.{region}.amazonaws.com |
Copy link
Contributor

Choose a reason for hiding this comment

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

The example column seems redundant. I would suggest using the following table instead:

Suggested change
| Parameter | Required | Type | Description | Example |
| --- | --- | --- | --- | --- |
| access_key_id | True | string | AWS Access Key ID | |
| secret_access_key | True | string | AWS Secret Access Key | |
| session_token | False | string | Temporary access credential information | |
| region | False | string | AWS Region | |
| endpoint_url | False | URI | AWS Secret Manager URL | https://secretsmanager.{region}.amazonaws.com |
| Parameter | Required | Type | Description |
| ----------------- | -------- | ------ | --------------------------------------------------------------------------- |
| access_key_id | True | string | AWS Access Key ID |
| secret_access_key | True | string | AWS Secret Access Key |
| session_token | False | string | Temporary access credential information |
| region | False | string | AWS Region |
| endpoint_url | False | URI | AWS Secret Manager URL (e.g: https://secretsmanager.{region}.amazonaws.com) |

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 think there is no need to remove the example field, as the vault document also contains this field, and docs consistency should be maintained.

Copy link
Contributor

Choose a reason for hiding this comment

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

sure, fine by me. I wanted it to be removed because it's a very wide almost empty column taking screen real estate away from other columns :D

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed.

docs/en/latest/admin-api.md Outdated Show resolved Hide resolved
docs/en/latest/admin-api.md Outdated Show resolved Hide resolved
docs/en/latest/admin-api.md Outdated Show resolved Hide resolved
kayx23
kayx23 previously approved these changes Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation things size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants