@skillvl/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @skillvl/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ClusterApi | clusterResourcesGet | GET /cluster/resources/{virtualroom} | Resources ClusterApi | clusterVirtualroomInfoGet | GET /cluster/virtualroom/{virtualroom}/info | Virtualroom Vm Infos ClusterApi | clusterVmInfoGet | GET /cluster/vm/{vm}/info | Vm Info ClusterApi | clusterVmShutdownPost | POST /cluster/vm/{vm}/shutdown | Vm Shutdown ClusterApi | clusterVmStartPost | POST /cluster/vm/{vm}/start | Vm Start IsoApi | isoGet | GET /iso/{iso_id} | Get Iso IsoApi | isoList | GET /iso/ | Get Iso List VirtualroomApi | virtualroomCreate | POST /virtualroom/ | Create Virtualroom VirtualroomApi | virtualroomDelete | DELETE /virtualroom/{virtualroom} | Delete Virtualroom VirtualroomApi | virtualroomGet | GET /virtualroom/{virtualroom} | Get Virtualroom VirtualroomApi | virtualroomList | GET /virtualroom/ | Get Virtualroom List VirtualroomApi | virtualroomMetadataGet | GET /virtualroom/{virtualroom}/metadata | Get Virtualroom Metadata VirtualroomApi | virtualroomTemplateCreate | POST /virtualroom/template | Create Template VirtualroomApi | virtualroomTemplateDelete | DELETE /virtualroom/template/{virtualroomtemplate} | Delete Template VirtualroomApi | virtualroomTemplateGet | GET /virtualroom/template/{virtualroomtemplate} | Get Template VirtualroomApi | virtualroomTemplateList | GET /virtualroom/template | Get Template List VirtualroomApi | virtualroomTemplateMetadataGet | GET /virtualroom/template/{virtualroomtemplate}/metadata | Get Virtualroomtemplate Metadata VirtualroomApi | virtualroomTemplatePut | PUT /virtualroom/template/{virtualroomtemplate} | Put Template VncApi | vncVncProxyGet | GET /vnc/vnc-proxy/{node}/{vm} | Vnc Proxy

Documentation For Models

• EnumAudioDevice
• EnumAudioDriver
• EnumCPUType
• EnumDiskCache
• EnumDiskMedia
• EnumISOOSTypes
• EnumNetModel
• EnumSpiceVideoStreaming
• EnumVGAType
• EnumVMArch
• EnumVMBios
• EnumVMMachine
• EnumVMOSType
• EnumVMSCSIHW
• EnumVirtualRoomState
• HTTPValidationError
• HardwareResourceModel
• HardwareResources
• ISO
• IdeDisk
• JobCreatedResponseModel
• JobCreatedResponseTrackingModel
• LocationInner
• Metadata
• MetadataCreate
• Nic
• PermissionTicketModel
• ResourceLimitExceededModel
• ResourceLimitMaintainedModel
• Response401VirtualroomMetadataGet
• SataDisk
• ScsiDisk
• StringReasonModel
• Switch
• SwitchCreate
• User
• VM
• VMAudio
• VMAudioCreate
• VMBootOrder
• VMConfig
• VMCreate
• VMIdeDisk
• VMIdeDiskCreate
• VMNic
• VMNicCreate
• VMSataDisk
• VMSataDiskCreate
• VMScsiDisk
• VMScsiDiskCreate
• VMVirtioDisk
• VMVirtioDiskCreate
• VNCProxyData
• ValidationError
• VirtioDisk
• VirtualRoom
• VirtualRoomCreate

Documentation For Authorization

Authentication schemes defined for the API:

JWTBearer

• Type: Bearer authentication (JWT)