/topological_inventory-api-jsclient

Javascript bindings for topological_inventory-api

Primary LanguageJavaScriptMIT LicenseMIT

@manageiq/topological_inventory

@ManageiqTopologicalInventory - JavaScript client for @manageiq/topological_inventory Topological Inventory This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 0.1.0
  • Package version: 0.1.0
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @manageiq/topological_inventory --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var @ManageiqTopologicalInventory = require('@manageiq/topological_inventory');

var defaultClient = @ManageiqTopologicalInventory.ApiClient.instance;
// Configure HTTP basic authorization: UserSecurity
var UserSecurity = defaultClient.authentications['UserSecurity'];
UserSecurity.username = 'YOUR USERNAME'
UserSecurity.password = 'YOUR PASSWORD'

var api = new @ManageiqTopologicalInventory.DefaultApi()
var authentication = new @ManageiqTopologicalInventory.Authentication(); // {Authentication} Authentication attributes to create
api.createAuthentication(authentication).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://virtserver.swaggerhub.com/r/insights/platform/topological-inventory/v0.1

Class Method HTTP request Description
@ManageiqTopologicalInventory.DefaultApi createAuthentication POST /authentications Create a new Authentication
@ManageiqTopologicalInventory.DefaultApi createEndpoint POST /endpoints Create a new Endpoint
@ManageiqTopologicalInventory.DefaultApi createSource POST /sources Create a new Source
@ManageiqTopologicalInventory.DefaultApi createSourceType POST /source_types Create a new SourceType
@ManageiqTopologicalInventory.DefaultApi deleteAuthentication DELETE /authentications/{id} Delete an existing Authentication
@ManageiqTopologicalInventory.DefaultApi deleteEndpoint DELETE /endpoints/{id} Delete an existing Endpoint
@ManageiqTopologicalInventory.DefaultApi deleteSource DELETE /sources/{id} Delete an existing Source
@ManageiqTopologicalInventory.DefaultApi getDocumentation GET /openapi.json Return this API document in JSON format
@ManageiqTopologicalInventory.DefaultApi listAuthentications GET /authentications List Authentications
@ManageiqTopologicalInventory.DefaultApi listContainerGroupContainers GET /container_groups/{id}/containers List Containers for ContainerGroup
@ManageiqTopologicalInventory.DefaultApi listContainerGroups GET /container_groups List ContainerGroups
@ManageiqTopologicalInventory.DefaultApi listContainerImages GET /container_images List ContainerImages
@ManageiqTopologicalInventory.DefaultApi listContainerNodeContainerGroups GET /container_nodes/{id}/container_groups List ContainerGroups for ContainerNode
@ManageiqTopologicalInventory.DefaultApi listContainerNodes GET /container_nodes List ContainerNodes
@ManageiqTopologicalInventory.DefaultApi listContainerProjectContainerGroups GET /container_projects/{id}/container_groups List ContainerGroups for ContainerProject
@ManageiqTopologicalInventory.DefaultApi listContainerProjectContainerTemplates GET /container_projects/{id}/container_templates List ContainerTemplates for ContainerProject
@ManageiqTopologicalInventory.DefaultApi listContainerProjects GET /container_projects List ContainerProjects
@ManageiqTopologicalInventory.DefaultApi listContainerTemplates GET /container_templates List ContainerTemplates
@ManageiqTopologicalInventory.DefaultApi listContainers GET /containers List Containers
@ManageiqTopologicalInventory.DefaultApi listEndpointAuthentications GET /endpoints/{id}/authentications List Authentications for Endpoint
@ManageiqTopologicalInventory.DefaultApi listEndpoints GET /endpoints List Endpoints
@ManageiqTopologicalInventory.DefaultApi listFlavors GET /flavors List Flavors
@ManageiqTopologicalInventory.DefaultApi listOrchestrationStacks GET /orchestration_stacks List OrchestrationStacks
@ManageiqTopologicalInventory.DefaultApi listServiceInstances GET /service_instances List ServiceInstances
@ManageiqTopologicalInventory.DefaultApi listServiceOfferingIcons GET /service_offering_icons List ServiceOfferingIcons
@ManageiqTopologicalInventory.DefaultApi listServiceOfferingServiceInstances GET /service_offerings/{id}/service_instances List ServiceInstances for ServiceOffering
@ManageiqTopologicalInventory.DefaultApi listServiceOfferingServicePlans GET /service_offerings/{id}/service_plans List ServicePlans for ServiceOffering
@ManageiqTopologicalInventory.DefaultApi listServiceOfferings GET /service_offerings List ServiceOfferings
@ManageiqTopologicalInventory.DefaultApi listServicePlanServiceInstances GET /service_plans/{id}/service_instances List ServiceInstances for ServicePlan
@ManageiqTopologicalInventory.DefaultApi listServicePlans GET /service_plans List ServicePlans
@ManageiqTopologicalInventory.DefaultApi listSourceAvailabilities GET /sources/{id}/availabilities List Availabilities for Source
@ManageiqTopologicalInventory.DefaultApi listSourceContainerGroups GET /sources/{id}/container_groups List ContainerGroups for Source
@ManageiqTopologicalInventory.DefaultApi listSourceContainerImages GET /sources/{id}/container_images List ContainerImages for Source
@ManageiqTopologicalInventory.DefaultApi listSourceContainerNodes GET /sources/{id}/container_nodes List ContainerNodes for Source
@ManageiqTopologicalInventory.DefaultApi listSourceContainerProjects GET /sources/{id}/container_projects List ContainerProjects for Source
@ManageiqTopologicalInventory.DefaultApi listSourceContainerTemplates GET /sources/{id}/container_templates List ContainerTemplates for Source
@ManageiqTopologicalInventory.DefaultApi listSourceContainers GET /sources/{id}/containers List Containers for Source
@ManageiqTopologicalInventory.DefaultApi listSourceEndpoints GET /sources/{id}/endpoints List Endpoints for Source
@ManageiqTopologicalInventory.DefaultApi listSourceOrchestrationStacks GET /sources/{id}/orchestration_stacks List OrchestrationStacks for Source
@ManageiqTopologicalInventory.DefaultApi listSourceServiceInstances GET /sources/{id}/service_instances List ServiceInstances for Source
@ManageiqTopologicalInventory.DefaultApi listSourceServiceOfferings GET /sources/{id}/service_offerings List ServiceOfferings for Source
@ManageiqTopologicalInventory.DefaultApi listSourceServicePlans GET /sources/{id}/service_plans List ServicePlans for Source
@ManageiqTopologicalInventory.DefaultApi listSourceTypeAvailabilities GET /source_types/{id}/availabilities List Availabilities for SourceType
@ManageiqTopologicalInventory.DefaultApi listSourceTypeSources GET /source_types/{id}/sources List Sources for SourceType
@ManageiqTopologicalInventory.DefaultApi listSourceTypes GET /source_types List SourceTypes
@ManageiqTopologicalInventory.DefaultApi listSourceVms GET /sources/{id}/vms List Vms for Source
@ManageiqTopologicalInventory.DefaultApi listSourceVolumeTypes GET /sources/{id}/volume_types List VolumeTypes for Source
@ManageiqTopologicalInventory.DefaultApi listSourceVolumes GET /sources/{id}/volumes List Volumes for Source
@ManageiqTopologicalInventory.DefaultApi listSources GET /sources List Sources
@ManageiqTopologicalInventory.DefaultApi listTags GET /tags List Tags
@ManageiqTopologicalInventory.DefaultApi listTasks GET /tasks List Tasks
@ManageiqTopologicalInventory.DefaultApi listVmVolumeAttachments GET /vms/{id}/volume_attachments List VolumeAttachments for Vm
@ManageiqTopologicalInventory.DefaultApi listVmVolumes GET /vms/{id}/volumes List Volumes for Vm
@ManageiqTopologicalInventory.DefaultApi listVms GET /vms List Vms
@ManageiqTopologicalInventory.DefaultApi listVolumeAttachments GET /volume_attachments List VolumeAttachments
@ManageiqTopologicalInventory.DefaultApi listVolumeTypes GET /volume_types List VolumeTypes
@ManageiqTopologicalInventory.DefaultApi listVolumes GET /volumes List Volumes
@ManageiqTopologicalInventory.DefaultApi orderServicePlan POST /service_plans/{id}/order Order an existing ServicePlan
@ManageiqTopologicalInventory.DefaultApi showAuthentication GET /authentications/{id} Show an existing Authentication
@ManageiqTopologicalInventory.DefaultApi showContainer GET /containers/{id} Show an existing Container
@ManageiqTopologicalInventory.DefaultApi showContainerGroup GET /container_groups/{id} Show an existing ContainerGroup
@ManageiqTopologicalInventory.DefaultApi showContainerImage GET /container_images/{id} Show an existing ContainerImage
@ManageiqTopologicalInventory.DefaultApi showContainerNode GET /container_nodes/{id} Show an existing ContainerNode
@ManageiqTopologicalInventory.DefaultApi showContainerProject GET /container_projects/{id} Show an existing ContainerProject
@ManageiqTopologicalInventory.DefaultApi showContainerTemplate GET /container_templates/{id} Show an existing ContainerTemplate
@ManageiqTopologicalInventory.DefaultApi showEndpoint GET /endpoints/{id} Show an existing Endpoint
@ManageiqTopologicalInventory.DefaultApi showFlavor GET /flavors/{id} Show an existing Flavor
@ManageiqTopologicalInventory.DefaultApi showOrchestrationStack GET /orchestration_stacks/{id} Show an existing OrchestrationStack
@ManageiqTopologicalInventory.DefaultApi showServiceInstance GET /service_instances/{id} Show an existing ServiceInstance
@ManageiqTopologicalInventory.DefaultApi showServiceOffering GET /service_offerings/{id} Show an existing ServiceOffering
@ManageiqTopologicalInventory.DefaultApi showServiceOfferingIcon GET /service_offering_icons/{id} Show an existing ServiceOfferingIcon
@ManageiqTopologicalInventory.DefaultApi showServicePlan GET /service_plans/{id} Show an existing ServicePlan
@ManageiqTopologicalInventory.DefaultApi showSource GET /sources/{id} Show an existing Source
@ManageiqTopologicalInventory.DefaultApi showSourceType GET /source_types/{id} Show an existing SourceType
@ManageiqTopologicalInventory.DefaultApi showTag GET /tags/{id} Show an existing Tag
@ManageiqTopologicalInventory.DefaultApi showTask GET /tasks/{id} Show an existing Task
@ManageiqTopologicalInventory.DefaultApi showVm GET /vms/{id} Show an existing Vm
@ManageiqTopologicalInventory.DefaultApi showVolume GET /volumes/{id} Show an existing Volume
@ManageiqTopologicalInventory.DefaultApi showVolumeAttachment GET /volume_attachments/{id} Show an existing VolumeAttachment
@ManageiqTopologicalInventory.DefaultApi showVolumeType GET /volume_types/{id} Show an existing VolumeType
@ManageiqTopologicalInventory.DefaultApi updateAuthentication PATCH /authentications/{id} Update an existing Authentication
@ManageiqTopologicalInventory.DefaultApi updateEndpoint PATCH /endpoints/{id} Update an existing Endpoint
@ManageiqTopologicalInventory.DefaultApi updateSource PATCH /sources/{id} Update an existing Source
@ManageiqTopologicalInventory.DefaultApi updateTask PATCH /tasks/{id} Update an existing Task

Documentation for Models

Documentation for Authorization

UserSecurity

  • Type: HTTP basic authentication