-
Notifications
You must be signed in to change notification settings - Fork 40.6k
Errors not Included in OpenAPI #69014
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
Comments
/sig api-machinery |
Hi Luke, could you be more specific on which APIs are having the problem and what errors are you expecting? To my knowledge there was a documentation bug that our openapi spec didn't reflect the 202 path in API server delete handler. The bug was fixed in 1.12 #63418 There is also a known issue that our openapi v2 spec cannot express And I'm assuming you're using the openapi spec. The swagger 1.2 specs are deprecated and meant to be removed |
I think the convention here: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#response-status-kind
Should be coded into the openapi spec. This is so that it can be consumed programmatically. |
I see. There is a TODO in apiserver installer about adding errors to the route documentation kubernetes/staging/src/k8s.io/apiserver/pkg/endpoints/installer.go Lines 462 to 476 in c4b4025
Note that currently the openapi spec has the 401 Unauthorized path documented (no response schema), which is added in kubernetes/staging/src/k8s.io/apiserver/pkg/server/config.go Lines 382 to 388 in c4b4025
I'd like to work on the TODO. One concern is although I think it's right to document the possible paths, this change will increase the size of the openapi spec by a fair amount. Do we have any scalability/performance concern around that? @mbohlool (We may also check if CI gives any signal when a PR is submitted) /assign |
Also the api convention doc didn't reflect the 202 Accepted code that apiserver may response with. I will try update the doc when I get a chance: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#http-status-codes |
Issues go stale after 90d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
Stale issues rot after 30d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
Rotten issues close after 30d of inactivity. Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
@fejta-bot: Closing this issue. 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. |
/reopen |
@roycaihw: Reopened this issue. 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. |
Issues go stale after 90d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
/remove-lifecycle stale |
/remove-lifecycle stale |
Issues go stale after 90d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
I think this still needs doing. /remove-lifecycle stale |
Issues go stale after 90d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
Stale issues rot after 30d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
I think this still needs doing. /remove-lifecycle stale |
Er, maybe it's: /remove-lifecycle rotten |
Issues go stale after 90d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
I don't believe that this has been fixed. /remove-lifecycle stale |
Issues go stale after 90d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
I'm tired of fighting the bot. I think this is "wontfix".
…On 10/18/20, fejta-bot ***@***.***> wrote:
Issues go stale after 90d of inactivity.
Mark the issue as fresh with `/remove-lifecycle stale`.
Stale issues rot after an additional 30d of inactivity and eventually
close.
If this issue is safe to close now please do so with `/close`.
Send feedback to sig-testing, kubernetes/test-infra and/or
[fejta](https://github.com/fejta).
/lifecycle stale
--
You are receiving this because you commented.
Reply to this email directly or view it on GitHub:
#69014 (comment)
--
Adam Novak (He/Him)
Senior Software Engineer
Computational Genomics Lab
UC Santa Cruz Genomics Institute
"Revealing life’s code."
Personal Feedback: https://forms.gle/UXZhZc123knF65Dw5
|
Stale issues rot after 30d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
Rotten issues close after 30d of inactivity. Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
@fejta-bot: Closing this issue. 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. |
Is this a BUG REPORT or FEATURE REQUEST?:
/kind bug
What happened:
I am using the swagger api and it doesn't include the possible errors that can be returned from the api. I am generating a client, so the possible errors are necessary.
What you expected to happen:
Swagger allows all possible return codes to be used. These should be included in the swagger api.
Environment:
kubectl version
):Client Version: version.Info{Major:"1", Minor:"11", GitVersion:"v1.11.2", GitCommit:"bb9ffb1654d4a729bb4cec18ff088eacc153c239", GitTreeState:"clean", BuildDate:"2018-08-08T16:31:10Z", GoVersion:"go1.10.3", Compiler:"gc", Platform:"darwin/amd64"}
Server Version: version.Info{Major:"1", Minor:"10", GitVersion:"v1.10.6", GitCommit:"a21fdbd78dde8f5447f5f6c331f7eb6f80bd684e", GitTreeState:"clean", BuildDate:"2018-07-26T10:04:08Z", GoVersion:"go1.9.3", Compiler:"gc", Platform:"linux/amd64"}
The text was updated successfully, but these errors were encountered: