Source Jira: change wording for description of array fields

[alafanechere]

This description for the array fields can be misleading for users:

Comma-separated list of Jira project keys to replicate data for. (e.g. PROJ1, PROJ2)

Some are filling this field like this:

But it should be filled like this:

I received the feedback from this slack conversation:

Hi! Got the exact same issue a while ago. It turned out that I was misled by the text in the config : “Projects - Comma-separated list of Jira project keys to replicate data for. (e.g. PROJ1, PROJ2)“.
What works is entering the keys of the projects, and validating them one by one, something like this. With commas, it fails

I'm suggesting removing "comma-separated" from the description, but feel free to suggest better wording!

[alafanechere]

@misteryeo I'm curious if we have a common way of describing array fields on other connectors and if it is a kind of feedback you already got.

[misteryeo]

@alafanechere haven't seen this feedback come up but curious to dig into the behavior here.

How does the field recognize that you're entering different items in the array? What triggers this separation - is it by pressing the space bar or by separating the different items using a comma?

[misteryeo]

I just came across this in our Google Ads source and I'm not seeing the UI resolve the different items separated by commas:

[marcosmarxm]

I just came across this in our Google Ads source and I'm not seeing the UI resolve the different items separated by commas:

This is because this field is a string and the connector code map to a list.

airbyte/airbyte-integrations/connectors/source-google-ads/source_google_ads/spec.json

Lines 52 to 58 in 754452c

	"customer_id": {
	"title": "Customer ID(s)",
	"type": "string",
	"description": "Comma separated list of (client) customer IDs. Each customer ID must be specified as a 10-digit number without dashes. More instruction on how to find this value in our <a href=\"https://docs.airbyte.com/integrations/sources/google-ads#setup-guide\">docs</a>. Metrics streams like AdGroupAdReport cannot be requested for a manager account.",
	"pattern": "^[0-9]{10}(,[0-9]{10})*$",
	"examples": ["6783948572,5839201945"],
	"order": 1

Jira connector use the array data type in the specification

airbyte/airbyte-integrations/connectors/source-jira/source_jira/spec.json

Lines 44 to 52 in 754452c

	"additional_fields": {
	"type": "array",
	"title": "Additional Fields",
	"items": {
	"type": "string"
	},
	"description": "Comma-separated list of additional fields to include in replicating issues.",
	"examples": ["Field A", "Field B"]
	},

[marcosmarxm]

@alafanechere haven't seen this feedback come up but curious to dig into the behavior here.

How does the field recognize that you're entering different items in the array? What triggers this separation - is it by pressing the space bar or by separating the different items using a comma?

pressing enter, there is an issue complaining you cann't only paste the value from the clipboard.

[misteryeo]

@timroes curious to understand your thoughts here. I feel like the UI behavior is not ideal.

There's another issue raised here about the similar challenge: #8630.

My sense is that the expected behavior here should be:

1. The item becomes defined when I use a 'comma' not a 'space'.
2. If I copy and paste a list of comma separated fields here, the commas automatically separate each individual item.

Does that resonate? I think this is a UI challenge rather than a wording challenge.

[timroes]

Usually this input fields will require a press of Enter to create an "item" in the list. There is also no hint for that in the UI while typing and no way of pasting a list already in, that will automatically be separated. Usually an input like this should offer pasting in something that will automatically be separated into tokens by a separator character. I'd say we should still improve the wording here to remove the comma-separated, but should also try to improve this UI control to allow for pasting values as well as giving better guidance. I've created #10985 to track this.

[misteryeo]

Issue was linked to Harvestr Discovery: Array Fields

[alafanechere]

/publish connector=connectors/source-jira

🕑 connectors/source-jira https://github.com/airbytehq/airbyte/actions/runs/2268678988
❌ Failed to publish connectors/source-jira
❌ Couldn't auto-bump version for connectors/source-jira

[alafanechere]

/publish connector=connectors/source-jira run-tests=false

🕑 connectors/source-jira https://github.com/airbytehq/airbyte/actions/runs/2268754863
🚀 Successfully published connectors/source-jira
🚀 Auto-bumped version for connectors/source-jira
✅ connectors/source-jira https://github.com/airbytehq/airbyte/actions/runs/2268754863