pulp_2to3_migration_client 0.3.0b1.dev01595360000

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d8be6074c67499720c8b6a789f2243aff0da5e01dacc66884be93b083ed6215
+  data.tar.gz: 938fc6cdb9a778fc705c1e16a9c4c5293fa4c648342f1c7d188428eb21dad016
+SHA512:
+  metadata.gz: a0eef720cea3972f548d7c9d46beef825a996c390abaf9914f6b12c6a7336d7073bf40928b964b002784380a8476407d36d6c7fb1a0026d79e916dc2c9c845bf
+  data.tar.gz: f4f19e827ec41e9be9c7bb7af7d306a39affd288f8704b3457ce30118e572766ad2154ba77b663b09637e19836e373db9b8df7cdca4724c19c9a1b9810b46bcc

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,114 @@
+# 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](https://openapi-generator.tech) project:
+
+- API version: v3
+- Package version: 0.3.0b1.dev01595360000
+- 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.3.0b1.dev01595360000.gem
+```
+
+(for development, run `gem install --dev ./pulp_2to3_migration_client-0.3.0b1.dev01595360000.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'pulp_2to3_migration_client', '~> 0.3.0b1.dev01595360000'
+
+### 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](#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://pulp*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Pulp2to3MigrationClient::MigrationPlansApi* | [**create**](docs/MigrationPlansApi.md#create) | **POST** /pulp/api/v3/migration-plans/ | Create a migration plan
+*Pulp2to3MigrationClient::MigrationPlansApi* | [**delete**](docs/MigrationPlansApi.md#delete) | **DELETE** {migration_plan_href} | Delete a migration plan
+*Pulp2to3MigrationClient::MigrationPlansApi* | [**list**](docs/MigrationPlansApi.md#list) | **GET** /pulp/api/v3/migration-plans/ | List migration plans
+*Pulp2to3MigrationClient::MigrationPlansApi* | [**read**](docs/MigrationPlansApi.md#read) | **GET** {migration_plan_href} | Inspect a migration plan
+*Pulp2to3MigrationClient::MigrationPlansApi* | [**run**](docs/MigrationPlansApi.md#run) | **POST** {migration_plan_href}run/ | Run migration plan
+*Pulp2to3MigrationClient::Pulp2contentApi* | [**list**](docs/Pulp2contentApi.md#list) | **GET** /pulp/api/v3/pulp2content/ | List pulp2 contents
+*Pulp2to3MigrationClient::Pulp2contentApi* | [**read**](docs/Pulp2contentApi.md#read) | **GET** {pulp2_content_href} | Inspect a pulp2 content
+*Pulp2to3MigrationClient::Pulp2repositoriesApi* | [**list**](docs/Pulp2repositoriesApi.md#list) | **GET** /pulp/api/v3/pulp2repositories/ | List pulp2 repositorys
+*Pulp2to3MigrationClient::Pulp2repositoriesApi* | [**read**](docs/Pulp2repositoriesApi.md#read) | **GET** {pulp2_repository_href} | Inspect a pulp2 repository
+
+
+## Documentation for Models
+
+ - [Pulp2to3MigrationClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
+ - [Pulp2to3MigrationClient::InlineResponse200](docs/InlineResponse200.md)
+ - [Pulp2to3MigrationClient::InlineResponse2001](docs/InlineResponse2001.md)
+ - [Pulp2to3MigrationClient::InlineResponse2002](docs/InlineResponse2002.md)
+ - [Pulp2to3MigrationClient::MigrationPlanRun](docs/MigrationPlanRun.md)
+ - [Pulp2to3MigrationClient::Pulp2to3MigrationMigrationPlan](docs/Pulp2to3MigrationMigrationPlan.md)
+ - [Pulp2to3MigrationClient::Pulp2to3MigrationPulp2Content](docs/Pulp2to3MigrationPulp2Content.md)
+ - [Pulp2to3MigrationClient::Pulp2to3MigrationPulp2Repository](docs/Pulp2to3MigrationPulp2Repository.md)
+
+
+## Documentation for Authorization
+
+
+### Basic
+
+- **Type**: HTTP basic authentication
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AsyncOperationResponse.md

@@ -0,0 +1,17 @@
+# Pulp2to3MigrationClient::AsyncOperationResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task** | **String** | The href of the task. | 
+
+## Code Sample
+
+```ruby
+require 'Pulp2to3MigrationClient'
+
+instance = Pulp2to3MigrationClient::AsyncOperationResponse.new(task: null)
+```
+
+

data/docs/InlineResponse200.md

@@ -0,0 +1,23 @@
+# Pulp2to3MigrationClient::InlineResponse200
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<Pulp2to3MigrationMigrationPlan>**](Pulp2to3MigrationMigrationPlan.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'Pulp2to3MigrationClient'
+
+instance = Pulp2to3MigrationClient::InlineResponse200.new(count: null,
+                                 _next: null,
+                                 previous: null,
+                                 results: null)
+```
+
+

data/docs/InlineResponse2001.md

@@ -0,0 +1,23 @@
+# Pulp2to3MigrationClient::InlineResponse2001
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<Pulp2to3MigrationPulp2Content>**](Pulp2to3MigrationPulp2Content.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'Pulp2to3MigrationClient'
+
+instance = Pulp2to3MigrationClient::InlineResponse2001.new(count: null,
+                                 _next: null,
+                                 previous: null,
+                                 results: null)
+```
+
+

data/docs/InlineResponse2002.md

@@ -0,0 +1,23 @@
+# Pulp2to3MigrationClient::InlineResponse2002
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<Pulp2to3MigrationPulp2Repository>**](Pulp2to3MigrationPulp2Repository.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'Pulp2to3MigrationClient'
+
+instance = Pulp2to3MigrationClient::InlineResponse2002.new(count: null,
+                                 _next: null,
+                                 previous: null,
+                                 results: null)
+```
+
+

data/docs/MigrationPlanRun.md

@@ -0,0 +1,19 @@
+# Pulp2to3MigrationClient::MigrationPlanRun
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**validate** | **Boolean** | If ``True``, migration cannot happen without successful validation of the Migration Plan | [optional] [default to false]
+**dry_run** | **Boolean** | If ``True``, performs validation of a Migration Plan only, no migration is run. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'Pulp2to3MigrationClient'
+
+instance = Pulp2to3MigrationClient::MigrationPlanRun.new(validate: null,
+                                 dry_run: null)
+```
+
+

data/docs/MigrationPlansApi.md

@@ -0,0 +1,295 @@
+# Pulp2to3MigrationClient::MigrationPlansApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](MigrationPlansApi.md#create) | **POST** /pulp/api/v3/migration-plans/ | Create a migration plan
+[**delete**](MigrationPlansApi.md#delete) | **DELETE** {migration_plan_href} | Delete a migration plan
+[**list**](MigrationPlansApi.md#list) | **GET** /pulp/api/v3/migration-plans/ | List migration plans
+[**read**](MigrationPlansApi.md#read) | **GET** {migration_plan_href} | Inspect a migration plan
+[**run**](MigrationPlansApi.md#run) | **POST** {migration_plan_href}run/ | Run migration plan
+
+
+
+## create
+
+> Pulp2to3MigrationMigrationPlan create(data)
+
+Create a migration plan
+
+MigrationPlan ViewSet.
+
+### Example
+
+```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
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**Pulp2to3MigrationMigrationPlan**](Pulp2to3MigrationMigrationPlan.md)|  | 
+
+### Return type
+
+[**Pulp2to3MigrationMigrationPlan**](Pulp2to3MigrationMigrationPlan.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> delete(migration_plan_href)
+
+Delete a migration plan
+
+MigrationPlan ViewSet.
+
+### Example
+
+```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
+migration_plan_href = 'migration_plan_href_example' # String | URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/
+
+begin
+  #Delete a migration plan
+  api_instance.delete(migration_plan_href)
+rescue Pulp2to3MigrationClient::ApiError => e
+  puts "Exception when calling MigrationPlansApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **migration_plan_href** | **String**| URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/ | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> InlineResponse200 list(opts)
+
+List migration plans
+
+MigrationPlan ViewSet.
+
+### Example
+
+```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
+opts = {
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  limit: 56, # Integer | Number of results to return per page.
+  offset: 56, # Integer | The initial index from which to return the results.
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #List migration plans
+  result = api_instance.list(opts)
+  p result
+rescue Pulp2to3MigrationClient::ApiError => e
+  puts "Exception when calling MigrationPlansApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> Pulp2to3MigrationMigrationPlan read(migration_plan_href, opts)
+
+Inspect a migration plan
+
+MigrationPlan ViewSet.
+
+### Example
+
+```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
+migration_plan_href = 'migration_plan_href_example' # String | URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #Inspect a migration plan
+  result = api_instance.read(migration_plan_href, opts)
+  p result
+rescue Pulp2to3MigrationClient::ApiError => e
+  puts "Exception when calling MigrationPlansApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **migration_plan_href** | **String**| URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/ | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**Pulp2to3MigrationMigrationPlan**](Pulp2to3MigrationMigrationPlan.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## run
+
+> AsyncOperationResponse run(migration_plan_href, data)
+
+Run migration plan
+
+Trigger an asynchronous task to run a migration from Pulp 2.
+
+### Example
+
+```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
+migration_plan_href = 'migration_plan_href_example' # String | URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/
+data = Pulp2to3MigrationClient::MigrationPlanRun.new # MigrationPlanRun | 
+
+begin
+  #Run migration plan
+  result = api_instance.run(migration_plan_href, data)
+  p result
+rescue Pulp2to3MigrationClient::ApiError => e
+  puts "Exception when calling MigrationPlansApi->run: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **migration_plan_href** | **String**| URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/ | 
+ **data** | [**MigrationPlanRun**](MigrationPlanRun.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+