Skip to content

fix: (DeclarativeOAuthFlow) - make the extract_output Optional; correct the descriptions #106

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Jan 23, 2025
Merged

fix: (DeclarativeOAuthFlow) - make the extract_output Optional; correct the descriptions #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
df1d219
fix
Jan 21, 2025
2e343c5
updated
Jan 21, 2025
f8c45cc
added the token_expiry_key optional override
Jan 22, 2025
2364ce7
Merge branch 'main' into baz/doaf-make-extract-output-optional
bnchrch Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 26 additions & 6 deletions protocol-models/src/main/resources/airbyte_protocol/airbyte_protocol.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -663,7 +663,6 @@ definitions:
required:
- consent_url
- access_token_url
- extract_output
properties:
consent_url:
type: string
Expand All @@ -673,7 +672,7 @@ definitions:

Examples:
{
"consent_url": "https://domain.host.com/oauth2/authorize?{client_id_key}={{client_id_key}}&{redirect_uri_key}={urlEncoder:{{redirect_uri_key}}}&{scope_key}={urlEncoder:{{scope_key}}}&{state_key}={{state_key}}&subdomain={subdomain}"
"consent_url": "https://domain.host.com/oauth2/authorize?{{ client_id_key }}={{ client_id_value }}&{{ redirect_uri_key }}={{ {{redirect_uri_value}} | urlEncoder }}&{{ scope_key }}={{ {{scope_key}} | urlEncoder }}&{{ state_key }}={{ state_value }}&subdomain={{ subdomain }}"
}
scope:
type: string
Expand All @@ -692,7 +691,7 @@ definitions:

Examples:
{
"access_token_url": https://auth.host.com/oauth2/token?{client_id_key}={{client_id_key}}&{client_secret_key}={{client_secret_key}}&{auth_code_key}={{auth_code_key}}&{redirect_uri_key}={urlEncoder:{{redirect_uri_key}}}
"access_token_url": "https://auth.host.com/oauth2/token?{{ client_id_key }}={{ client_id_value }}&{{ client_secret_key }}={{ client_secret_value }}&{{ auth_code_key }}={{ auth_code_value }}&{{ redirect_uri_key }}={{ {{redirect_uri_key}} | urlEncoder }}"
}
access_token_headers:
type: object
Expand All @@ -706,7 +705,7 @@ definitions:

{
"access_token_headers": {
"Authorization": "Basic {base64Encoder:{client_id}:{client_secret}}"
"Authorization": "Basic {{ {{ client_id_value }}:{{ client_secret_value }} | base64Encoder }}"
}
}
access_token_params:
Expand All @@ -720,7 +719,7 @@ definitions:
{
"access_token_params": {
"my_query_param": "param_value",
"{client_id_key}": {{client_id_key}}
"{{ client_id_key }}": "{{ client_id_value }}"
}
}
extract_output:
Expand Down Expand Up @@ -810,6 +809,15 @@ definitions:
{
"redirect_uri_key": "my_custom_redirect_uri_key_name"
}
token_expiry_key:
type: string
description: |-
The OAuth Specific optional override to provide the custom key name to something like `expires_at`, if required by data-provider.

Examples:
{
"token_expiry_key": "expires_at"
}
existingJavaType: com.fasterxml.jackson.databind.JsonNode
complete_oauth_output_specification:
description: |-
Expand All @@ -819,11 +827,23 @@ definitions:
For each field, a special annotation `path_in_connector_config` can be specified to determine where to merge it,

Examples:
With a `refresh_token` in the `oauth response`:

complete_oauth_output_specification={
refresh_token: {
type: string,
path_in_connector_config: ['credentials', 'refresh_token']
path_in_connector_config: ['credentials', 'refresh_token'],
path_in_oauth_response: ['refresh_token']
}
}

With a nested `refresh_token` under the `data` object, in the `oauth response`:

complete_oauth_output_specification={
refresh_token: {
type: string,
path_in_connector_config: ['credentials', 'refresh_token'],
path_in_oauth_response: ['data', 'refresh_token']
}
}
type: object
Expand Down
32 changes: 26 additions & 6 deletions protocol-models/src/main/resources/airbyte_protocol/v0/airbyte_protocol.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -718,7 +718,6 @@ definitions:
required:
- consent_url
- access_token_url
- extract_output
properties:
consent_url:
type: string
Expand All @@ -728,7 +727,7 @@ definitions:

Examples:
{
"consent_url": "https://domain.host.com/oauth2/authorize?{client_id_key}={{client_id_key}}&{redirect_uri_key}={urlEncoder:{{redirect_uri_key}}}&{scope_key}={urlEncoder:{{scope_key}}}&{state_key}={{state_key}}&subdomain={subdomain}"
"consent_url": "https://domain.host.com/oauth2/authorize?{{ client_id_key }}={{ client_id_value }}&{{ redirect_uri_key }}={{ {{redirect_uri_value}} | urlEncoder }}&{{ scope_key }}={{ {{scope_key}} | urlEncoder }}&{{ state_key }}={{ state_value }}&subdomain={{ subdomain }}"
}
scope:
type: string
Expand All @@ -747,7 +746,7 @@ definitions:

Examples:
{
"access_token_url": https://auth.host.com/oauth2/token?{client_id_key}={{client_id_key}}&{client_secret_key}={{client_secret_key}}&{auth_code_key}={{auth_code_key}}&{redirect_uri_key}={urlEncoder:{{redirect_uri_key}}}
"access_token_url": "https://auth.host.com/oauth2/token?{{ client_id_key }}={{ client_id_value }}&{{ client_secret_key }}={{ client_secret_value }}&{{ auth_code_key }}={{ auth_code_value }}&{{ redirect_uri_key }}={{ {{redirect_uri_key}} | urlEncoder }}"
}
access_token_headers:
type: object
Expand All @@ -761,7 +760,7 @@ definitions:

{
"access_token_headers": {
"Authorization": "Basic {base64Encoder:{client_id}:{client_secret}}"
"Authorization": "Basic {{ {{ client_id_value }}:{{ client_secret_value }} | base64Encoder }}"
}
}
access_token_params:
Expand All @@ -775,7 +774,7 @@ definitions:
{
"access_token_params": {
"my_query_param": "param_value",
"{client_id_key}": {{client_id_key}}
"{{ client_id_key }}": "{{ client_id_value }}"
}
}
extract_output:
Expand Down Expand Up @@ -865,6 +864,15 @@ definitions:
{
"redirect_uri_key": "my_custom_redirect_uri_key_name"
}
token_expiry_key:
type: string
description: |-
The OAuth Specific optional override to provide the custom key name to something like `expires_at`, if required by data-provider.

Examples:
{
"token_expiry_key": "expires_at"
}
existingJavaType: com.fasterxml.jackson.databind.JsonNode
complete_oauth_output_specification:
description: |-
Expand All @@ -874,11 +882,23 @@ definitions:
For each field, a special annotation `path_in_connector_config` can be specified to determine where to merge it,

Examples:
With a `refresh_token` in the `oauth response`:

complete_oauth_output_specification={
refresh_token: {
type: string,
path_in_connector_config: ['credentials', 'refresh_token']
path_in_connector_config: ['credentials', 'refresh_token'],
path_in_oauth_response: ['refresh_token']
}
}

With a nested `refresh_token` under the `data` object, in the `oauth response`:

complete_oauth_output_specification={
refresh_token: {
type: string,
path_in_connector_config: ['credentials', 'refresh_token'],
path_in_oauth_response: ['data', 'refresh_token']
}
}
type: object
Expand Down
Loading