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

🌱 Improve open API docs #6878

Merged

Conversation

fabriziopandini
Copy link
Member

What this PR does / why we need it:
Improves open API specification docs for Runtime Hooks

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 8, 2022
@k8s-ci-robot k8s-ci-robot requested a review from vincepri July 8, 2022 13:22
Copy link
Member

@sbueringer sbueringer left a 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

exp/runtime/catalog/openapi.go Outdated Show resolved Hide resolved
exp/runtime/catalog/openapi.go Outdated Show resolved Hide resolved
exp/runtime/catalog/openapi.go Outdated Show resolved Hide resolved
exp/runtime/catalog/openapi.go Outdated Show resolved Hide resolved
exp/runtime/catalog/openapi.go Outdated Show resolved Hide resolved
exp/runtime/hooks/api/v1alpha1/lifecyclehooks_types.go Outdated Show resolved Hide resolved
exp/runtime/hooks/api/v1alpha1/lifecyclehooks_types.go Outdated Show resolved Hide resolved
exp/runtime/hooks/api/v1alpha1/lifecyclehooks_types.go Outdated Show resolved Hide resolved
exp/runtime/hooks/api/v1alpha1/lifecyclehooks_types.go Outdated Show resolved Hide resolved
exp/runtime/hooks/api/v1alpha1/lifecyclehooks_types.go Outdated Show resolved Hide resolved
@sbueringer
Copy link
Member

lgtm pending squash from my side

cc @killianmuldoon @ykakarap

Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 8, 2022
Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

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

/approve

@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 8, 2022
@sbueringer
Copy link
Member

/cherry-pick release-1.2

@k8s-infra-cherrypick-robot

@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:

/cherry-pick release-1.2

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.

@sbueringer sbueringer mentioned this pull request Jul 8, 2022
30 tasks
@fabriziopandini
Copy link
Member Author

/hold
for squash

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 8, 2022
@fabriziopandini fabriziopandini force-pushed the improve-open-api-docs branch from bf5ed6f to be103c1 Compare July 8, 2022 16:20
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 8, 2022
@fabriziopandini
Copy link
Member Author

/hold cancel
it needs another lgtm 😅

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 8, 2022
@sbueringer
Copy link
Member

There it is :)

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 8, 2022
@k8s-ci-robot k8s-ci-robot merged commit 29495a2 into kubernetes-sigs:main Jul 8, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.3 milestone Jul 8, 2022
@k8s-infra-cherrypick-robot

@sbueringer: new pull request created: #6883

In response to this:

/cherry-pick release-1.2

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",
Copy link
Contributor

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.

Copy link
Member

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?

Copy link
Contributor

@ykakarap ykakarap Jul 12, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants