-
Notifications
You must be signed in to change notification settings - Fork 416
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
Generating OpenAPI spec (OAS) along with CRD #808
Comments
Related: kubernetes-sigs/kubebuilder#1231 |
The Kubernetes project currently lacks enough contributors to adequately respond to all issues. This bot triages un-triaged issues according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
Also, see the markers for validation: https://book.kubebuilder.io/reference/markers/crd-validation |
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues. This bot triages un-triaged issues according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle rotten |
/remove-lifecycle rotten |
The Kubernetes project currently lacks enough contributors to adequately respond to all issues. This bot triages un-triaged issues according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues. This bot triages un-triaged issues according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle rotten |
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs. This bot triages issues according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /close not-planned |
@k8s-triage-robot: Closing this issue, marking it as "Not Planned". 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-sigs/prow repository. |
/remove-lifecycle rotten |
validation might not be the only purpose for OpenAPI Spec. We need the OpenAPI Spec for generating client codes in other languages. |
Looking for suggestions.
I am generating Kubernetes CRD (Custom Resource Definition) using kubebuilder. Along with CRD, I also need to document the REST endpoints by creating OpenAPI v3 Spec (OAS) file. Is there a way to get this done using controller-gen? (I see that kubebuilder uses controller-gen to create the CRD) and it was recommended to ask the question in this space). I tried exploring +schemapatch generator but felt like it's there for a different reason.
I also want to add sample Request/Response payload and other OpenAPI details (in <>types.go file) to generate complete OAS file.
The reason I want to use types.go file as I will have just one source of truth and I don't need to manually write/edit the OAS file.
Any other way would you recommend if controller-gen is not the right tool for this.
Thanks in advance.
The text was updated successfully, but these errors were encountered: