[SUPPORTENG-482] Doc update: Update OAuth2 snippet to note key limitations #589
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
…d or client_secret as keys
eliangcs
reviewed
Nov 14, 2022
packages/cli/README.md
Outdated
| // in `bundle.authData` for future use. Note, `client_id` and `client_secret` | ||
| // are reserved and cannot be used as keys for input form fields. | ||
| // If you need to save/use something that the user shouldn't need to type/choose, | ||
| // add a "computed" field, like: |
There was a problem hiding this comment.
Can you move this change to README-source.md and let the pre-commit hook auto generate README.md for us? Thanks!
packages/cli/package-lock.json
Outdated
| "integrity": "sha512-/0V5q0WbslqnwP91tirOvldvYISzaqhClxzyUKXYxs07yUILIs5jx/k6CFe8bvKSkds5w+eiOqta39Wk3WxdcQ==" | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
package-lock.json should not be in this change. We should undo the change here.
|
@eliangcs, thank you for the suggestions! I believe I've made the necessary changes, but please let me know if anything is still incorrect. |
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.
Here, I've updated the OAuth2 snippet to note that
client_idandclient_secretcan't be used as keys for form input fields.In testing, documented in the Slack threads linked in the accompanying Jira ticket, it appears
client_idin particular conflicts with the similarly named environment variable, causing issues in the token request. This can be avoided by refraining from using these key names in input form fields in the OAuth2 config.Note: