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

Enable non-go clients: Move to OpenAPI(Swagger 2.0) #53

Closed
1 task done
aronchick opened this issue Jul 22, 2016 · 6 comments
Closed
1 task done

Enable non-go clients: Move to OpenAPI(Swagger 2.0) #53

aronchick opened this issue Jul 22, 2016 · 6 comments
Assignees
Labels
sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery.
Milestone

Comments

@aronchick
Copy link
Contributor

aronchick commented Jul 22, 2016

Description

Third party orchestrators can use a clean, swagger 2.0 based interface to interact with K8s, improving the ability to build k8s clients, and letting users use tools they are familiar with, and read up to date documentation. (includes + Swagger bug fixes). This description will be fleshed out by @lavalamp.

Progress Tracker

  • Basic Swagger 2.0 discovery documents are served by 1.4 kube-apiserver.

There are many planned improvements but we will treat them as bug fixes.

(lavalamp deleted all of the checkboxes that used to be here because they don't make any sense for this feature.)

@aronchick aronchick added this to the v1.4 milestone Jul 22, 2016
@philips philips added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. and removed team/SIG-API labels Aug 3, 2016
@lavalamp lavalamp assigned mbohlool and unassigned lavalamp Aug 25, 2016
@lavalamp
Copy link
Member

@mbohlool can you link to documentation for this? (where is the swagger 2.0 spec served from, etc)

@mbohlool
Copy link
Contributor

mbohlool commented Aug 26, 2016

swagger 2.0 (aka openAPI) spec will be available at "/swagger.json" in 1.4. With the new improvement kubernetes/kubernetes#31468 (for 1.5) there will be a separate spec for each endpoint (/api/v1/swagger.json, /apis/apps/v1alpha1/swagger.json, ...). I am working on more improvements. It would be alpha in 1.4 and will be replacing old specs in future releases.

@jaredbhatti
Copy link

Will this just have updated API docs? Any other docs required?

@idvoretskyi
Copy link
Member

@lavalamp @mbohlool so, what about the docs?

k8s-github-robot pushed a commit to kubernetes/kubernetes that referenced this issue Sep 23, 2016
Automatic merge from submit-queue

Fix API Installer to generate unique Operation IDs

OperationIDs generated by api_installer.go may not be unique and that causes long auto-generated function names in swagger generated clients. This is a step toward making those IDs unique.

Reference Issue kubernetes/enhancements#53 and #13414
@mbohlool
Copy link
Contributor

mbohlool commented Nov 12, 2016

This updates swagger spec. @pwittrock is working on docs based on this new spec.

Update in 1.5: The openapi spec is now mature and I am working on a client-python based on it.

@mbohlool mbohlool changed the title Enable non-go clients: Move to Swagger 2.0 Enable non-go clients: Move to OpenAPI(Swagger 2.0) Dec 12, 2016
@mbohlool
Copy link
Contributor

We have a working non-go client. I think this issue can be closed now.

ingvagabund pushed a commit to ingvagabund/enhancements that referenced this issue Apr 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery.
Projects
None yet
Development

No branches or pull requests

7 participants