Update OAuth instructions to use curl to get refresh token #1858
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
thena-seer-sfg
requested review from
tayloramurphy,
pnadolny13 and
edgarrmondragon
as code owners
✅ Deploy Preview for meltano-hub ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
edgarrmondragon
approved these changes
Sep 30, 2024
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.
Summary
The current instructions are incorrect. The code received in the redirect url is not a refresh token but a short-term authorization code, and the tap fails when it tries to use it as one. In order to get a refresh token, there is a code exchange step. The easiest way to do this is using curl, so I've added this step to the instructions.
This is based on Harvest's documentation: https://help.getharvest.com/api-v2/authentication-api/authentication/authentication/#oauth2-authorization-flow
I have also opened this PR in the source repo, where it seems these instructions were copied from: singer-io/tap-harvest-forecast#28
Test plan
Follow the updated instructions when setting up the extractor in meltano. Verify
meltano config tap-harvest-forecast testconfirms the validity of the configuration.