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

[Epic] mark optional fields with (Optional) in the UI #10874

Closed
2 tasks
sherifnada opened this issue Mar 5, 2022 · 3 comments
Closed
2 tasks

[Epic] mark optional fields with (Optional) in the UI #10874

sherifnada opened this issue Mar 5, 2022 · 3 comments
Labels
area/connectors Connector related issues area/frontend Related to the Airbyte webapp autoteam needs-triage type/enhancement New feature or request

Comments

@sherifnada
Copy link
Contributor

Tell us about the problem you're trying to solve

In the UI today it's unclear which fields are optional and which are required. We put an asterisk * in front of required fields, but that's not visually sufficient to inform the user which fields are optional. We would like a stronger visual queue indicating whether a field is optional.

Describe the solution you’d like

  • In the UI, append (Optional) after the title property of every optional field if it's optional. This should also handle recursive parameters e.g: if parameters are nested in the connector's spec, the same rules should apply to them.
  • Adjust all existing connector specs which may already have (Optional) in the property titles, removing any (Optional) text, since the UI will be handling this automatically now. It may be acceptable in the meantime to have the UI first check if (optional) (case insensitive) exists in the param name to decide whether to append (Optional) to decouple the backend and frontend changes.

Describe the alternative you’ve considered or used

  1. Doing this in every connector's spec. it's tedious and error prone
  2. live in confusion
@sherifnada sherifnada added type/enhancement New feature or request area/frontend area/connectors Connector related issues needs-triage labels Mar 5, 2022
@octavia-squidington-iii
Copy link
Collaborator

cc @airbytehq/frontend

@krishnaglick
Copy link
Contributor

Quoting Tim here, doing this in the frontend shouldn't be too difficult.

@edmundito
Copy link
Contributor

Replaced by #12204

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/frontend Related to the Airbyte webapp autoteam needs-triage type/enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants