-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
Conversation
docs/en/latest/admin-api.md
Outdated
| 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 | |
There was a problem hiding this comment.
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:
| 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) | |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed.
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