pulp_2to3_migration_client 0.6.0.dev01605193866 → 0.7.0.dev01607743897

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5085948aeff7ae32f14f77ff4365a853ed2ca273f2c4238676d19390c693b14e
-  data.tar.gz: 06ef81d1f11bf7ea7e7478599f109d6c28e94e7c276868327e4e0f59e10e82ba
+  metadata.gz: 6765527edf629b92546a00241f1efadc9ab02604641325de18e5d2dc67b44542
+  data.tar.gz: 28d1eb697ebc85e0c79c87c350a147f841a35ed2f2e099b63a7e2d4ec04ddd43
 SHA512:
-  metadata.gz: d3a1cee5997771a58a54d445027d4288fd4a5225f21aaa3243cfcf7bbf6c4455c0d8e76908e17f9968f7a6500dd7177cd417d14d5010646e68e996a1a4364136
-  data.tar.gz: 5cede795586ba2de68a2972f0b886c19b579e0e135315474f1fe87c303f6d869e58ece720bc34e60edf242a6261430f7c2442a46fa4cc0c778431fe27fe8e212
+  metadata.gz: ba084fdf92074f529a31b20e9a40e8ffd65de4aca095ea54844f971503881f980b1a4ca80ca0ed28c73296ec0937a38ef3bfd964e48591f6d45fe0f5f5177ea4
+  data.tar.gz: 614017afa71bcf42937b1287bf9d1e7a21d4fcff6f6a248c1c4030cf2ac600f4a0636e2cf09b064fe7bb18d39d1522d3d3a0d7350a0b48f1a5f4e3dbc69410b9

data/README.md

@@ -7,7 +7,7 @@ Fetch, Upload, Organize, and Distribute Software Packages
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v3
-- Package version: 0.6.0.dev01605193866
+- Package version: 0.7.0.dev01607743897
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://pulpproject.org](https://pulpproject.org)
 
@@ -24,16 +24,16 @@ gem build pulp_2to3_migration_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./pulp_2to3_migration_client-0.6.0.dev01605193866.gem
+gem install ./pulp_2to3_migration_client-0.7.0.dev01607743897.gem
 ```
 
-(for development, run `gem install --dev ./pulp_2to3_migration_client-0.6.0.dev01605193866.gem` to install the development dependencies)
+(for development, run `gem install --dev ./pulp_2to3_migration_client-0.7.0.dev01607743897.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.6.0.dev01605193866'
+    gem 'pulp_2to3_migration_client', '~> 0.7.0.dev01607743897'
 
 ### Install from Git
 
@@ -87,6 +87,7 @@ Class | Method | HTTP request | Description
 *Pulp2to3MigrationClient::MigrationPlansApi* | [**delete**](docs/MigrationPlansApi.md#delete) | **DELETE** {pulp_2to3_migration_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** {pulp_2to3_migration_migration_plan_href} | Inspect a migration plan
+*Pulp2to3MigrationClient::MigrationPlansApi* | [**reset**](docs/MigrationPlansApi.md#reset) | **POST** {pulp_2to3_migration_migration_plan_href}reset/ | Reset Pulp 3 data for plugins specified in the migration plan
 *Pulp2to3MigrationClient::MigrationPlansApi* | [**run**](docs/MigrationPlansApi.md#run) | **POST** {pulp_2to3_migration_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** {pulp_2to3_migration_pulp2_content_href} | Inspect a pulp2 content

data/docs/MigrationPlanRun.md

@@ -4,8 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**validate** | **Boolean** | If ``True``, migration cannot happen without successful validation of the Migration Plan | [optional] [default to false]
+**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]
+**skip_corrupted** | **Boolean** | If ``True``, skips corrupted or missing Pulp 2 content without causing a task failure. If you need this content, run a sync task in Pulp 3 for a repo of interest to bring any missing content back. Alternatively, repair it in Pulp 2and re-run the migration task. | [optional] [default to false]
 
 ## Code Sample
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 require 'Pulp2to3MigrationClient'
 
 instance = Pulp2to3MigrationClient::MigrationPlanRun.new(validate: null,
-                                 dry_run: null)
+                                 dry_run: null,
+                                 skip_corrupted: null)
 ```
 
 

data/docs/MigrationPlansApi.md

@@ -8,6 +8,7 @@ Method | HTTP request | Description
 [**delete**](MigrationPlansApi.md#delete) | **DELETE** {pulp_2to3_migration_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** {pulp_2to3_migration_migration_plan_href} | Inspect a migration plan
+[**reset**](MigrationPlansApi.md#reset) | **POST** {pulp_2to3_migration_migration_plan_href}reset/ | Reset Pulp 3 data for plugins specified in the migration plan
 [**run**](MigrationPlansApi.md#run) | **POST** {pulp_2to3_migration_migration_plan_href}run/ | Run migration plan
 
 
@@ -239,6 +240,61 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## reset
+
+> AsyncOperationResponse reset(pulp_2to3_migration_migration_plan_href, pulp2to3_migration_migration_plan)
+
+Reset Pulp 3 data for plugins specified in the migration plan
+
+Trigger an asynchronous task to remove data from Pulp 3 related to the plugins specified in the migration plan.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_2to3_migration_client'
+# setup authorization
+Pulp2to3MigrationClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Pulp2to3MigrationClient::MigrationPlansApi.new
+pulp_2to3_migration_migration_plan_href = 'pulp_2to3_migration_migration_plan_href_example' # String | 
+pulp2to3_migration_migration_plan = Pulp2to3MigrationClient::Pulp2to3MigrationMigrationPlan.new # Pulp2to3MigrationMigrationPlan | 
+
+begin
+  #Reset Pulp 3 data for plugins specified in the migration plan
+  result = api_instance.reset(pulp_2to3_migration_migration_plan_href, pulp2to3_migration_migration_plan)
+  p result
+rescue Pulp2to3MigrationClient::ApiError => e
+  puts "Exception when calling MigrationPlansApi->reset: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_2to3_migration_migration_plan_href** | **String**|  | 
+ **pulp2to3_migration_migration_plan** | [**Pulp2to3MigrationMigrationPlan**](Pulp2to3MigrationMigrationPlan.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## run
 
 > AsyncOperationResponse run(pulp_2to3_migration_migration_plan_href, migration_plan_run)

data/lib/pulp_2to3_migration_client/api/migration_plans_api.rb

@@ -282,6 +282,76 @@ module Pulp2to3MigrationClient
       return data, status_code, headers
     end
 
+    # Reset Pulp 3 data for plugins specified in the migration plan
+    # Trigger an asynchronous task to remove data from Pulp 3 related to the plugins specified in the migration plan.
+    # @param pulp_2to3_migration_migration_plan_href [String] 
+    # @param pulp2to3_migration_migration_plan [Pulp2to3MigrationMigrationPlan] 
+    # @param [Hash] opts the optional parameters
+    # @return [AsyncOperationResponse]
+    def reset(pulp_2to3_migration_migration_plan_href, pulp2to3_migration_migration_plan, opts = {})
+      data, _status_code, _headers = reset_with_http_info(pulp_2to3_migration_migration_plan_href, pulp2to3_migration_migration_plan, opts)
+      data
+    end
+
+    # Reset Pulp 3 data for plugins specified in the migration plan
+    # Trigger an asynchronous task to remove data from Pulp 3 related to the plugins specified in the migration plan.
+    # @param pulp_2to3_migration_migration_plan_href [String] 
+    # @param pulp2to3_migration_migration_plan [Pulp2to3MigrationMigrationPlan] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
+    def reset_with_http_info(pulp_2to3_migration_migration_plan_href, pulp2to3_migration_migration_plan, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MigrationPlansApi.reset ...'
+      end
+      # verify the required parameter 'pulp_2to3_migration_migration_plan_href' is set
+      if @api_client.config.client_side_validation && pulp_2to3_migration_migration_plan_href.nil?
+        fail ArgumentError, "Missing the required parameter 'pulp_2to3_migration_migration_plan_href' when calling MigrationPlansApi.reset"
+      end
+      # verify the required parameter 'pulp2to3_migration_migration_plan' is set
+      if @api_client.config.client_side_validation && pulp2to3_migration_migration_plan.nil?
+        fail ArgumentError, "Missing the required parameter 'pulp2to3_migration_migration_plan' when calling MigrationPlansApi.reset"
+      end
+      # resource path
+      local_var_path = '{pulp_2to3_migration_migration_plan_href}reset/'.sub('{' + 'pulp_2to3_migration_migration_plan_href' + '}', CGI.escape(pulp_2to3_migration_migration_plan_href.to_s).gsub('%2F', '/'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(pulp2to3_migration_migration_plan) 
+
+      # return_type
+      return_type = opts[:return_type] || 'AsyncOperationResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MigrationPlansApi#reset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Run migration plan
     # Trigger an asynchronous task to run a migration from Pulp 2.
     # @param pulp_2to3_migration_migration_plan_href [String] 

data/lib/pulp_2to3_migration_client/models/migration_plan_run.rb

@@ -15,17 +15,21 @@ require 'date'
 module Pulp2to3MigrationClient
   # A serializer for running a migration plan.
   class MigrationPlanRun
-    # If ``True``, migration cannot happen without successful validation of the Migration Plan
+    # If ``True``, migration cannot happen without successful validation of the Migration Plan.
     attr_accessor :validate
 
     # If ``True``, performs validation of a Migration Plan only, no migration is run.
     attr_accessor :dry_run
 
+    # If ``True``, skips corrupted or missing Pulp 2 content without causing a task failure. If you need this content, run a sync task in Pulp 3 for a repo of interest to bring any missing content back. Alternatively, repair it in Pulp 2and re-run the migration task.
+    attr_accessor :skip_corrupted
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'validate' => :'validate',
-        :'dry_run' => :'dry_run'
+        :'dry_run' => :'dry_run',
+        :'skip_corrupted' => :'skip_corrupted'
       }
     end
 
@@ -33,7 +37,8 @@ module Pulp2to3MigrationClient
     def self.openapi_types
       {
         :'validate' => :'Boolean',
-        :'dry_run' => :'Boolean'
+        :'dry_run' => :'Boolean',
+        :'skip_corrupted' => :'Boolean'
       }
     end
 
@@ -69,6 +74,12 @@ module Pulp2to3MigrationClient
       else
         self.dry_run = false
       end
+
+      if attributes.key?(:'skip_corrupted')
+        self.skip_corrupted = attributes[:'skip_corrupted']
+      else
+        self.skip_corrupted = false
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -90,7 +101,8 @@ module Pulp2to3MigrationClient
       return true if self.equal?(o)
       self.class == o.class &&
           validate == o.validate &&
-          dry_run == o.dry_run
+          dry_run == o.dry_run &&
+          skip_corrupted == o.skip_corrupted
     end
 
     # @see the `==` method
@@ -102,7 +114,7 @@ module Pulp2to3MigrationClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [validate, dry_run].hash
+      [validate, dry_run, skip_corrupted].hash
     end
 
     # Builds the object from hash

data/lib/pulp_2to3_migration_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.2.3
 =end
 
 module Pulp2to3MigrationClient
-  VERSION = '0.6.0.dev01605193866'
+  VERSION = '0.7.0.dev01607743897'
 end

data/spec/api/migration_plans_api_spec.rb

@@ -86,6 +86,19 @@ describe 'MigrationPlansApi' do
     end
   end
 
+  # unit tests for reset
+  # Reset Pulp 3 data for plugins specified in the migration plan
+  # Trigger an asynchronous task to remove data from Pulp 3 related to the plugins specified in the migration plan.
+  # @param pulp_2to3_migration_migration_plan_href 
+  # @param pulp2to3_migration_migration_plan 
+  # @param [Hash] opts the optional parameters
+  # @return [AsyncOperationResponse]
+  describe 'reset test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for run
   # Run migration plan
   # Trigger an asynchronous task to run a migration from Pulp 2.

data/spec/models/migration_plan_run_spec.rb

@@ -44,4 +44,10 @@ describe 'MigrationPlanRun' do
     end
   end
 
+  describe 'test attribute "skip_corrupted"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pulp_2to3_migration_client
 version: !ruby/object:Gem::Version
-  version: 0.6.0.dev01605193866
+  version: 0.7.0.dev01607743897
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2020-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -139,23 +139,23 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Pulp 3 API Ruby Gem
 test_files:
-- spec/api/migration_plans_api_spec.rb
 - spec/api/pulp2_content_api_spec.rb
 - spec/api/pulp2_repositories_api_spec.rb
+- spec/api/migration_plans_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
 - spec/models/pulp2to3_migration_migration_plan_spec.rb
-- spec/models/async_operation_response_spec.rb
-- spec/models/pulp2to3_migration_pulp2_repository_response_spec.rb
-- spec/models/pulp2to3_migration_migration_plan_response_spec.rb
-- spec/models/migration_plan_run_spec.rb
 - spec/models/paginatedpulp2to3_migration_pulp2_content_response_list_spec.rb
+- spec/models/paginatedpulp2to3_migration_pulp2_repository_response_list_spec.rb
+- spec/models/migration_plan_run_spec.rb
+- spec/models/pulp2to3_migration_migration_plan_response_spec.rb
 - spec/models/pulp2to3_migration_pulp2_content_response_spec.rb
+- spec/models/async_operation_response_spec.rb
+- spec/models/pulp2to3_migration_pulp2_repository_response_spec.rb
 - spec/models/paginatedpulp2to3_migration_migration_plan_response_list_spec.rb
-- spec/models/paginatedpulp2to3_migration_pulp2_repository_response_list_spec.rb
 - spec/spec_helper.rb