Docs about Docs logo Docs about Docs

Database source form property template reference

HOME > REFERENCE > CONNECT TEMPLATES > DATABASE SOURCE FORM PROPERTY TEMPLATE REFERENCE

About this template

File location: /_templates/connect
Used in:
Repo link: Click to view in the Stitch Docs repo
Instructions:

This template is used to add new database source form properties to the Connect API documentation. This template is used to add new database source form properties to the Connect API documentation.

Template sections

Each template is grouped into sections to make parameters easier to find. These sections and the parameters they contain are described below.

API content types

These parameters control how the content for the connection property is formatted and how links to the connection property’s section are generated.

Parameter Description
product-type
STRING

The developer ‘product’ the property is associated with. For source or destination connection properties, this will always be connect.
content-type
STRING

The type of Connect content. This will be api-form.
form-type
STRING

The type of connection property this is.

Must be one of the following:

  • destination
  • source
key
STRING

The unique ID of the connection property, formatted as [form-type]-form-properties-[name]-object

This is used to create an anchor link for the connection property, which is used throughout the documentation and in the side navigation.

Example values:

  • source-form-properties-heroku-object
  • source-form-properties-facebook-ads-object
  • destination-form-properties-snowflake-object
Back to top

Object property details

Details about the connection property and its source, such as its name, a description, etc.

Parameter Description
title
STRING

The display title for the connection property, formatted as [Display-name] [Form-type] Connection Property

Example values:

  • Google CloudSQL MySQL Source Connection Property
  • Amazon Redshift Destination Connection Property
  • Salesforce Source Connection Property
api-type
STRING

The name of the connection property as returned by the Connect API, with platform. removed.

For example: Heroku is returned as platform.heroku_pg, which would make this value heroku_pg
display-name
STRING

The display name of the source or destination.

Example values:

  • Google CloudSQL MySQL
  • Amazon Aurora
  • Close.io
docs-name
STRING

The source or destination key as it is in the Stitch Docs.

In the corresponding documentation, this will be equal to:

  • Destinations: destination.type
  • Database integrations: integration.name
  • SaaS integrations: integration.name
db-type
STRING

The type of database that backs the source.

Must be one of the following:

  • dynamodb
  • mongodb
  • mssql
  • mysql
  • oracle
  • postgres
  • redshift
  • responsys
  • snowflake
  • s3
  • sftp
description
STRING

The description of the connection property. By default, copy similar to the following will display for any connection property, depending on its form-type:

A [Name] connection reads data from a [Name] source and corresponds to `type: platform.[name]`

If there’s any other info you want to include, you can include it in this field using Markdown or HTML. Otherwise, this can be left blank.
uses-common-fields
BOOLEAN

If true, the attributes contained in _data/connect/common/database-sources.all-destinations should be included in the attributes for the connection property.

This includes attributes like host, port, etc.
Back to top

Form attributes

The attributes contained in the object’s form connection step. These are the attributes required to configure the connection in Stitch.

This is an example of Form property documentation.

Nearly every connection property shares some common attributes depending on its form-type. For example: Almost all source connection properties source have anchor_time and frequency_in_minutes attributes. The data for these shared attributes can be found in the following files:

This part of a connection property’s data file only needs to be included if its report card contains attributes specific to it. For example: If a report card only contains anchor_time and frequency_in_minutes attributes, this section isn’t required.

Each item in the object-attributes list must contain the following attributes:

Parameter Description
name
STRING

The name of the attribute as it appears in the report card.

Note: Case must be retained. This means that if the attribute’s name contains upper- and lower-case characters in the report card, the value of this parameter must match.

Example values:

  • api_token
  • api_secret
  • subdomain
type
STRING

The attribute’s data type.
required
BOOLEAN

If true, the attribute must be provided in the properties argument to fully configure the connection.
description
STRING

A description of the attribute, which can be written in Markdown or HTML.

  - name: "subdomain"
    type: "string"
    required: true
    description: "The Zendesk subdomain. For example: `stitchdata.zendesk.zom` would make this value `stitchdata` ."
value
STRING

An example value of the attribute. This is used in the example JSON object for the form property.
Back to top

OAuth attributes

Note: This is only required if a source or destination supports OAuth via the API, that is, if the connection property object contains an oauth connection step object.

This is an example of OAuth property documentation.

Each item in the oauth-attributes list must contain the following attributes:

Parameter Description
name
STRING

The name of the attribute as it appears in the report card.

Note: Case must be retained. This means that if the attribute’s name contains upper- and lower-case characters in the report card, the value of this parameter must match.

Example values:

  • access_token
  • account_id
type
STRING

The attribute’s data type.
required
BOOLEAN

If true, the attribute must be provided to fully configure OAuth for the connection.
credential
BOOLEAN

If true, the attribute is considered a credential and its value will not be returned in responses from the API.
description
STRING

A description of the attribute, which can be written in Markdown or HTML.

- name: "access_token"
  type: "string"
  required: true
  credential: true
  description: |
    An access token generated by a Facebook OAuth handshake.
  value: "<ACCESS_TOKEN>"
value
STRING

An example value of the attribute. This is used in the example JSON object for the connection property.
Back to top
Back to top

Last updated: 28 July 2021