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(clients): annotate internal configs and hide internal APIs #2388

Merged
merged 5 commits into from
May 14, 2021

Conversation

AllanZhengYP
Copy link
Contributor

@AllanZhengYP AllanZhengYP commented May 12, 2021

Closes: https://github.com/aws/aws-sdk-js-v3/projects/2#card-59234772
Closes: https://github.com/aws/aws-sdk-js-v3/projects/2#card-59234744

Description

  1. Annotate the internal client configs and hide them from the API reference:
  • current client config contains a lot of noises of entries that users are not suppose to set
    Screen Shot 2021-05-12 at 2 14 22 PM
  • new client config interface only shows the configs that users need to know:
    Screen Shot 2021-05-12 at 2 14 14 PM
  1. filterSensitiveLog() is removed from the API reference.
  2. Every config and resolved config entry has documentation:
    Screen Shot 2021-05-12 at 2 26 38 PM

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@AllanZhengYP AllanZhengYP merged commit 7e2cbdb into aws:main May 14, 2021
@github-actions
Copy link

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 29, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants