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

Fixes #27899 - Allow schema building for custom options #316

Merged

Conversation

ofedoren
Copy link
Member

No description provided.

@shiramax
Copy link
Contributor

@ofedoren what do you think about this help:

Option details:
Following parameters accept format defined by its schema (bold are required, parameter_name and value must be a string):

--typed-parameters "name=<parameter_name>,value=<parameter_value>,parameter_type=[string || int ...]] "

@ofedoren
Copy link
Member Author

@shiramax, thanks for your effort to make UX better!

I agree that it will help users, but what if we go further and show something even more verbose?

  Following parameters accept format defined by its schema (bold are required; <> contain acceptable type; [] contain acceptable value):

  --typed-parameters  "name=<string>\,value=<string>\,parameter_type=[string|boolean|integer|real|array|hash|yaml|json]\,hidden_value=[true|false|1|0], ... "

Please tell me what do you think about that :)

@shiramax
Copy link
Contributor

@ofedoren , looks good !

@ofedoren ofedoren force-pushed the feat-27899-schema-for-custom-opts branch from 8b0bdc6 to 0a1edb0 Compare October 11, 2019 13:24
@ofedoren
Copy link
Member Author

@shiramax, updated :) I've added a way to show mentioned help, so when you have time please check it (with theforeman/hammer-cli-foreman#448 for example) and tell me if it's better.

Copy link
Member

@mbacovsky mbacovsky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the detailed description, very useful.
Thanks @ofedoren, @shiramax

@mbacovsky mbacovsky merged commit 9ec22e6 into theforeman:master Oct 25, 2019
ofedoren added a commit that referenced this pull request Oct 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants