Skip to content
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

feat: add connector DeclarativeOAuthFlow input to protocol #96

Merged
merged 5 commits into from
Nov 6, 2024
Merged

feat: add connector DeclarativeOAuthFlow input to protocol #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2150a5a
add new input spec field
erohmensing Oct 8, 2024
a4b0488
add to non-v0 one as well?
erohmensing Oct 8, 2024
57bda82
updated oauth_connector_input_specification with properties
bazarnov Oct 31, 2024
515e3ea
Merge remote-tracking branch 'origin/main' into ella/oauth
bazarnov Oct 31, 2024
575f789
update with property (draft)
bazarnov Oct 31, 2024
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
142 changes: 142 additions & 0 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 @@ -655,6 +655,148 @@ definitions:
}
type: object
existingJavaType: com.fasterxml.jackson.databind.JsonNode
oauth_connector_input_specification:
bazarnov marked this conversation as resolved.
Show resolved Hide resolved
description: |-
OAuth specific blob. Pertains to the fields defined by the connector relating to the OAuth flow.
type: object
additionalProperties: false
required:
- consent_url
- scope
- access_token_url
- extract_output
properties:
consent_url:
type: string
description: |-
The OAuth Specific string URL string template to initiate the authentication.
The placeholders are replaced during the processing to provide neccessary values.

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}"
}
scope:
type: string
description: |-
The OAuth Specific string of the scopes needed to be grant for authenticated user.

Examples:
{
"scope": "user:read user:read_orders workspaces:read"
}
access_token_url:
type: string
description: |-
The OAuth Specific URL templated string to obtain the `access_token`, `refresh_token` etc.
The placeholders are replaced during the processing to provide neccessary values.

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_headers:
type: object
additionalProperties: true
description: |-
The OAuth Specific optional headers to inject while exchanging the `auth_code` to `access_token` during `completeOAuthFlow` step.

Examples:
In this example the header value will be encoded with the base64 hash from `client_id` and `client_secret`,
to provide neccessary header to complete auth flow and obtain the `access_token`.

{
"access_token_headers": {
"Authorization": "Basic {base64Encoder:{client_id}:{client_secret}}"
}
}
extract_output:
type: array
items:
type: string
description: |-
The OAuth Specific list of strings to indicate which keys should be extracted and returned back to the input config.

Examples:
In this example, once the OAuthFlow has been completed successfully,
the `access_token`, `refresh_token` and other fields like `other_field` will be checked and extracted from the OAuthOutput.

{
"extract_output": ["access_token", "refresh_token", "other_field"]
}
state:
type: object
additionalProperties: true
description: |-
The OAuth Specific object to provide the criteria of how the `state` query param should be constructed,
including length and complexity.

TODO: review and edit this property, once the state generation logic is finilized.

Examples:
{
"state": {
"min_length": 7,
"max_length": 128,
"min_special": 3,
"excluded": ["$", "\\", "."]
}
}
client_id_key:
type: string
description: |-
The OAuth Specific optional override to provide the custom `client_id` key name, if required by data-provider.

Examples:
{
"client_id_key": "my_custom_client_id_key_name"
}
client_secret_key:
type: string
description: |-
The OAuth Specific optional override to provide the custom `client_secret` key name, if required by data-provider.

Examples:
{
"client_secret_key": "my_custom_client_secret_key_name"
}
scope_key:
type: string
description: |-
The OAuth Specific optional override to provide the custom `scope` key name, if required by data-provider.

Examples:
{
"scope_key": "my_custom_scope_key_key_name"
}
state_key:
type: string
description: |-
The OAuth Specific optional override to provide the custom `state` key name, if required by data-provider.

Examples:
{
"state_key": "my_custom_state_key_key_name"
}
auth_code_key:
type: string
description: |-
The OAuth Specific optional override to provide the custom `code` key name to something like `auth_code` or `custom_auth_code`, if required by data-provider.

Examples:
{
"auth_code_key": "my_custom_auth_code_key_name"
}
redirect_uri_key:
type: string
description: |-
The OAuth Specific optional override to provide the custom `redirect_uri` key name to something like `callback_uri`, if required by data-provider.

Examples:
{
"redirect_uri_key": "my_custom_redirect_uri_key_name"
}
existingJavaType: com.fasterxml.jackson.databind.JsonNode
complete_oauth_output_specification:
description: |-
OAuth specific blob. This is a Json Schema used to validate Json configurations produced by the OAuth flows as they are
Expand Down
142 changes: 142 additions & 0 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 @@ -710,6 +710,148 @@ definitions:
}
type: object
existingJavaType: com.fasterxml.jackson.databind.JsonNode
oauth_connector_input_specification:
description: |-
OAuth specific blob. Pertains to the fields defined by the connector relating to the OAuth flow.
type: object
additionalProperties: false
required:
- consent_url
- scope
- access_token_url
- extract_output
properties:
consent_url:
type: string
description: |-
The OAuth Specific string URL string template to initiate the authentication.
The placeholders are replaced during the processing to provide neccessary values.

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}"
}
scope:
type: string
description: |-
The OAuth Specific string of the scopes needed to be grant for authenticated user.

Examples:
{
"scope": "user:read user:read_orders workspaces:read"
}
access_token_url:
type: string
description: |-
The OAuth Specific URL templated string to obtain the `access_token`, `refresh_token` etc.
The placeholders are replaced during the processing to provide neccessary values.

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_headers:
type: object
additionalProperties: true
description: |-
The OAuth Specific optional headers to inject while exchanging the `auth_code` to `access_token` during `completeOAuthFlow` step.

Examples:
In this example the header value will be encoded with the base64 hash from `client_id` and `client_secret`,
to provide neccessary header to complete auth flow and obtain the `access_token`.

{
"access_token_headers": {
"Authorization": "Basic {base64Encoder:{client_id}:{client_secret}}"
}
}
extract_output:
type: array
items:
type: string
description: |-
The OAuth Specific list of strings to indicate which keys should be extracted and returned back to the input config.

Examples:
In this example, once the OAuthFlow has been completed successfully,
the `access_token`, `refresh_token` and other fields like `other_field` will be checked and extracted from the OAuthOutput.

{
"extract_output": ["access_token", "refresh_token", "other_field"]
}
state:
type: object
additionalProperties: true
description: |-
The OAuth Specific object to provide the criteria of how the `state` query param should be constructed,
including length and complexity.

TODO: review and edit this property, once the state generation logic is finilized.

Examples:
{
"state": {
"min_length": 7,
"max_length": 128,
"min_special": 3,
"excluded": ["$", "\\", "."]
}
}
client_id_key:
type: string
description: |-
The OAuth Specific optional override to provide the custom `client_id` key name, if required by data-provider.

Examples:
{
"client_id_key": "my_custom_client_id_key_name"
}
client_secret_key:
type: string
description: |-
The OAuth Specific optional override to provide the custom `client_secret` key name, if required by data-provider.

Examples:
{
"client_secret_key": "my_custom_client_secret_key_name"
}
scope_key:
type: string
description: |-
The OAuth Specific optional override to provide the custom `scope` key name, if required by data-provider.

Examples:
{
"scope_key": "my_custom_scope_key_key_name"
}
state_key:
type: string
description: |-
The OAuth Specific optional override to provide the custom `state` key name, if required by data-provider.

Examples:
{
"state_key": "my_custom_state_key_key_name"
}
auth_code_key:
type: string
description: |-
The OAuth Specific optional override to provide the custom `code` key name to something like `auth_code` or `custom_auth_code`, if required by data-provider.

Examples:
{
"auth_code_key": "my_custom_auth_code_key_name"
}
redirect_uri_key:
type: string
description: |-
The OAuth Specific optional override to provide the custom `redirect_uri` key name to something like `callback_uri`, if required by data-provider.

Examples:
{
"redirect_uri_key": "my_custom_redirect_uri_key_name"
}
existingJavaType: com.fasterxml.jackson.databind.JsonNode
complete_oauth_output_specification:
description: |-
OAuth specific blob. This is a Json Schema used to validate Json configurations produced by the OAuth flows as they are
Expand Down
Loading