topological_inventory-ingress_api-client
TopologicalInventoryIngressApiClient - the Ruby gem for the Topological Inventory Ingress API
Topological Inventory Ingress API
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 0.0.2
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
Installation
Build a gem
To build the Ruby code into a gem:
gem build topological_inventory-ingress_api-client.gemspec
Then either install the gem locally:
gem install ./topological_inventory-ingress_api-client-1.0.0.gem
(for development, run gem install --dev ./topological_inventory-ingress_api-client-1.0.0.gem
to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'topological_inventory-ingress_api-client', '~> 1.0.0'
Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
gem 'topological_inventory-ingress_api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly
Include the Ruby code directly using -I
as follows:
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
# Load the gem
require 'topological_inventory-ingress_api-client'
api_instance = TopologicalInventoryIngressApiClient::DefaultApi.new
begin
#Return this API document in JSON format
api_instance.get_documentation
rescue TopologicalInventoryIngressApiClient::ApiError => e
puts "Exception when calling DefaultApi->get_documentation: #{e}"
end
Documentation for API Endpoints
All URIs are relative to https://cloud.redhat.com//topological_inventory/ingress_api/0.0.2
Class | Method | HTTP request | Description |
---|---|---|---|
TopologicalInventoryIngressApiClient::DefaultApi | get_documentation | GET /openapi.json | Return this API document in JSON format |
TopologicalInventoryIngressApiClient::DefaultApi | save_inventory | POST /inventory | save inventory |
Documentation for Models
- TopologicalInventoryIngressApiClient::Cluster
- TopologicalInventoryIngressApiClient::ClusterAllOf
- TopologicalInventoryIngressApiClient::ClusterReference
- TopologicalInventoryIngressApiClient::ClusterReferenceReference
- TopologicalInventoryIngressApiClient::ClusterTag
- TopologicalInventoryIngressApiClient::ClusterTagAllOf
- TopologicalInventoryIngressApiClient::Container
- TopologicalInventoryIngressApiClient::ContainerAllOf
- TopologicalInventoryIngressApiClient::ContainerGroup
- TopologicalInventoryIngressApiClient::ContainerGroupAllOf
- TopologicalInventoryIngressApiClient::ContainerGroupReference
- TopologicalInventoryIngressApiClient::ContainerGroupTag
- TopologicalInventoryIngressApiClient::ContainerGroupTagAllOf
- TopologicalInventoryIngressApiClient::ContainerImage
- TopologicalInventoryIngressApiClient::ContainerImageAllOf
- TopologicalInventoryIngressApiClient::ContainerImageReference
- TopologicalInventoryIngressApiClient::ContainerImageTag
- TopologicalInventoryIngressApiClient::ContainerImageTagAllOf
- TopologicalInventoryIngressApiClient::ContainerNode
- TopologicalInventoryIngressApiClient::ContainerNodeAllOf
- TopologicalInventoryIngressApiClient::ContainerNodeReference
- TopologicalInventoryIngressApiClient::ContainerNodeReferenceByName
- TopologicalInventoryIngressApiClient::ContainerNodeReferenceByNameReference
- TopologicalInventoryIngressApiClient::ContainerNodeTag
- TopologicalInventoryIngressApiClient::ContainerNodeTagAllOf
- TopologicalInventoryIngressApiClient::ContainerProject
- TopologicalInventoryIngressApiClient::ContainerProjectAllOf
- TopologicalInventoryIngressApiClient::ContainerProjectReference
- TopologicalInventoryIngressApiClient::ContainerProjectReferenceByName
- TopologicalInventoryIngressApiClient::ContainerProjectTag
- TopologicalInventoryIngressApiClient::ContainerProjectTagAllOf
- TopologicalInventoryIngressApiClient::ContainerResourceQuota
- TopologicalInventoryIngressApiClient::ContainerResourceQuotaAllOf
- TopologicalInventoryIngressApiClient::ContainerTemplate
- TopologicalInventoryIngressApiClient::ContainerTemplateAllOf
- TopologicalInventoryIngressApiClient::ContainerTemplateReference
- TopologicalInventoryIngressApiClient::ContainerTemplateTag
- TopologicalInventoryIngressApiClient::ContainerTemplateTagAllOf
- TopologicalInventoryIngressApiClient::CrossLinkVmReference
- TopologicalInventoryIngressApiClient::CrossLinkVmReferenceReference
- TopologicalInventoryIngressApiClient::Datastore
- TopologicalInventoryIngressApiClient::DatastoreAllOf
- TopologicalInventoryIngressApiClient::DatastoreMount
- TopologicalInventoryIngressApiClient::DatastoreMountAllOf
- TopologicalInventoryIngressApiClient::DatastoreReference
- TopologicalInventoryIngressApiClient::DatastoreReferenceReference
- TopologicalInventoryIngressApiClient::DatastoreTag
- TopologicalInventoryIngressApiClient::DatastoreTagAllOf
- TopologicalInventoryIngressApiClient::Flavor
- TopologicalInventoryIngressApiClient::FlavorAllOf
- TopologicalInventoryIngressApiClient::FlavorReference
- TopologicalInventoryIngressApiClient::FlavorReferenceReference
- TopologicalInventoryIngressApiClient::Host
- TopologicalInventoryIngressApiClient::HostAllOf
- TopologicalInventoryIngressApiClient::HostReference
- TopologicalInventoryIngressApiClient::HostTag
- TopologicalInventoryIngressApiClient::HostTagAllOf
- TopologicalInventoryIngressApiClient::Inventory
- TopologicalInventoryIngressApiClient::InventoryCollection
- TopologicalInventoryIngressApiClient::InventoryCollectionCluster
- TopologicalInventoryIngressApiClient::InventoryCollectionClusterTag
- TopologicalInventoryIngressApiClient::InventoryCollectionContainer
- TopologicalInventoryIngressApiClient::InventoryCollectionContainerGroup
- TopologicalInventoryIngressApiClient::InventoryCollectionContainerGroupTag
- TopologicalInventoryIngressApiClient::InventoryCollectionContainerImage
- TopologicalInventoryIngressApiClient::InventoryCollectionContainerImageTag
- TopologicalInventoryIngressApiClient::InventoryCollectionContainerNode
- TopologicalInventoryIngressApiClient::InventoryCollectionContainerNodeTag
- TopologicalInventoryIngressApiClient::InventoryCollectionContainerProject
- TopologicalInventoryIngressApiClient::InventoryCollectionContainerProjectTag
- TopologicalInventoryIngressApiClient::InventoryCollectionContainerResourceQuota
- TopologicalInventoryIngressApiClient::InventoryCollectionContainerTemplate
- TopologicalInventoryIngressApiClient::InventoryCollectionContainerTemplateTag
- TopologicalInventoryIngressApiClient::InventoryCollectionDatastore
- TopologicalInventoryIngressApiClient::InventoryCollectionDatastoreMount
- TopologicalInventoryIngressApiClient::InventoryCollectionDatastoreTag
- TopologicalInventoryIngressApiClient::InventoryCollectionFlavor
- TopologicalInventoryIngressApiClient::InventoryCollectionHost
- TopologicalInventoryIngressApiClient::InventoryCollectionHostTag
- TopologicalInventoryIngressApiClient::InventoryCollectionIpaddress
- TopologicalInventoryIngressApiClient::InventoryCollectionIpaddressTag
- TopologicalInventoryIngressApiClient::InventoryCollectionNetwork
- TopologicalInventoryIngressApiClient::InventoryCollectionNetworkAdapter
- TopologicalInventoryIngressApiClient::InventoryCollectionNetworkAdapterTag
- TopologicalInventoryIngressApiClient::InventoryCollectionNetworkTag
- TopologicalInventoryIngressApiClient::InventoryCollectionOrchestrationStack
- TopologicalInventoryIngressApiClient::InventoryCollectionReservation
- TopologicalInventoryIngressApiClient::InventoryCollectionReservationTag
- TopologicalInventoryIngressApiClient::InventoryCollectionSecurityGroup
- TopologicalInventoryIngressApiClient::InventoryCollectionSecurityGroupTag
- TopologicalInventoryIngressApiClient::InventoryCollectionServiceCredential
- TopologicalInventoryIngressApiClient::InventoryCollectionServiceInstance
- TopologicalInventoryIngressApiClient::InventoryCollectionServiceInstanceNode
- TopologicalInventoryIngressApiClient::InventoryCollectionServiceInventory
- TopologicalInventoryIngressApiClient::InventoryCollectionServiceInventoryTag
- TopologicalInventoryIngressApiClient::InventoryCollectionServiceOffering
- TopologicalInventoryIngressApiClient::InventoryCollectionServiceOfferingIcon
- TopologicalInventoryIngressApiClient::InventoryCollectionServiceOfferingNode
- TopologicalInventoryIngressApiClient::InventoryCollectionServiceOfferingTag
- TopologicalInventoryIngressApiClient::InventoryCollectionServicePlan
- TopologicalInventoryIngressApiClient::InventoryCollectionSourceRegion
- TopologicalInventoryIngressApiClient::InventoryCollectionSubnet
- TopologicalInventoryIngressApiClient::InventoryCollectionSubnetTag
- TopologicalInventoryIngressApiClient::InventoryCollectionSubscription
- TopologicalInventoryIngressApiClient::InventoryCollectionTag
- TopologicalInventoryIngressApiClient::InventoryCollectionVm
- TopologicalInventoryIngressApiClient::InventoryCollectionVmSecurityGroup
- TopologicalInventoryIngressApiClient::InventoryCollectionVmTag
- TopologicalInventoryIngressApiClient::InventoryCollectionVolume
- TopologicalInventoryIngressApiClient::InventoryCollectionVolumeAttachment
- TopologicalInventoryIngressApiClient::InventoryCollectionVolumeType
- TopologicalInventoryIngressApiClient::InventoryObjectLazy
- TopologicalInventoryIngressApiClient::Ipaddress
- TopologicalInventoryIngressApiClient::IpaddressAllOf
- TopologicalInventoryIngressApiClient::IpaddressReference
- TopologicalInventoryIngressApiClient::IpaddressTag
- TopologicalInventoryIngressApiClient::IpaddressTagAllOf
- TopologicalInventoryIngressApiClient::Network
- TopologicalInventoryIngressApiClient::NetworkAdapter
- TopologicalInventoryIngressApiClient::NetworkAdapterAllOf
- TopologicalInventoryIngressApiClient::NetworkAdapterReference
- TopologicalInventoryIngressApiClient::NetworkAdapterTag
- TopologicalInventoryIngressApiClient::NetworkAdapterTagAllOf
- TopologicalInventoryIngressApiClient::NetworkAllOf
- TopologicalInventoryIngressApiClient::NetworkReference
- TopologicalInventoryIngressApiClient::NetworkTag
- TopologicalInventoryIngressApiClient::NetworkTagAllOf
- TopologicalInventoryIngressApiClient::OrchestrationStack
- TopologicalInventoryIngressApiClient::OrchestrationStackAllOf
- TopologicalInventoryIngressApiClient::OrchestrationStackReference
- TopologicalInventoryIngressApiClient::Reservation
- TopologicalInventoryIngressApiClient::ReservationAllOf
- TopologicalInventoryIngressApiClient::ReservationReference
- TopologicalInventoryIngressApiClient::ReservationTag
- TopologicalInventoryIngressApiClient::ReservationTagAllOf
- TopologicalInventoryIngressApiClient::Schema
- TopologicalInventoryIngressApiClient::SecurityGroup
- TopologicalInventoryIngressApiClient::SecurityGroupAllOf
- TopologicalInventoryIngressApiClient::SecurityGroupReference
- TopologicalInventoryIngressApiClient::SecurityGroupTag
- TopologicalInventoryIngressApiClient::SecurityGroupTagAllOf
- TopologicalInventoryIngressApiClient::ServiceCredential
- TopologicalInventoryIngressApiClient::ServiceCredentialAllOf
- TopologicalInventoryIngressApiClient::ServiceCredentialReference
- TopologicalInventoryIngressApiClient::ServiceInstance
- TopologicalInventoryIngressApiClient::ServiceInstanceAllOf
- TopologicalInventoryIngressApiClient::ServiceInstanceNode
- TopologicalInventoryIngressApiClient::ServiceInstanceNodeAllOf
- TopologicalInventoryIngressApiClient::ServiceInstanceReference
- TopologicalInventoryIngressApiClient::ServiceInventory
- TopologicalInventoryIngressApiClient::ServiceInventoryAllOf
- TopologicalInventoryIngressApiClient::ServiceInventoryReference
- TopologicalInventoryIngressApiClient::ServiceInventoryTag
- TopologicalInventoryIngressApiClient::ServiceInventoryTagAllOf
- TopologicalInventoryIngressApiClient::ServiceOffering
- TopologicalInventoryIngressApiClient::ServiceOfferingAllOf
- TopologicalInventoryIngressApiClient::ServiceOfferingIcon
- TopologicalInventoryIngressApiClient::ServiceOfferingIconAllOf
- TopologicalInventoryIngressApiClient::ServiceOfferingIconReference
- TopologicalInventoryIngressApiClient::ServiceOfferingNode
- TopologicalInventoryIngressApiClient::ServiceOfferingNodeAllOf
- TopologicalInventoryIngressApiClient::ServiceOfferingReference
- TopologicalInventoryIngressApiClient::ServiceOfferingTag
- TopologicalInventoryIngressApiClient::ServiceOfferingTagAllOf
- TopologicalInventoryIngressApiClient::ServicePlan
- TopologicalInventoryIngressApiClient::ServicePlanAllOf
- TopologicalInventoryIngressApiClient::ServicePlanReference
- TopologicalInventoryIngressApiClient::SourceRegion
- TopologicalInventoryIngressApiClient::SourceRegionAllOf
- TopologicalInventoryIngressApiClient::SourceRegionReference
- TopologicalInventoryIngressApiClient::Subnet
- TopologicalInventoryIngressApiClient::SubnetAllOf
- TopologicalInventoryIngressApiClient::SubnetReference
- TopologicalInventoryIngressApiClient::SubnetTag
- TopologicalInventoryIngressApiClient::SubnetTagAllOf
- TopologicalInventoryIngressApiClient::Subscription
- TopologicalInventoryIngressApiClient::SubscriptionAllOf
- TopologicalInventoryIngressApiClient::SubscriptionReference
- TopologicalInventoryIngressApiClient::Tag
- TopologicalInventoryIngressApiClient::TagAllOf
- TopologicalInventoryIngressApiClient::TagReference
- TopologicalInventoryIngressApiClient::TagReferenceReference
- TopologicalInventoryIngressApiClient::Vm
- TopologicalInventoryIngressApiClient::VmAllOf
- TopologicalInventoryIngressApiClient::VmReference
- TopologicalInventoryIngressApiClient::VmSecurityGroup
- TopologicalInventoryIngressApiClient::VmSecurityGroupAllOf
- TopologicalInventoryIngressApiClient::VmTag
- TopologicalInventoryIngressApiClient::VmTagAllOf
- TopologicalInventoryIngressApiClient::Volume
- TopologicalInventoryIngressApiClient::VolumeAllOf
- TopologicalInventoryIngressApiClient::VolumeAttachment
- TopologicalInventoryIngressApiClient::VolumeAttachmentAllOf
- TopologicalInventoryIngressApiClient::VolumeReference
- TopologicalInventoryIngressApiClient::VolumeType
- TopologicalInventoryIngressApiClient::VolumeTypeAllOf
- TopologicalInventoryIngressApiClient::VolumeTypeReference
Documentation for Authorization
All endpoints do not require authorization.