pulp_2to3_migration_client
Pulp2to3MigrationClient - the Ruby gem for the Pulp 3 API
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This SDK is automatically generated by the OpenAPI Generator project:
- API version: v3
- Package version: 0.1.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
Installation
Build a gem
To build the Ruby code into a gem:
shell
gem build pulp_2to3_migration_client.gemspec
Then either install the gem locally:
shell
gem install ./pulp_2to3_migration_client-0.1.0.gem
(for development, run gem install --dev ./pulp_2to3_migration_client-0.1.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 'pulp_2to3_migration_client', '~> 0.1.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 'pulp_2to3_migration_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:
shell
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
```ruby # Load the gem require ‘pulp_2to3_migration_client’
Setup authorization
Pulp2to3MigrationClient.configure do |config| # Configure HTTP basic authorization: Basic config.username = ‘YOUR_USERNAME’ config.password = ‘YOUR_PASSWORD’ end
api_instance = Pulp2to3MigrationClient::MigrationPlansApi.new data = Pulp2to3MigrationClient::Pulp2to3MigrationMigrationPlan.new # Pulp2to3MigrationMigrationPlan |
begin #Create a migration plan result = api_instance.create(data) p result rescue Pulp2to3MigrationClient::ApiError => e puts “Exception when calling MigrationPlansApi->create: #e” end
```
Documentation for API Endpoints
All URIs are relative to http://localhost:24817
Class | Method | HTTP request | Description |
---|---|---|---|
Pulp2to3MigrationClient::MigrationPlansApi | create | POST /pulp/api/v3/migration-plans/ | Create a migration plan |
Pulp2to3MigrationClient::MigrationPlansApi | delete | DELETE migration_plan_href | Delete a migration plan |
Pulp2to3MigrationClient::MigrationPlansApi | list | GET /pulp/api/v3/migration-plans/ | List migration plans |
Pulp2to3MigrationClient::MigrationPlansApi | read | GET migration_plan_href | Inspect a migration plan |
Pulp2to3MigrationClient::MigrationPlansApi | run | POST migration_plan_hrefrun/ | Run migration plan |
Pulp2to3MigrationClient::Pulp2contentApi | list | GET /pulp/api/v3/pulp2content/ | List pulp2 contents |
Pulp2to3MigrationClient::Pulp2contentApi | read | GET pulp2_content_href | Inspect a pulp2 content |
Pulp2to3MigrationClient::Pulp2repositoriesApi | list | GET /pulp/api/v3/pulp2repositories/ | List pulp2 repositorys |
Pulp2to3MigrationClient::Pulp2repositoriesApi | read | GET pulp2_repository_href | Inspect a pulp2 repository |
Documentation for Models
- Pulp2to3MigrationClient::AsyncOperationResponse
- Pulp2to3MigrationClient::InlineResponse200
- Pulp2to3MigrationClient::InlineResponse2001
- Pulp2to3MigrationClient::InlineResponse2002
- Pulp2to3MigrationClient::MigrationPlanRun
- Pulp2to3MigrationClient::Pulp2to3MigrationMigrationPlan
- Pulp2to3MigrationClient::Pulp2to3MigrationPulp2Content
- Pulp2to3MigrationClient::Pulp2to3MigrationPulp2Repository
Documentation for Authorization
Basic
- Type: HTTP basic authentication