1
0
mirror of synced 2026-01-27 16:02:00 -05:00
Files
airbyte/airbyte-integrations/connectors/source-airtable/source_airtable/spec.json
Denys Davydov 3a63e66e42 Source Airtable: update spec and doc (#24093)
* #1651 source airtable: update spec and doc

* #1651 source airtable: upd changelog

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
2023-03-15 21:19:24 +02:00

124 lines
4.0 KiB
JSON

{
"documentationUrl": "https://docs.airbyte.com/integrations/sources/airtable",
"connectionSpecification": {
"$schema": "https://json-schema.org/draft-07/schema#",
"title": "Airtable Source Spec",
"type": "object",
"additionalProperties": true,
"properties": {
"credentials": {
"title": "Authentication",
"type": "object",
"oneOf": [
{
"type": "object",
"title": "OAuth2.0",
"required": ["client_id", "client_secret", "refresh_token"],
"properties": {
"auth_method": {
"type": "string",
"const": "oauth2.0"
},
"client_id": {
"type": "string",
"title": "Client ID",
"description": "The client ID of the Airtable developer application.",
"airbyte_secret": true
},
"client_secret": {
"type": "string",
"title": "Client secret",
"description": "The client secret the Airtable developer application.",
"airbyte_secret": true
},
"access_token": {
"type": "string",
"description": "Access Token for making authenticated requests.",
"airbyte_secret": true
},
"token_expiry_date": {
"type": "string",
"description": "The date-time when the access token should be refreshed.",
"format": "date-time"
},
"refresh_token": {
"type": "string",
"title": "Refresh token",
"description": "The key to refresh the expired access token.",
"airbyte_secret": true
}
}
},
{
"title": "Personal Access Token",
"type": "object",
"required": ["api_key"],
"properties": {
"auth_method": {
"type": "string",
"const": "api_key"
},
"api_key": {
"type": "string",
"description": "The Personal Access Token for the Airtable account. See the <a href=\"https://airtable.com/developers/web/guides/personal-access-tokens\">Support Guide</a> for more information on how to obtain this token.",
"title": "Personal Access Token",
"airbyte_secret": true,
"examples": ["key1234567890"]
}
}
}
]
}
}
},
"advanced_auth": {
"auth_flow_type": "oauth2.0",
"predicate_key": ["credentials", "auth_method"],
"predicate_value": "oauth2.0",
"oauth_config_specification": {
"complete_oauth_output_specification": {
"type": "object",
"properties": {
"access_token": {
"type": "string",
"path_in_connector_config": ["credentials", "access_token"]
},
"refresh_token": {
"type": "string",
"path_in_connector_config": ["credentials", "refresh_token"]
},
"token_expiry_date": {
"type": "string",
"format": "date-time",
"path_in_connector_config": ["credentials", "token_expiry_date"]
}
}
},
"complete_oauth_server_input_specification": {
"type": "object",
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
}
}
},
"complete_oauth_server_output_specification": {
"type": "object",
"properties": {
"client_id": {
"type": "string",
"path_in_connector_config": ["credentials", "client_id"]
},
"client_secret": {
"type": "string",
"path_in_connector_config": ["credentials", "client_secret"]
}
}
}
}
}
}