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.

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

refactor: Remove authSpecification from Airbyte protocol #39

Merged
merged 1 commit into from
Jul 31, 2023
Merged
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -408,52 +408,6 @@ definitions:
- overwrite
#- upsert_dedup # TODO chris: SCD Type 1 can be implemented later
- append_dedup # SCD Type 1 & 2
OAuth2Specification:
type: object
additionalProperties: true
description: An object containing any metadata needed to describe this connector's Oauth flow. Deprecated, switching to advanced_auth instead
properties:
rootObject:
description:
"A list of strings representing a pointer to the root object which contains any oauth parameters in the ConnectorSpecification.

Examples:

if oauth parameters were contained inside the top level, rootObject=[]
If they were nested inside another object {'credentials': {'app_id' etc...}, rootObject=['credentials']
If they were inside a oneOf {'switch': {oneOf: [{client_id...}, {non_oauth_param]}}, rootObject=['switch', 0]
"
type: array
items:
oneOf:
- type: string
- type: integer

oauthFlowInitParameters:
description:
"Pointers to the fields in the rootObject needed to obtain the initial refresh/access tokens for the OAuth flow.
Each inner array represents the path in the rootObject of the referenced field.
For example.
Assume the rootObject contains params 'app_secret', 'app_id' which are needed to get the initial refresh token.
If they are not nested in the rootObject, then the array would look like this [['app_secret'], ['app_id']]
If they are nested inside an object called 'auth_params' then this array would be [['auth_params', 'app_secret'], ['auth_params', 'app_id']]"
type: array
items:
description: A list of strings denoting a pointer into the rootObject for where to find this property
type: array
items:
type: string
oauthFlowOutputParameters:
description:
"Pointers to the fields in the rootObject which can be populated from successfully completing the oauth flow using the init parameters.
This is typically a refresh/access token.
Each inner array represents the path in the rootObject of the referenced field."
type: array
items:
description: A list of strings denoting a pointer into the rootObject for where to find this property
type: array
items:
type: string
ConnectorSpecification:
type: object
additionalProperties: true
Expand Down Expand Up @@ -496,16 +450,6 @@ definitions:
type: array
items:
"$ref": "#/definitions/DestinationSyncMode"
authSpecification:
description: deprecated, switching to advanced_auth instead
type: object
properties:
auth_type:
type: string
enum: ["oauth2.0"] # Future auth types should be added here
oauth2Specification:
description: If the connector supports OAuth, this field should be non-null.
"$ref": "#/definitions/OAuth2Specification"
advanced_auth:
description: |-
Additional and optional specification object to describe what an 'advanced' Auth flow would need to function.
Expand Down