kubevirt-api

kubevirt OpenAPI automation for TypeScript types

Documentation

Auto generated docs for KubeVirt API Docs

Auto generated using OpenAPI sources:

• Openshift Console - https://github.com/openshift/console
• Kubevirt - https://github.com/kubevirt/kubevirt
• Kubernetes - https://github.com/kubernetes/kubernetes
• Containerized data importer (CDI) - https://github.com/kubevirt/containerized-data-importer

kubevirt API reference:
http://kubevirt.io/api-reference/master/index.html

Usage

# Add to your project
yarn add @kubevirt-ui/kubevirt-api

// Import examples
import { IoK8sApiCoreV1Pod } from '@kubevirt-ui/kubevirt-api/kubernetes'
import { V1VirtualMachine } from '@kubevirt-ui/kubevirt-api/kubevirt'
import { V1beta1DataVolume } from '@kubevirt-ui/kubevirt-api/containerized-data-importer'

import { VirtualMachineModelGroupVersionKind } from '@kubevirt-ui/kubevirt-api/console/models'
import VirtualMachineModel from '@kubevirt-ui/kubevirt-api/console/models/VirtualMachineModel'

Download swagger CLI tools

yarn

Generate TypeScript types

yarn generate

Run linter

yarn lint

Update upstream versions

Edit the versions in ./scripts/generate.sh

Each new versions may need different patchs, look for errors while running the generate script after each update.