https://github.com/yaacov/crdtoapi
Use kubernetes CRD definitions to create OpenAPI schema file
https://github.com/yaacov/crdtoapi
Last synced: 7 months ago
JSON representation
Use kubernetes CRD definitions to create OpenAPI schema file
- Host: GitHub
- URL: https://github.com/yaacov/crdtoapi
- Owner: yaacov
- License: apache-2.0
- Created: 2022-12-04T11:50:12.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-05T06:07:22.000Z (over 1 year ago)
- Last Synced: 2025-03-18T06:47:32.564Z (7 months ago)
- Language: JavaScript
- Size: 411 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.crdtoapi.md
- License: LICENSE
Awesome Lists containing this project
README
# CustomResourceDefinitions to OpensAPI
crdtoapi is a tool that creates an [OpenAPI](https://www.openapis.org/) definitions file from [kubernetes](https://kubernetes.io/) [CustomResourceDefinitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
## Usage
Use kubernetes CRD definitions to create OpenAPI schema file.
``` bash
npm install --location=global crdtoapi
# add npm bin path to your PATH, or use full
# excutable path, e.g. $(npm bin --location=global)/crdtoapi
crdtoapi --help
# create an OpenAPI file
crdtoapi -i ./examples/forklift/
# create an OpenAPI file using flags
crdtoapi -i ./examples/forklift/ -o openapi.yaml \
--title "Forklift API" \
--description "Migration toolkit for virtualization (Forklift) API definitions." \
--license "Apache-2.0" \
--apiVersion "2.4.0" \
--contactEmail "kubev2v-dev@redhat.com"
```