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

Force all secret properties to be string, required and non-nullable #2326

Open
travjenkins opened this issue Feb 3, 2025 · 0 comments
Open
Labels
enhancement New feature or request

Comments

@travjenkins
Copy link
Member

travjenkins commented Feb 3, 2025

Request

To make editing entities in the UI better we would like to narrow the scope of what we support for secret fields.

Non-Nullable

We do not want the field to be able to be null as that makes clearing the field during edit complex for the UI and UX. What we do not want to support:

"foo": {
  "title": "Example nullable string secret",
  "description": "",
  "type": [
    "string",
    "null"
  ],
  "secret": true
}

String

We'd like to keep the type to just string. This can be changed later if we deem it necessary. However, right now a secret number would not render correctly.

Required

I am still not 100% sure about this one... but probably makes most sense for anything that is a password - or password like - should always be there.

This is helpful for the UI because during edit we clear out all sops encrypted fields and if they are not required and user might not notice they did not fill that fields out again during edit.

@travjenkins travjenkins added the enhancement New feature or request label Feb 3, 2025
@travjenkins travjenkins changed the title Force all secret properties to be required and non-nullable Force all secret properties to be string, required and non-nullable Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant