Clarify that base_url should contain only hostname #2143
Merged
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.
If users include any path in their base_url, the postMessage does not work.
Summary
I had to troubleshoot for most of today trying to piece together why the postMessage operation was not executing correctly upon successful authentication through GitHub. I ended up finding an answer in this issue on a supported OAuth backend, and I felt the documentation could have been clearer that the base_url should contain only the site's hostname and no path.
In this case, the confusion was that I'm handling auth through an existing api that is located at https://example.com/api. So I had:
Once I changed this to
I got it working.
Test plan
Just a small text change.
A picture of a cute animal (not mandatory but encouraged)