OpenapiClient - the Ruby gem for the Site Manager API
Site Manager API
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
To build the Ruby code into a gem:
gem build openapi_client.gemspec
Then either install the gem locally:
gem install ./openapi_client-1.0.0.gem
(for development, run gem install --dev ./openapi_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 'openapi_client', '~> 1.0.0'
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 'openapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly using -I
as follows:
ruby -Ilib script.rb
Please follow the installation procedure and then run the following code:
# Load the gem
require 'openapi_client'
# Setup authorization
OpenapiClient.configure do |config|
# Configure Bearer authorization: bearerAuth
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = OpenapiClient::AbstractCapabilityApi.new
begin
result = api_instance.abstract_capabilities_get
p result
rescue OpenapiClient::ApiError => e
puts "Exception when calling AbstractCapabilityApi->abstract_capabilities_get: #{e}"
end
All URIs are relative to http://localhost:9000/site-manager/api/v1/engine
Class | Method | HTTP request | Description |
---|---|---|---|
OpenapiClient::AbstractCapabilityApi | abstract_capabilities_get | GET /abstract-capabilities/ | |
OpenapiClient::AbstractCapabilityApi | abstract_capabilities_pk_delete | DELETE /abstract-capabilities/{pk}/ | |
OpenapiClient::AbstractCapabilityApi | abstract_capabilities_pk_get | GET /abstract-capabilities/{pk}/ | |
OpenapiClient::AbstractCapabilityApi | abstract_capabilities_post | POST /abstract-capabilities/ | |
OpenapiClient::AccountApi | accounts_get | GET /accounts/ | |
OpenapiClient::AccountApi | accounts_pk_delete | DELETE /accounts/{pk} | |
OpenapiClient::AccountApi | accounts_pk_get | GET /accounts/{pk} | |
OpenapiClient::AccountApi | accounts_pk_put | PUT /accounts/{pk} | |
OpenapiClient::AccountApi | accounts_post | POST /accounts/ | |
OpenapiClient::AddressApi | addresses_get | GET /addresses/ | |
OpenapiClient::AddressApi | addresses_pk_delete | DELETE /addresses/{pk} | |
OpenapiClient::AddressApi | addresses_pk_get | GET /addresses/{pk} | |
OpenapiClient::AddressApi | addresses_post | POST /addresses/ | |
OpenapiClient::AuthenticationApi | token_auth_post | POST /token-auth | |
OpenapiClient::AutoSDEProjectApi | autosde_projects_get | GET /autosde-projects/ | |
OpenapiClient::AutoSDEProjectApi | autosde_projects_pk_delete | DELETE /autosde-projects/{pk}/ | |
OpenapiClient::AutoSDEProjectApi | autosde_projects_pk_get | GET /autosde-projects/{pk}/ | |
OpenapiClient::AutoSDEProjectApi | autosde_projects_post | POST /autosde-projects/ | |
OpenapiClient::AutoSDERoleApi | autosde_roles_get | GET /autosde-roles/ | |
OpenapiClient::AutoSDERoleApi | autosde_roles_pk_delete | DELETE /autosde-roles/{pk}/ | |
OpenapiClient::AutoSDERoleApi | autosde_roles_pk_get | GET /autosde-roles/{pk}/ | |
OpenapiClient::AutoSDERoleApi | autosde_roles_post | POST /autosde-roles/ | |
OpenapiClient::CapabilityTranslationApi | capability_translations_get | GET /capability-translations/ | |
OpenapiClient::CapabilityTranslationApi | capability_translations_pk_delete | DELETE /capability-translations/{pk} | |
OpenapiClient::CapabilityTranslationApi | capability_translations_pk_get | GET /capability-translations/{pk} | |
OpenapiClient::CapabilityTranslationApi | capability_translations_post | POST /capability-translations/ | |
OpenapiClient::HostApi | hosts_get | GET /hosts/ | |
OpenapiClient::HostApi | hosts_pk_delete | DELETE /hosts/{pk} | |
OpenapiClient::HostApi | hosts_pk_get | GET /hosts/{pk} | |
OpenapiClient::HostApi | hosts_post | POST /hosts/ | |
OpenapiClient::HostVolumeConnectionApi | host_volume_connection_get | GET /host-volume-connection/ | |
OpenapiClient::HostVolumeConnectionApi | host_volume_connection_pk_delete | DELETE /host-volume-connection/{pk} | |
OpenapiClient::HostVolumeConnectionApi | host_volume_connection_pk_get | GET /host-volume-connection/{pk} | |
OpenapiClient::HostVolumeConnectionApi | host_volume_connection_post | POST /host-volume-connection/ | |
OpenapiClient::NativeCapabilityApi | native_capabilities_get | GET /native-capabilities/ | |
OpenapiClient::NativeCapabilityApi | native_capabilities_pk_delete | DELETE /native-capabilities/{pk} | |
OpenapiClient::NativeCapabilityApi | native_capabilities_pk_get | GET /native-capabilities/{pk} | |
OpenapiClient::NativeCapabilityApi | native_capabilities_post | POST /native-capabilities/ | |
OpenapiClient::ProfileApi | profiles_get | GET /profiles/ | |
OpenapiClient::ProfileApi | profiles_pk_delete | DELETE /profiles/{pk}/ | |
OpenapiClient::ProfileApi | profiles_pk_get | GET /profiles/{pk}/ | |
OpenapiClient::ProfileApi | profiles_post | POST /profiles/ | |
OpenapiClient::ProvisioningStrategyApi | provisioning_strategy_get | GET /provisioning-strategy/ | |
OpenapiClient::ProvisioningStrategyApi | provisioning_strategy_pk_delete | DELETE /provisioning-strategy/{pk} | |
OpenapiClient::ProvisioningStrategyApi | provisioning_strategy_pk_get | GET /provisioning-strategy/{pk} | |
OpenapiClient::ProvisioningStrategyApi | provisioning_strategy_post | POST /provisioning-strategy/ | |
OpenapiClient::ServiceApi | services_get | GET /services/ | |
OpenapiClient::ServiceApi | services_pk_delete | DELETE /services/{pk} | |
OpenapiClient::ServiceApi | services_pk_get | GET /services/{pk} | |
OpenapiClient::ServiceApi | services_pk_put | PUT /services/{pk} | |
OpenapiClient::ServiceApi | services_post | POST /services/ | |
OpenapiClient::ServiceResourceAttachmentApi | service_resource_attchment_get | GET /service-resource-attchment/ | |
OpenapiClient::ServiceResourceAttachmentApi | service_resource_attchment_pk_delete | DELETE /service-resource-attchment/{pk} | |
OpenapiClient::ServiceResourceAttachmentApi | service_resource_attchment_pk_get | GET /service-resource-attchment/{pk} | |
OpenapiClient::ServiceResourceAttachmentApi | service_resource_attchment_post | POST /service-resource-attchment/ | |
OpenapiClient::StorageResourceApi | storage_resources_get | GET /storage-resources/ | |
OpenapiClient::StorageResourceApi | storage_resources_pk_delete | DELETE /storage-resources/{pk} | |
OpenapiClient::StorageResourceApi | storage_resources_pk_get | GET /storage-resources/{pk} | |
OpenapiClient::StorageResourceApi | storage_resources_pk_put | PUT /storage-resources/{pk} | |
OpenapiClient::StorageResourceApi | storage_resources_post | POST /storage-resources/ | |
OpenapiClient::StorageSystemApi | storage_systems_get | GET /storage-systems/ | |
OpenapiClient::StorageSystemApi | storage_systems_pk_delete | DELETE /storage-systems/{pk} | |
OpenapiClient::StorageSystemApi | storage_systems_pk_get | GET /storage-systems/{pk} | |
OpenapiClient::StorageSystemApi | storage_systems_post | POST /storage-systems/ | |
OpenapiClient::SystemTypeApi | system_types_get | GET /system-types/ | |
OpenapiClient::SystemTypeApi | system_types_pk_delete | DELETE /system-types/{pk} | |
OpenapiClient::SystemTypeApi | system_types_pk_get | GET /system-types/{pk} | |
OpenapiClient::SystemTypeApi | system_types_post | POST /system-types/ | |
OpenapiClient::VolumeApi | volumes_get | GET /volumes/ | |
OpenapiClient::VolumeApi | volumes_pk_delete | DELETE /volumes/{pk} | |
OpenapiClient::VolumeApi | volumes_pk_get | GET /volumes/{pk} | |
OpenapiClient::VolumeApi | volumes_pk_put | PUT /volumes/{pk} | |
OpenapiClient::VolumeApi | volumes_post | POST /volumes/ | |
OpenapiClient::VolumeSafeDeleteApi | safe_deletes_get | GET /safe-deletes/ | |
OpenapiClient::VolumeSafeDeleteApi | safe_deletes_pk_delete | DELETE /safe-deletes/{pk} | |
OpenapiClient::VolumeSafeDeleteApi | safe_deletes_pk_get | GET /safe-deletes/{pk} | |
OpenapiClient::VolumeSafeDeleteApi | safe_deletes_post | POST /safe-deletes/ |
- OpenapiClient::AbstractCapability
- OpenapiClient::Account
- OpenapiClient::AccountPostRequest
- OpenapiClient::AccountPostResponse
- OpenapiClient::Address
- OpenapiClient::AddressCreate
- OpenapiClient::AuthResponse
- OpenapiClient::Authentication
- OpenapiClient::AutoSDEProject
- OpenapiClient::AutoSDERole
- OpenapiClient::CapabilityTranslation
- OpenapiClient::CapabilityTranslationCreate
- OpenapiClient::Host
- OpenapiClient::HostCreate
- OpenapiClient::HostVolumeConnection
- OpenapiClient::HostVolumeConnectionCreate
- OpenapiClient::NativeCapability
- OpenapiClient::Profile
- OpenapiClient::ProvisioningStrategy
- OpenapiClient::Service
- OpenapiClient::ServiceAbstractCapabilityValue
- OpenapiClient::ServiceCreate
- OpenapiClient::ServiceResourceAttachment
- OpenapiClient::StorageResource
- OpenapiClient::StorageResourceCreate
- OpenapiClient::StorageResourceResponse
- OpenapiClient::StorageSystem
- OpenapiClient::StorageSystemCreate
- OpenapiClient::SystemType
- OpenapiClient::SystemTypeCreate
- OpenapiClient::Volume
- OpenapiClient::VolumeCreate
- OpenapiClient::VolumeResponse
- OpenapiClient::VolumeSafeDelete
- OpenapiClient: 5428 :VolumeSafeDeleteCreate
- OpenapiClient::VolumeUpdate
- Type: Bearer authentication