Errors not Included in OpenAPI #69014

lswith · 2018-09-24T23:51:46Z

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:

Kubernetes version (use 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:

lswith · 2018-09-24T23:52:14Z

/sig api-machinery

lswith · 2018-09-24T23:53:05Z

@roycaihw @mbohlool

roycaihw · 2018-09-25T21:59:37Z

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 OneOf concept for our API that may return different object for same path (e.g. API server may respond with the delete object or Status on a DELETE 200 #59501)

And I'm assuming you're using the openapi spec. The swagger 1.2 specs are deprecated and meant to be removed

lswith · 2018-09-28T00:55:52Z

I think the convention here: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#response-status-kind

Kubernetes will always return the Status kind from any API endpoint when an error occurs.

Should be coded into the openapi spec. This is so that it can be consumed programmatically.

roycaihw · 2018-09-28T20:44:24Z

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

    
           // TODO: Add status documentation using Returns() 
        
           // Errors (see api/errors/errors.go as well as go-restful router): 
        
           // http.StatusNotFound, http.StatusMethodNotAllowed, 
        
           // http.StatusUnsupportedMediaType, http.StatusNotAcceptable, 
        
           // http.StatusBadRequest, http.StatusUnauthorized, http.StatusForbidden, 
        
           // http.StatusRequestTimeout, http.StatusConflict, http.StatusPreconditionFailed, 
        
           // http.StatusUnprocessableEntity, http.StatusInternalServerError, 
        
           // http.StatusServiceUnavailable 
        
           // and api error codes 
        
           // Note that if we specify a versioned Status object here, we may need to 
        
           // create one for the tests, also 
        
           // Success: 
        
           // http.StatusOK, http.StatusCreated, http.StatusAccepted, http.StatusNoContent 
        
           // 
        
           // test/integration/auth_test.go is currently the most comprehensive status code test

Note that currently the openapi spec has the 401 Unauthorized path documented (no response schema), which is added in OpenAPIConfig.CommonResponses:

kubernetes/staging/src/k8s.io/apiserver/pkg/server/config.go

Lines 382 to 388 in c4b4025

    
           if _, exists := c.OpenAPIConfig.CommonResponses[http.StatusUnauthorized]; !exists { 
        
           	c.OpenAPIConfig.CommonResponses[http.StatusUnauthorized] = spec.Response{ 
        
           		ResponseProps: spec.ResponseProps{ 
        
           			Description: "Unauthorized", 
        
           		}, 
        
           	} 
        
           }

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

roycaihw · 2018-09-28T20:51:43Z

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

fejta-bot · 2018-12-27T21:21:23Z

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.
/lifecycle stale

fejta-bot · 2019-01-26T22:05:41Z

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

fejta-bot · 2019-02-25T22:24:29Z

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

k8s-ci-robot · 2019-02-25T22:24:36Z

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

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.

roycaihw · 2019-03-06T00:35:16Z

/reopen
/remove-lifecycle rotten

k8s-ci-robot · 2019-03-06T00:35:17Z

@roycaihw: Reopened this issue.

In response to this:

/reopen
/remove-lifecycle rotten

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.

fejta-bot · 2019-06-04T01:33:14Z

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.
/lifecycle stale

roycaihw · 2019-06-18T18:19:53Z

/remove-lifecycle stale

roycaihw · 2019-09-18T20:53:06Z

/remove-lifecycle stale

fejta-bot · 2019-12-17T21:42:56Z

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.
/lifecycle stale

adamnovak · 2019-12-19T18:40:41Z

I think this still needs doing.

/remove-lifecycle stale

fejta-bot · 2020-03-18T19:38:38Z

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.
/lifecycle stale

fejta-bot · 2020-04-17T20:20:19Z

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

adamnovak · 2020-04-17T20:37:57Z

I think this still needs doing.

/remove-lifecycle stale

adamnovak · 2020-04-17T20:38:20Z

Er, maybe it's:

/remove-lifecycle rotten

fejta-bot · 2020-07-16T21:28:04Z

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.
/lifecycle stale

adamnovak · 2020-07-20T16:46:39Z

I don't believe that this has been fixed.

/remove-lifecycle stale

fejta-bot · 2020-10-18T17:02:45Z

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.
/lifecycle stale

adamnovak · 2020-10-20T18:05:53Z

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

fejta-bot · 2020-11-19T18:33:22Z

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

fejta-bot · 2020-12-19T19:16:58Z

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

k8s-ci-robot · 2020-12-19T19:17:11Z

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

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.

k8s-ci-robot added kind/bug Categorizes issue or PR as related to a bug. needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Sep 24, 2018

k8s-ci-robot added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. and removed needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Sep 24, 2018

k8s-ci-robot assigned roycaihw Sep 28, 2018

lswith mentioned this issue Sep 29, 2018

handling Kubernetes Errors obmarg/kazan#51

Open

roycaihw mentioned this issue Oct 8, 2018

Allow using top-level Responses Definitions field in openapi v2 kubernetes/kube-openapi#105

Merged

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 27, 2018

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jan 26, 2019

k8s-ci-robot closed this as completed Feb 25, 2019

k8s-ci-robot reopened this Mar 6, 2019

k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Mar 6, 2019

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 4, 2019

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 18, 2019

roycaihw mentioned this issue Jul 11, 2019

which http code may lead to apiserver to create pod #79957

Closed

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 16, 2019

roycaihw mentioned this issue Sep 18, 2019

How to deal with an expired continue token dring list_namespaced_job and silimar calls is not documented kubernetes-client/python#953

Closed

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 18, 2019

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 17, 2019

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 19, 2019

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 18, 2020

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Apr 17, 2020

k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Apr 17, 2020

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 16, 2020

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 20, 2020

roycaihw mentioned this issue Sep 14, 2020

Not all return codes are documented kubernetes-client/python#1245

Closed

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 18, 2020

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Nov 19, 2020

k8s-ci-robot closed this as completed Dec 19, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Errors not Included in OpenAPI #69014

Errors not Included in OpenAPI #69014

Errors not Included in OpenAPI #69014

Errors not Included in OpenAPI #69014

Comments