From b7f332c6d9016f7b80cfc581e1c387176ac69009 Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Mon, 24 Feb 2020 17:05:11 -0500 Subject: [PATCH] Asana/v1 - Add custom_fields to tasks (#431) --- _integration-schemas/asana/v1/tasks.md | 110 +++++++++++++++++++++++++ 1 file changed, 110 insertions(+) diff --git a/_integration-schemas/asana/v1/tasks.md b/_integration-schemas/asana/v1/tasks.md index 6a7078feb..2850cea75 100644 --- a/_integration-schemas/asana/v1/tasks.md +++ b/_integration-schemas/asana/v1/tasks.md @@ -9,6 +9,10 @@ singer-schema: "https://github.com/singer-io/tap-asana/blob/master/tap_asana/sch description: | The `{{ table.name }}` table contains info about the tasks in your {{ integration.display_name }} account. + #### Custom fields + + To replicate task custom fields, select the `custom_fields` attribute in Stitch. If your destination doesn't natively support nested data structures, two subtables (`tasks__custom_fields`, `tasks__custom_fields__enum_options`) will be created. + replication-method: "Key-based Incremental" attributes: @@ -56,6 +60,112 @@ attributes: type: "date-time" description: "The time the task was created." + - name: "custom_fields" + type: "array" + description: | + Details about the custom fields for the task, and the values applied to them. + subattributes: + - name: "description" + type: "string" + description: "The description of the custom field." + + - name: "enabled" + type: "boolean" + description: "Indicates if the custom field is enabled or not." + + - name: "enum_options" + type: "array" + description: | + **Applicable only when `resource_subtype: enum`.** The possible values that the `enum` field can adopt. + + {% assign type = "option" %} + subattributes: &enum-attributes + - name: "color" + type: "string" + description: "The color of the enum {{ type }}. Defaults to `none`." + + - name: "enabled" + type: "boolean" + description: "Indicates if the enum {{ type }} is enabled." + + - name: "gid" + type: "string" + description: "The globally unique identifier for the enum {{ type }}." + + - name: "id" + type: "integer" + description: "The enum {{ type }} ID." + + - name: "name" + type: "string" + description: "The name of the enum {{ type }}." + + - name: "resource_type" + type: "string" + description: "The base type of the resource." + + - name: "enum_value" + type: "object" + description: | + **Applicable only when `resource_subtype: enum`.** Details about the chosen value for the `enum` field. + + {% assign type = "value" %} + subattributes: *enum-attributes + + - name: "gid" + type: "string" + description: "The globally unique identifier for the resource." + + - name: "has_notifications_enabled" + type: "boolean" + description: "Indicates whether a follower of a task with this custom field should receive inbox notifications when the field's value changes." + + - name: "id" + type: "integer" + description: "The ID of the custom field." + + - name: "is_global_to_workspace" + type: "boolean" + description: "Indicates whether the custom field is available to every container in the work space." + + - name: "name" + type: "string" + description: "The name of the custom field." + + - name: "number_value" + type: "number" + description: "**Applicable only when `resource_subtype: number`.** The value of a custom number field." + + - name: "precision" + type: "integer" + description: | + **Applicable only when `resource_subtype: number`.** The number of places after the decimal to round to for custom number fields. + + From {{ integration.display_name }}'s documentation: + + > 0 is integer values, 1 rounds to the nearest tenth, and so on. Must be between 0 and 6, inclusive. For percentage format, this may be unintuitive, as a value of 0.25 has a precision of 0, while a value of 0.251 has a precision of 1. This is due to 0.25 being displayed as 25%. The identifier format will always have a precision of 0. + + - name: "resource_subtype" + type: "string" + description: | + The type of the custom field. Possible values are: + + - `text` + - `enum` + - `number` + + - name: "resource_type" + type: "string" + description: "The base type of the resource." + + - name: "text_value" + type: "string" + description: "**Applicable only when `resource_subtype: text`.** The value of a custom text field." + + - name: "type" + type: "string" + description: "**Deprecated by {{ integration.display_name }}.** Use `resource_subtype` instead." + - name: "due_at" type: "date-time" description: "The date and time on which the task is due. This will be `null` if the task has no due time."