@openshift-migration-advisor/agent-sdk

v0.20.3

Published

5 days ago

OpenAPI client for @openshift-migration-advisor/agent-sdk

0High
0Medium
0Low

@openshift-migration-advisor/[email protected]

A TypeScript SDK client for the raw.githubusercontent.com API.

Usage

First, install the SDK from npm.

npm install @openshift-migration-advisor/agent-sdk --save

Next, try it out.

import {
  Configuration,
  DefaultApi,
} from '@openshift-migration-advisor/agent-sdk';
import type { BatchUpdateVMExclusionRequest } from '@openshift-migration-advisor/agent-sdk';

async function example() {
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
  const api = new DefaultApi();

  const body = {
    // BatchUpdateExclusionRequest
    batchUpdateExclusionRequest: ...,
  } satisfies BatchUpdateVMExclusionRequest;

  try {
    const data = await api.batchUpdateVMExclusion(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://raw.githubusercontent.com/api/v1

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- DefaultApi | batchUpdateVMExclusion | POST /vms/batch-update-exclusion | Batch update VM exclusion status DefaultApi | createGroup | POST /groups | Create a new group DefaultApi | deleteCredentials | DELETE /credentials | Delete stored credentials DefaultApi | deleteForecasterRun | DELETE /forecaster/runs/{id} | Delete a benchmark run DefaultApi | deleteGroup | DELETE /groups/{id} | Delete group DefaultApi | deleteLabelGlobally | DELETE /vms/labels/{label} | Delete label from all VMs DefaultApi | exportInventory | GET /export | Export VM inventory and migration planning data DefaultApi | getAgentStatus | GET /agent | Get agent status DefaultApi | getApplications | GET /applications | List detected applications running on VMs DefaultApi | getClusterUtilization | GET /clusters/{cluster_id}/utilization | Get latest cluster utilization by cluster ID DefaultApi | getCollectorStatus | GET /collector | Get collector status DefaultApi | getCredentialCapabilities | GET /credentials/capabilities | Check vSphere operation capabilities DefaultApi | getCredentials | GET /credentials | Get stored credential status DefaultApi | getForecasterDatastores | POST /forecaster/datastores | List available datastores DefaultApi | getForecasterRuns | GET /forecaster/runs | List benchmark runs DefaultApi | getForecasterStats | GET /forecaster/stats | Get throughput statistics DefaultApi | getForecasterStatus | GET /forecaster | Poll forecaster status DefaultApi | getGroup | GET /groups/{id} | Get group by ID with its VMs DefaultApi | getInspectorStatus | GET /inspector | Get inspector status DefaultApi | getInspectorVddkStatus | GET /inspector/vddk | Get VDDK status DefaultApi | getInventory | GET /inventory | Get collected inventory DefaultApi | getRightsizingReport | GET /rightsizing/{report_id} | Get a specific rightsizing report with full VM metrics DefaultApi | getRightsizingReportCluster | GET /rightsizing/{report_id}/clusters/{cluster_id} | Get utilization for a specific cluster from a specific report DefaultApi | getVM | GET /vms/{id} | Get details about a vm DefaultApi | getVMLabels | GET /vms/labels | Get all distinct labels in use across VMs DefaultApi | getVMUtilization | GET /vms/{id}/utilization | Get utilization breakdown for a specific VM DefaultApi | getVMs | GET /vms | Get list of VMs with filtering and pagination DefaultApi | getVMsFilterOptions | GET /vms/filter-options | Get distinct filter option values for VMs DefaultApi | getVersion | GET /version | Get agent version information DefaultApi | listGroups | GET /groups | List all groups DefaultApi | listRightsizingReportClusters | GET /rightsizing/{report_id}/clusters | Get cluster-level utilization aggregates for a specific report DefaultApi | listRightsizingReports | GET /rightsizing | List all rightsizing reports DefaultApi | postForecasterPairCapabilities | POST /forecaster/capabilities | Compute pair capabilities DefaultApi | putCredentials | PUT /credentials | Store vCenter credentials DefaultApi | putForecasterCredentials | PUT /forecaster/credentials | Verify vCenter credentials and permissions DefaultApi | putInspectorVddk | PUT /inspector/vddk | Upload VDDK tarball DefaultApi | removeVMFromInspection | DELETE /vms/{id}/inspection | Remove VirtualMachine from inspection queue DefaultApi | setAgentMode | POST /agent | Change agent mode DefaultApi | startCollector | POST /collector | Start inventory collection DefaultApi | startForecaster | POST /forecaster | Start benchmark DefaultApi | startInspection | POST /inspector | Start inspection for VMs DefaultApi | stopCollector | DELETE /collector | Stop collection DefaultApi | stopForecaster | DELETE /forecaster | Cancel benchmark DefaultApi | stopForecasterPair | DELETE /forecaster/pairs/{name} | Cancel a single pair DefaultApi | stopInspection | DELETE /inspector | Stop inspector entirely DefaultApi | triggerRightsizingCollection | POST /rightsizing | Trigger rightsizing metrics collection DefaultApi | updateGroup | PATCH /groups/{id} | Update group DefaultApi | updateLabelVMs | PATCH /vms/labels/{label} | Modify label VM membership (add/remove label to/from VMs) DefaultApi | updateVM | PATCH /vms/{id} | Update VM properties DefaultApi | validateInspectorCredentials | POST /inspector/credentials | Validate vCenter credentials for inspector

Models

Authorization

Endpoints do not require authorization.

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

API version: v1
Package version: 0.20.3
Generator version: 7.25.0-SNAPSHOT
Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme