feat(cdk): Add configurable OAuth scope property name (AI-Triage PR)#888
Draft
devin-ai-integration[bot] wants to merge 2 commits intomainfrom
Draft
feat(cdk): Add configurable OAuth scope property name (AI-Triage PR)#888devin-ai-integration[bot] wants to merge 2 commits intomainfrom
devin-ai-integration[bot] wants to merge 2 commits intomainfrom
Conversation
This change adds a new 'scopes_name' parameter to OAuth authenticators, allowing connector developers to configure the property name used for scopes in token refresh requests. Per RFC 6749, the default is 'scope' (singular), but some APIs require 'scopes' (plural) or other custom names. Changes: - Add abstract get_scopes_name() method to AbstractOauth2Authenticator - Add scopes_name parameter to Oauth2Authenticator (default: 'scope') - Add scopes_name parameter to SingleUseRefreshTokenOauth2Authenticator - Add scopes_name field to DeclarativeOauth2Authenticator - Update declarative_component_schema.yaml with scopes_name property - Update model_to_component_factory.py to pass scopes_name - Update tests to reflect new default behavior Resolves: airbytehq/oncall#11127 Related: airbytehq/airbyte#54137 Co-Authored-By: unknown <>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
👋 Greetings, Airbyte Team Member!Here are some helpful tips and reminders for your convenience. 💡 Show Tips and TricksTesting This CDK VersionYou can test this version of the CDK using the following: # Run the CLI from this branch:
uvx 'git+https://github.com/airbytehq/airbyte-python-cdk.git@devin/1770023743-configurable-oauth-scopes-name#egg=airbyte-python-cdk[dev]' --help
# Update a connector to use the CDK from this branch ref:
cd airbyte-integrations/connectors/source-example
poe use-cdk-branch devin/1770023743-configurable-oauth-scopes-namePR Slash CommandsAirbyte Maintainers can execute the following slash commands on your PR:
|
Co-Authored-By: unknown <>
This file contains hidden or 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
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.
feat(cdk): Add configurable OAuth scope property name (AI-Triage PR)
Summary
Adds a new
scopes_nameparameter to OAuth authenticators, allowing connector developers to configure the property name used for scopes in token refresh requests. Per RFC 6749, the default is now"scope"(singular), but some APIs require"scopes"(plural) or other custom names like the Cropster API.Changes:
get_scopes_name()abstract method toAbstractOauth2Authenticatorscopes_nameparameter toOauth2Authenticator,SingleUseRefreshTokenOauth2Authenticator, andDeclarativeOauth2Authenticator"scope"(RFC 6749 compliant)Updates since last revision
declarative_component_schema.pyfileReview & Testing Checklist for Human
"scopes"to"scope". Verify no existing connectors rely on the old default behavior. Search for connectors using OAuth that might break.scopes_nameparameter is correctly passed through all authenticator constructors (checkSingleUseRefreshTokenOauth2Authenticator.__init__passes it tosuper().__init__)test_oauth.pyandtest_requests_native_auth.pyto confirm they correctly test the new behaviorRecommended test plan:
scopes_nameand verify the token request uses"scope"scopes_name: "scopes"and verify it uses"scopes"in the requestNotes
This PR was created as part of AI Triage for airbytehq/oncall#11127. Related closed issue: airbytehq/airbyte#54137.
The
declarative_component_schema.pyfile contains formatting changes from the code generator that are unrelated to this feature - these are expected when regenerating the schema.Link to Devin run: https://app.devin.ai/sessions/8764d877a8684a84844fd2b9c18e6ca4
Requested by: unknown ()