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

Add required field to generated CLI schema #725

Closed
wants to merge 2 commits into from

Conversation

david-crespo
Copy link
Contributor

@david-crespo david-crespo commented Jul 3, 2024

Closes #724

Draft because the results seem a little weird, need to look into that. Mostly path params and parent specifiers are required, but I think there are a lot more args that are required that are not being marked as such.

# Conflicts:
#	cli/docs/cli.json
@wfchandler
Copy link
Contributor

Part of the problem is that many fields are set as required_unless in the CLI, which doesn't return true for is_required_set. There's also no way to inspect an Arg to determine if it has required_unless set, so I think we're out of luck with those.

@david-crespo
Copy link
Contributor Author

Blurg. Thanks for figuring that out. I think it would be pretty confusing to say some items are required but have it not be comprehensive. Probably worse than saying nothing. So I'm going to close this for now.

@david-crespo david-crespo deleted the cli-docs-required branch August 28, 2024 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CLI JSON schema should indicate which fields are required
2 participants