mirror of
https://github.com/aljazceru/kata-containers.git
synced 2026-01-02 22:14:27 +01:00
1a7539c1f5
update api based latest master. Signed-off-by: Jose Carlos Venegas Munoz <jose.carlos.venegas.munoz@intel.com>
79 lines
3.1 KiB
Markdown
79 lines
3.1 KiB
Markdown
# Go API client for openapi
|
|
|
|
Local HTTP based API for managing and inspecting a cloud-hypervisor virtual machine.
|
|
|
|
## Overview
|
|
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
|
|
|
|
- API version: 0.3.0
|
|
- Package version: 1.0.0
|
|
- Build package: org.openapitools.codegen.languages.GoClientCodegen
|
|
|
|
## Installation
|
|
|
|
Install the following dependencies:
|
|
|
|
```shell
|
|
go get github.com/stretchr/testify/assert
|
|
go get golang.org/x/oauth2
|
|
go get golang.org/x/net/context
|
|
go get github.com/antihax/optional
|
|
```
|
|
|
|
Put the package under your project folder and add the following in import:
|
|
|
|
```golang
|
|
import "./openapi"
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://localhost/api/v1*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*DefaultApi* | [**BootVM**](docs/DefaultApi.md#bootvm) | **Put** /vm.boot | Boot the previously created VM instance.
|
|
*DefaultApi* | [**CreateVM**](docs/DefaultApi.md#createvm) | **Put** /vm.create | Create the cloud-hypervisor Virtual Machine (VM) instance. The instance is not booted, only created.
|
|
*DefaultApi* | [**DeleteVM**](docs/DefaultApi.md#deletevm) | **Put** /vm.delete | Delete the cloud-hypervisor Virtual Machine (VM) instance.
|
|
*DefaultApi* | [**PauseVM**](docs/DefaultApi.md#pausevm) | **Put** /vm.pause | Pause a previously booted VM instance.
|
|
*DefaultApi* | [**RebootVM**](docs/DefaultApi.md#rebootvm) | **Put** /vm.reboot | Reboot the VM instance.
|
|
*DefaultApi* | [**ResumeVM**](docs/DefaultApi.md#resumevm) | **Put** /vm.resume | Resume a previously paused VM instance.
|
|
*DefaultApi* | [**ShutdownVM**](docs/DefaultApi.md#shutdownvm) | **Put** /vm.shutdown | Shut the VM instance down.
|
|
*DefaultApi* | [**ShutdownVMM**](docs/DefaultApi.md#shutdownvmm) | **Put** /vmm.shutdown | Shuts the cloud-hypervisor VMM.
|
|
*DefaultApi* | [**VmInfoGet**](docs/DefaultApi.md#vminfoget) | **Get** /vm.info | Returns general information about the cloud-hypervisor Virtual Machine (VM) instance.
|
|
*DefaultApi* | [**VmResizePut**](docs/DefaultApi.md#vmresizeput) | **Put** /vm.resize | Resize the VM
|
|
*DefaultApi* | [**VmmPingGet**](docs/DefaultApi.md#vmmpingget) | **Get** /vmm.ping | Ping the VMM to check for API server availability
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [CmdLineConfig](docs/CmdLineConfig.md)
|
|
- [ConsoleConfig](docs/ConsoleConfig.md)
|
|
- [CpusConfig](docs/CpusConfig.md)
|
|
- [DeviceConfig](docs/DeviceConfig.md)
|
|
- [DiskConfig](docs/DiskConfig.md)
|
|
- [FsConfig](docs/FsConfig.md)
|
|
- [KernelConfig](docs/KernelConfig.md)
|
|
- [MemoryConfig](docs/MemoryConfig.md)
|
|
- [NetConfig](docs/NetConfig.md)
|
|
- [PmemConfig](docs/PmemConfig.md)
|
|
- [RngConfig](docs/RngConfig.md)
|
|
- [VhostUserBlkConfig](docs/VhostUserBlkConfig.md)
|
|
- [VhostUserNetConfig](docs/VhostUserNetConfig.md)
|
|
- [VmConfig](docs/VmConfig.md)
|
|
- [VmInfo](docs/VmInfo.md)
|
|
- [VmResize](docs/VmResize.md)
|
|
- [VmmPingResponse](docs/VmmPingResponse.md)
|
|
- [VsockConfig](docs/VsockConfig.md)
|
|
|
|
|
|
## Documentation For Authorization
|
|
|
|
Endpoints do not require authorization.
|
|
|
|
|
|
## Author
|
|
|
|
|
|
|