-
Notifications
You must be signed in to change notification settings - Fork 163
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
Ensure required property is present in generated documentation #602
base: master
Are you sure you want to change the base?
Ensure required property is present in generated documentation #602
Conversation
Not seeing any differences after this change? None of the properties look like they're required by themselves anyways Flattened some resource schemas in PRs linked in this issue that should have been better examples for testing, but not seeing changes from this for those previously unflattened schemas either |
You can find an example here that I ran with this PR's branch. The fields are required true now instead false. |
I'd argue only |
For reference, the official resource docs use |
I agree that putting Conditional is the right way, but flattening will not be enough for that logic. |
Issue #, if available:
Description of changes:
Whenever the required property was part of a combiner (e.g.
anyOf
) in a resource schema, the generated documentation would skip it. This change will ensure that required fields will be flattened and then used by the documentation generator.You can check a documentation example here where the required property is ignored.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.