Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove hard-coded optional/required text from connector specifications #17182

Closed
lmossman opened this issue Sep 26, 2022 · 4 comments · Fixed by #17544
Closed

Remove hard-coded optional/required text from connector specifications #17182

lmossman opened this issue Sep 26, 2022 · 4 comments · Fixed by #17544
Assignees

Comments

@lmossman
Copy link
Contributor

lmossman commented Sep 26, 2022

What

There are currently a lot of connector specifications that hard-code things like (Optional) or * on the end of field names. Here are some (non-exhaustive) examples:




  • This example is especially confusing, as the hard-coded * doesn't even align with which fields are marked as required for this connector -- so is this field actually optional or required?

title: "Service Account Key JSON (Required for cloud, optional for open-source)"

  • It is less clear how this one should be handled. Ideally we would have separate connectors/specs for cloud and for OSS, with this marked properly as optional/required in both

Why is this bad

This is bad because it is an inconsistent and unreliable way to communicate to users which fields are optional and which are required. We already have a mechanism for doing this, which is to add a field to the required section of the spec schema, e.g. here:

required:
- "domain"
- "api_key"
- "start_date"

This method of marking fields as required is what the UI uses to decide to add an Optional tag to the end of a field. So, when a field is not included in the required section, and it also has a string in the field name like (Optional), it leads to redundancy in the UI like this:
image

How

All source and destination connector specs should be audited for this issue, any such (Optional) or * text should be removed from field titles across all connector specs, and these connectors should be re-published so that they are updated in cloud.

@evantahler
Copy link
Contributor

@YowanR is this something we can get GL to help us with?

@evantahler
Copy link
Contributor

Grooming:

  • We will publish GA and Beta connectors as part of this work

@YowanR
Copy link
Contributor

YowanR commented Oct 4, 2022

Sorry, I missed this earlier. Will your team be handling this for beta/GA connectors?
Adding @lazebnyi and @YuliiaNahoha as FYI -- this is something we need to take care of going forward.

@evantahler
Copy link
Contributor

It's ok - I'll take care of it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants