-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
🌱 Improve open API docs #6878
🌱 Improve open API docs #6878
Conversation
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.
Nice!
Just a few nits, nothing major
lgtm pending squash from my side |
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.
/lgtm
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.
/approve
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: vincepri The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/cherry-pick release-1.2 |
@sbueringer: once the present PR merges, I will cherry-pick it on top of release-1.2 in a new PR and assign it to you. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
/hold |
bf5ed6f
to
be103c1
Compare
/hold cancel |
There it is :) /lgtm |
@sbueringer: new pull request created: #6883 In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
Required: true, | ||
Name: "name", | ||
In: "path", | ||
Description: "The handler name. Handlers for the same hook within a single external component implementing Runtime Extensions must have different names", |
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.
Looks like this statement implies that if handlers do not serve the same hook they can share the same name but any two handlers of a single external component irrespective of if they serve the same hook should have different names. If not there will be a collision in the registry.
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.
If not there will be a collision in the registry.
I think the discovery would already fail before we add anything to the registry as we validate that the Names have to be unique there.
Independent of that. I think you're right. Can you open a PR to improve this description?
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 the discovery would already fail before we add anything to the registry as we validate that the Names have to be unique there.
You are right. It would not pass the discovery response validation.
Independent of that. I think you're right. Can you open a PR to improve this description?
PR: #6896
What this PR does / why we need it:
Improves open API specification docs for Runtime Hooks