@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/planner-sdk --save

Next, try it out.

import {
  Configuration,
  AccountApi,
} from '@openshift-migration-advisor/planner-sdk';
import type { CreateGroupRequest } from '@openshift-migration-advisor/planner-sdk';

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

  const body = {
    // GroupCreate
    groupCreate: ...,
  } satisfies CreateGroupRequest;

  try {
    const data = await api.createGroup(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

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- AccountApi | createGroup | POST /api/v1/groups | AccountApi | createGroupMember | POST /api/v1/groups/{id}/members | AccountApi | deleteGroup | DELETE /api/v1/groups/{id} | AccountApi | getGroup | GET /api/v1/groups/{id} | AccountApi | getIdentity | GET /api/v1/identity | AccountApi | listGroupMembers | GET /api/v1/groups/{id}/members | AccountApi | listGroups | GET /api/v1/groups | AccountApi | removeGroupMember | DELETE /api/v1/groups/{id}/members/{username} | AccountApi | updateGroup | PUT /api/v1/groups/{id} | AccountApi | updateGroupMember | PUT /api/v1/groups/{id}/members/{username} | AssessmentApi | calculateAssessmentClusterRequirements | POST /api/v1/assessments/{id}/cluster-requirements | AssessmentApi | calculateMigrationComplexity | POST /api/v1/assessments/{id}/complexity-estimation | AssessmentApi | calculateMigrationEstimation | POST /api/v1/assessments/{id}/migration-estimation | AssessmentApi | calculateMigrationEstimationByComplexity | POST /api/v1/assessments/{id}/migration-estimation/by-complexity | AssessmentApi | createAssessment | POST /api/v1/assessments | AssessmentApi | deleteAssessment | DELETE /api/v1/assessments/{id} | AssessmentApi | getAssessment | GET /api/v1/assessments/{id} | AssessmentApi | getAssessmentClusterRequirementsStoredInput | GET /api/v1/assessments/{id}/cluster-requirements/stored-input | AssessmentApi | listAssessments | GET /api/v1/assessments | AssessmentApi | shareAssessment | POST /api/v1/assessments/{id}/share | AssessmentApi | unshareAssessment | DELETE /api/v1/assessments/{id}/share | AssessmentApi | updateAssessment | PUT /api/v1/assessments/{id} | HealthApi | health | GET /health | ImageApi | getSourceDownloadURL | GET /api/v1/sources/{id}/image-url | ImageApi | headImage | HEAD /api/v1/sources/{id}/image | InfoApi | getInfo | GET /api/v1/info | JobApi | cancelJob | DELETE /api/v1/assessments/jobs/{id} | JobApi | createRVToolsAssessment | POST /api/v1/assessments/rvtools | JobApi | getJob | GET /api/v1/assessments/jobs/{id} | PartnerApi | cancelPartnerRequest | DELETE /api/v1/partners/requests/{id} | PartnerApi | createPartnerRequest | POST /api/v1/partners/{id}/request | PartnerApi | getPartner | GET /api/v1/partners/{id} | PartnerApi | leavePartner | DELETE /api/v1/partners/{id} | PartnerApi | listCustomers | GET /api/v1/customers | PartnerApi | listPartnerRequests | GET /api/v1/partners/requests | PartnerApi | listPartners | GET /api/v1/partners | PartnerApi | removeCustomer | DELETE /api/v1/customers/{username} | PartnerApi | updatePartnerRequest | PUT /api/v1/partners/requests/{id} | SourceApi | createSource | POST /api/v1/sources | SourceApi | deleteSource | DELETE /api/v1/sources/{id} | SourceApi | deleteSources | DELETE /api/v1/sources | SourceApi | getSource | GET /api/v1/sources/{id} | SourceApi | listSources | GET /api/v1/sources | SourceApi | updateInventory | PUT /api/v1/sources/{id}/inventory | SourceApi | updateSource | PUT /api/v1/sources/{id} |

Models

• Agent
• AgentProxy
• Assessment
• AssessmentForm
• AssessmentSharing
• AssessmentUpdate
• ClusterRequirementsRequest
• ClusterRequirementsResponse
• ClusterRequirementsStoredInput
• ClusterSizing
• ComplexityDiskScoreEntry
• ComplexityOSNameEntry
• ComplexityOSScoreEntry
• Customer
• Datastore
• DiskSizeTierSummary
• DiskTypeSummary
• EstimationContext
• EstimationDetail
• Group
• GroupCreate
• GroupUpdate
• Histogram
• Host
• Identity
• Info
• Infra
• Inventory
• InventoryData
• InventoryTotals
• Ipv4Config
• Job
• JobStatus
• Label
• Member
• MemberCreate
• MemberUpdate
• MigrationComplexityRequest
• MigrationComplexityResponse
• MigrationEstimationByComplexityResponse
• MigrationEstimationRequest
• MigrationEstimationResponse
• MigrationIssue
• ModelError
• Network
• OsDiskEstimationEntry
• OsInfo
• PartnerRequest
• PartnerRequestCreate
• PartnerRequestStatus
• PartnerRequestUpdate
• PartnerSummary
• PresignedUrl
• SchemaEstimationResult
• SharingSubject
• SizingOverCommitRatio
• SizingResourceConsumption
• SizingResourceLimits
• Snapshot
• Source
• SourceCreate
• SourceInfra
• SourceUpdate
• Status
• UpdateInventory
• VCenter
• VMResourceBreakdown
• VMs
• VmNetwork

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: v1alpha1
• Package version: 0.13.0
• Generator version: 7.23.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

License

Apache 2.0