Serve OpenAPI spec by default #110
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
cncf-cla: yes
olivierlemasle
force-pushed
the
openapi
branch
from
7b064ed
to
258bf97
Compare
dgrisonnet
reviewed
Nov 22, 2022
|
I very like this approach, it is a great improvement that will remove a lot of tedious work for maintainers as I don't expect many projects to have a custom OpenAPI |
These definitions now defaults to those of custom-metrics-apiserver.
olivierlemasle
force-pushed
the
openapi
branch
from
258bf97
to
eeef1a3
Compare
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dgrisonnet, olivierlemasle 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 |
k8s-ci-robot
added
the
approved
Closed
olivierlemasle
added a commit
to olivierlemasle/keda
that referenced
this pull request
Nov 29, 2022
custom-metrics-apiserver serves OpenAPI spec by default since version [v1.25.0] (cf [PR 110]). [v1.25.0]: https://github.com/kubernetes-sigs/custom-metrics-apiserver/releases/tag/v1.25.0 [PR 110]: kubernetes-sigs/custom-metrics-apiserver#110 In Keda Metrics Server, remove generation of `adapter/generated/openapi/zz_generated.openapi.go` and use OpenAPI definitions from custom-metrics-apiserver instead. Signed-off-by: Olivier Lemasle <[email protected]>
2 tasks
olivierlemasle
added a commit
to olivierlemasle/keda
that referenced
this pull request
Nov 29, 2022
custom-metrics-apiserver serves OpenAPI spec by default since version [v1.25.0] (cf [PR 110]). [v1.25.0]: https://github.com/kubernetes-sigs/custom-metrics-apiserver/releases/tag/v1.25.0 [PR 110]: kubernetes-sigs/custom-metrics-apiserver#110 In Keda Metrics Server, remove generation of `adapter/generated/openapi/zz_generated.openapi.go` and use OpenAPI definitions from custom-metrics-apiserver instead. Signed-off-by: Olivier Lemasle <[email protected]>
zroubalik
added a commit
to kedacore/keda
that referenced
this pull request
Nov 29, 2022
* Metrics Server: use vendored OpenAPI definitions custom-metrics-apiserver serves OpenAPI spec by default since version [v1.25.0] (cf [PR 110]). [v1.25.0]: https://github.com/kubernetes-sigs/custom-metrics-apiserver/releases/tag/v1.25.0 [PR 110]: kubernetes-sigs/custom-metrics-apiserver#110 In Keda Metrics Server, remove generation of `adapter/generated/openapi/zz_generated.openapi.go` and use OpenAPI definitions from custom-metrics-apiserver instead. Signed-off-by: Olivier Lemasle <[email protected]> * Update CHANGELOG.md Co-authored-by: Zbynek Roubalik <[email protected]> Signed-off-by: Olivier Lemasle <[email protected]> Signed-off-by: Olivier Lemasle <[email protected]> Signed-off-by: Olivier Lemasle <[email protected]> Co-authored-by: Zbynek Roubalik <[email protected]>
josephangbc
pushed a commit
to josephangbc/keda
that referenced
this pull request
Dec 6, 2022
* Metrics Server: use vendored OpenAPI definitions custom-metrics-apiserver serves OpenAPI spec by default since version [v1.25.0] (cf [PR 110]). [v1.25.0]: https://github.com/kubernetes-sigs/custom-metrics-apiserver/releases/tag/v1.25.0 [PR 110]: kubernetes-sigs/custom-metrics-apiserver#110 In Keda Metrics Server, remove generation of `adapter/generated/openapi/zz_generated.openapi.go` and use OpenAPI definitions from custom-metrics-apiserver instead. Signed-off-by: Olivier Lemasle <[email protected]> * Update CHANGELOG.md Co-authored-by: Zbynek Roubalik <[email protected]> Signed-off-by: Olivier Lemasle <[email protected]> Signed-off-by: Olivier Lemasle <[email protected]> Signed-off-by: Olivier Lemasle <[email protected]> Co-authored-by: Zbynek Roubalik <[email protected]>
josephangbc
pushed a commit
to josephangbc/keda
that referenced
this pull request
Dec 6, 2022
* Metrics Server: use vendored OpenAPI definitions custom-metrics-apiserver serves OpenAPI spec by default since version [v1.25.0] (cf [PR 110]). [v1.25.0]: https://github.com/kubernetes-sigs/custom-metrics-apiserver/releases/tag/v1.25.0 [PR 110]: kubernetes-sigs/custom-metrics-apiserver#110 In Keda Metrics Server, remove generation of `adapter/generated/openapi/zz_generated.openapi.go` and use OpenAPI definitions from custom-metrics-apiserver instead. Signed-off-by: Olivier Lemasle <[email protected]> * Update CHANGELOG.md Co-authored-by: Zbynek Roubalik <[email protected]> Signed-off-by: Olivier Lemasle <[email protected]> Signed-off-by: Olivier Lemasle <[email protected]> Signed-off-by: Olivier Lemasle <[email protected]> Co-authored-by: Zbynek Roubalik <[email protected]>
Merged
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #109
This PR adds default OpenAPI definitions and settings, while keeping it customizable.
If the project using
custom-metrics-apiservercontinues to usethen nothing changes.
However, if an
OpenAPIConfigis not provided,custom-metrics-apiserverwill provide a default value, with its own generated definitions, which means that the OpenAPI spec will be served.Note 1: I have split the definitions between custom_metrics, external_metrics and "core", but it is possible to use a single generated file.
Note 2: I could have let
test-adapteruse its custom OpenAPI settings to show how to use it. But I don't think it's really necessary (documentation could be added, though).