-
Notifications
You must be signed in to change notification settings - Fork 14.5k
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 warning about incompleteness of OpenAPI schemas to kubernetes-api.md #49025
base: main
Are you sure you want to change the base?
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Welcome @adriankarasinski! |
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
highlighting that OpenAPI schemas are incomplete Co-authored-by: David Eads <deads2k@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks.
We don't start note callouts with "Please note"; also I think kubectl <subcommand> dry-run …
is deprecated without specifying what kind of dry run.
@@ -192,6 +192,9 @@ request headers as follows: | |||
</tbody> | |||
</table> | |||
|
|||
{{< warning >}} | |||
Please note the validation rules within OpenAPI schemas are incomplete and additional validation occurs in the code of the kube-apiserver. If precise and complete verification is required, a `kubectl apply --dry-run` runs all the applicable validation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is correct, and it's more aligned with our style guide (edited)
Please note the validation rules within OpenAPI schemas are incomplete and additional validation occurs in the code of the kube-apiserver. If precise and complete verification is required, a `kubectl apply --dry-run` runs all the applicable validation. | |
The validation rules published as part of OpenAPI schemas may not be complete, and usually aren't. | |
Additional validation occurs within the API server. If you want precise and complete verification, | |
a `kubectl apply --dry-run=server` runs all the applicable validation (and also activates admission-time | |
checks). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tim's suggestion is correct on the technical details. Thanks.
Updated kubernetes-api.md - Added short warning about possible incompleteness of OpenAPI schemas