SourcesApiClient - the Ruby gem for the Sources
Sources
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 sources-api-client.gemspec
Then either install the gem locally:
gem install ./sources-api-client-1.0.0.gem
(for development, run gem install --dev ./sources-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 'sources-api-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 'sources-api-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 'sources-api-client'
# Setup authorization
SourcesApiClient.configure do |config|
# Configure HTTP basic authorization: UserSecurity
config.username = 'YOUR_USERNAME'
config.password = 'YOUR_PASSWORD'
end
api_instance = SourcesApiClient::DefaultApi.new
id = 'id_example' # String | ID of the resource
begin
#Checks Availability of a Source
api_instance.check_availability_source(id)
rescue SourcesApiClient::ApiError => e
puts "Exception when calling DefaultApi->check_availability_source: #{e}"
end
All URIs are relative to https://cloud.redhat.com//api/sources/v1.0
Class | Method | HTTP request | Description |
---|---|---|---|
SourcesApiClient::DefaultApi | check_availability_source | POST /sources/{id}/check_availability | Checks Availability of a Source |
SourcesApiClient::DefaultApi | create_application | POST /applications | Create a new Application |
SourcesApiClient::DefaultApi | create_authentication | POST /authentications | Create a new Authentication |
SourcesApiClient::DefaultApi | create_endpoint | POST /endpoints | Create a new Endpoint |
SourcesApiClient::DefaultApi | create_source | POST /sources | Create a new Source |
SourcesApiClient::DefaultApi | create_source_type | POST /source_types | Create a new SourceType |
SourcesApiClient::DefaultApi | delete_application | DELETE /applications/{id} | Delete an existing Application |
SourcesApiClient::DefaultApi | delete_authentication | DELETE /authentications/{id} | Delete an existing Authentication |
SourcesApiClient::DefaultApi | delete_endpoint | DELETE /endpoints/{id} | Delete an existing Endpoint |
SourcesApiClient::DefaultApi | delete_source | DELETE /sources/{id} | Delete an existing Source |
SourcesApiClient::DefaultApi | get_documentation | GET /openapi.json | Return this API document in JSON format |
SourcesApiClient::DefaultApi | list_application_type_sources | GET /application_types/{id}/sources | List Sources for ApplicationType |
SourcesApiClient::DefaultApi | list_application_types | GET /application_types | List ApplicationTypes |
SourcesApiClient::DefaultApi | list_applications | GET /applications | List Applications |
SourcesApiClient::DefaultApi | list_authentications | GET /authentications | List Authentications |
SourcesApiClient::DefaultApi | list_endpoint_authentications | GET /endpoints/{id}/authentications | List Authentications for Endpoint |
SourcesApiClient::DefaultApi | list_endpoints | GET /endpoints | List Endpoints |
SourcesApiClient::DefaultApi | list_source_application_types | GET /sources/{id}/application_types | List ApplicationTypes for Source |
SourcesApiClient::DefaultApi | list_source_applications | GET /sources/{id}/applications | List Applications for Source |
SourcesApiClient::DefaultApi | list_source_endpoints | GET /sources/{id}/endpoints | List Endpoints for Source |
SourcesApiClient::DefaultApi | list_source_type_sources | GET /source_types/{id}/sources | List Sources for SourceType |
SourcesApiClient::DefaultApi | list_source_types | GET /source_types | List SourceTypes |
SourcesApiClient::DefaultApi | list_sources | GET /sources | List Sources |
SourcesApiClient::DefaultApi | post_graph_ql | POST /graphql | Perform a GraphQL Query |
SourcesApiClient::DefaultApi | show_application | GET /applications/{id} | Show an existing Application |
SourcesApiClient::DefaultApi | show_application_type | GET /application_types/{id} | Show an existing ApplicationType |
SourcesApiClient::DefaultApi | show_authentication | GET /authentications/{id} | Show an existing Authentication |
SourcesApiClient::DefaultApi | show_endpoint | GET /endpoints/{id} | Show an existing Endpoint |
SourcesApiClient::DefaultApi | show_source | GET /sources/{id} | Show an existing Source |
SourcesApiClient::DefaultApi | show_source_type | GET /source_types/{id} | Show an existing SourceType |
SourcesApiClient::DefaultApi | update_application | PATCH /applications/{id} | Update an existing Application |
SourcesApiClient::DefaultApi | update_authentication | PATCH /authentications/{id} | Update an existing Authentication |
SourcesApiClient::DefaultApi | update_endpoint | PATCH /endpoints/{id} | Update an existing Endpoint |
SourcesApiClient::DefaultApi | update_source | PATCH /sources/{id} | Update an existing Source |
- SourcesApiClient::Application
- SourcesApiClient::ApplicationType
- SourcesApiClient::ApplicationTypesCollection
- SourcesApiClient::ApplicationsCollection
- SourcesApiClient::Authentication
- SourcesApiClient::AuthenticationExtra
- SourcesApiClient::AuthenticationExtraAzure
- SourcesApiClient::AuthenticationsCollection
- SourcesApiClient::CollectionLinks
- SourcesApiClient::CollectionMetadata
- SourcesApiClient::Endpoint
- SourcesApiClient::EndpointsCollection
- SourcesApiClient::ErrorNotFound
- SourcesApiClient::ErrorNotFoundErrors
- SourcesApiClient::GraphQLRequest
- SourcesApiClient::GraphQLResponse
- SourcesApiClient::Source
- SourcesApiClient::SourceType
- SourcesApiClient::SourceTypesCollection
- SourcesApiClient::SourcesCollection
- SourcesApiClient::Tenant
- Type: HTTP basic authentication