938436bcc9
* update definitions with new .com docs urls * update docs urls in specs * update generators * regenerate scaffold connectors * remove unrelated changes * update more urls * update specs * fix tests * run `:airbyte-config:specs:generateSeedConnectorSpecs` to fix formatting * revert docs changes to make pr more reviewable * revert generator readme changes to make more reviewable * fix mysql strict encrypt expected spec * fix postgres expected spec
149 lines
4.6 KiB
JSON
149 lines
4.6 KiB
JSON
{
|
|
"documentationUrl": "https://docs.airbyte.com/integrations/sources/square",
|
|
"connectionSpecification": {
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"title": "Square Source CDK Specifications",
|
|
"type": "object",
|
|
"required": ["is_sandbox"],
|
|
"additionalProperties": true,
|
|
"properties": {
|
|
"is_sandbox": {
|
|
"type": "boolean",
|
|
"description": "Determines whether to use the sandbox or production environment.",
|
|
"title": "Sandbox",
|
|
"examples": [true, false],
|
|
"default": false
|
|
},
|
|
"start_date": {
|
|
"type": "string",
|
|
"description": "UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. If not set, all data will be replicated.",
|
|
"title": "Start Date",
|
|
"examples": ["2021-01-01"],
|
|
"default": "2021-01-01",
|
|
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
|
|
},
|
|
"include_deleted_objects": {
|
|
"type": "boolean",
|
|
"description": "In some streams there is an option to include deleted objects (Items, Categories, Discounts, Taxes)",
|
|
"title": "Include Deleted Objects",
|
|
"examples": [true, false],
|
|
"default": false
|
|
},
|
|
"credentials": {
|
|
"type": "object",
|
|
"title": "Credential Type",
|
|
"oneOf": [
|
|
{
|
|
"title": "Oauth authentication",
|
|
"type": "object",
|
|
"required": [
|
|
"auth_type",
|
|
"client_id",
|
|
"client_secret",
|
|
"refresh_token"
|
|
],
|
|
"properties": {
|
|
"auth_type": {
|
|
"type": "string",
|
|
"const": "Oauth",
|
|
"enum": ["Oauth"],
|
|
"default": "Oauth",
|
|
"order": 0
|
|
},
|
|
"client_id": {
|
|
"title": "Client ID",
|
|
"type": "string",
|
|
"description": "The Square-issued ID of your application",
|
|
"airbyte_secret": true
|
|
},
|
|
"client_secret": {
|
|
"title": "Client Secret",
|
|
"type": "string",
|
|
"description": "The Square-issued application secret for your application",
|
|
"airbyte_secret": true
|
|
},
|
|
"refresh_token": {
|
|
"title": "Refresh Token",
|
|
"type": "string",
|
|
"description": "A refresh token generated using the above client ID and secret",
|
|
"airbyte_secret": true
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"type": "object",
|
|
"title": "API Key",
|
|
"required": ["auth_type", "api_key"],
|
|
"properties": {
|
|
"auth_type": {
|
|
"type": "string",
|
|
"const": "Apikey",
|
|
"enum": ["Apikey"],
|
|
"default": "Apikey",
|
|
"order": 1
|
|
},
|
|
"api_key": {
|
|
"title": "API key token",
|
|
"type": "string",
|
|
"description": "The API key for a Square application",
|
|
"airbyte_secret": true
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"authSpecification": {
|
|
"auth_type": "oauth2.0",
|
|
"oauth2Specification": {
|
|
"rootObject": ["credentials", 0],
|
|
"oauthFlowInitParameters": [["client_id"], ["client_secret"]],
|
|
"oauthFlowOutputParameters": [["refresh_token"]]
|
|
}
|
|
},
|
|
"advanced_auth": {
|
|
"auth_flow_type": "oauth2.0",
|
|
"predicate_key": ["credentials", "auth_type"],
|
|
"predicate_value": "Oauth",
|
|
"oauth_config_specification": {
|
|
"complete_oauth_output_specification": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"refresh_token": {
|
|
"type": "string",
|
|
"path_in_connector_config": ["credentials", "refresh_token"]
|
|
}
|
|
}
|
|
},
|
|
"complete_oauth_server_input_specification": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"client_id": {
|
|
"type": "string"
|
|
},
|
|
"client_secret": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"complete_oauth_server_output_specification": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"client_id": {
|
|
"type": "string",
|
|
"path_in_connector_config": ["credentials", "client_id"]
|
|
},
|
|
"client_secret": {
|
|
"type": "string",
|
|
"path_in_connector_config": ["credentials", "client_secret"]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|