pulp_2to3_migration_client 0.0.1a1.dev01569436440

data/docs/Pulp2contentApi.md

@@ -0,0 +1,148 @@
+# Pulp2to3MigrationClient::Pulp2contentApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](Pulp2contentApi.md#list) | **GET** /pulp/api/v3/pulp2content/ | List pulp2 contents
+[**read**](Pulp2contentApi.md#read) | **GET** {pulp2_content_href} | Inspect a pulp2 content
+
+
+
+## list
+
+> InlineResponse2001 list(opts)
+
+List pulp2 contents
+
+ViewSet for Pulp2Content model.
+
+### 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::Pulp2contentApi.new
+opts = {
+  pulp2_id: 'pulp2_id_example', # String | 
+  pulp2_id__in: 'pulp2_id__in_example', # String | Filter results where pulp2_id is in a comma-separated list of values
+  pulp2_content_type_id: 'pulp2_content_type_id_example', # String | 
+  pulp2_content_type_id__in: 'pulp2_content_type_id__in_example', # String | Filter results where pulp2_content_type_id is in a comma-separated list of values
+  pulp2_last_updated__lt: 3.4, # Float | Filter results where pulp2_last_updated is less than value
+  pulp2_last_updated__lte: 3.4, # Float | Filter results where pulp2_last_updated is less than or equal to value
+  pulp2_last_updated__gt: 3.4, # Float | Filter results where pulp2_last_updated is greater than value
+  pulp2_last_updated__gte: 3.4, # Float | Filter results where pulp2_last_updated is greater than or equal to value
+  pulp2_last_updated__range: 3.4, # Float | Filter results where pulp2_last_updated is between two comma separated values
+  pulp3_content: 'pulp3_content_example', # String | Foreign Key referenced by HREF
+  pulp2_last_updated: 'pulp2_last_updated_example', # String | ISO 8601 formatted dates are supported
+  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.
+}
+
+begin
+  #List pulp2 contents
+  result = api_instance.list(opts)
+  p result
+rescue Pulp2to3MigrationClient::ApiError => e
+  puts "Exception when calling Pulp2contentApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp2_id** | **String**|  | [optional] 
+ **pulp2_id__in** | **String**| Filter results where pulp2_id is in a comma-separated list of values | [optional] 
+ **pulp2_content_type_id** | **String**|  | [optional] 
+ **pulp2_content_type_id__in** | **String**| Filter results where pulp2_content_type_id is in a comma-separated list of values | [optional] 
+ **pulp2_last_updated__lt** | **Float**| Filter results where pulp2_last_updated is less than value | [optional] 
+ **pulp2_last_updated__lte** | **Float**| Filter results where pulp2_last_updated is less than or equal to value | [optional] 
+ **pulp2_last_updated__gt** | **Float**| Filter results where pulp2_last_updated is greater than value | [optional] 
+ **pulp2_last_updated__gte** | **Float**| Filter results where pulp2_last_updated is greater than or equal to value | [optional] 
+ **pulp2_last_updated__range** | **Float**| Filter results where pulp2_last_updated is between two comma separated values | [optional] 
+ **pulp3_content** | **String**| Foreign Key referenced by HREF | [optional] 
+ **pulp2_last_updated** | **String**| ISO 8601 formatted dates are supported | [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] 
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> Pulp2Content read(pulp2_content_href, opts)
+
+Inspect a pulp2 content
+
+ViewSet for Pulp2Content model.
+
+### 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::Pulp2contentApi.new
+pulp2_content_href = 'pulp2_content_href_example' # String | URI of Pulp2 Content. e.g.: /pulp/api/v3/pulp2content/1/
+opts = {
+  fields: 'fields_example' # String | A list of fields to include in the response.
+}
+
+begin
+  #Inspect a pulp2 content
+  result = api_instance.read(pulp2_content_href, opts)
+  p result
+rescue Pulp2to3MigrationClient::ApiError => e
+  puts "Exception when calling Pulp2contentApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp2_content_href** | **String**| URI of Pulp2 Content. e.g.: /pulp/api/v3/pulp2content/1/ | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+
+### Return type
+
+[**Pulp2Content**](Pulp2Content.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/git_push.sh

@@ -0,0 +1,58 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/pulp_2to3_migration_client/api/migration_plans_api.rb

@@ -0,0 +1,346 @@
+=begin
+#Pulp 3 API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.3-SNAPSHOT
+
+=end
+
+require 'cgi'
+
+module Pulp2to3MigrationClient
+  class MigrationPlansApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a migration plan
+    # MigrationPlan ViewSet.
+    # @param data [MigrationPlan] 
+    # @param [Hash] opts the optional parameters
+    # @return [MigrationPlan]
+    def create(data, opts = {})
+      data, _status_code, _headers = create_with_http_info(data, opts)
+      data
+    end
+
+    # Create a migration plan
+    # MigrationPlan ViewSet.
+    # @param data [MigrationPlan] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MigrationPlan, Integer, Hash)>] MigrationPlan data, response status code and response headers
+    def create_with_http_info(data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MigrationPlansApi.create ...'
+      end
+      # verify the required parameter 'data' is set
+      if @api_client.config.client_side_validation && data.nil?
+        fail ArgumentError, "Missing the required parameter 'data' when calling MigrationPlansApi.create"
+      end
+      # resource path
+      local_var_path = '/pulp/api/v3/migration-plans/'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(data) 
+
+      # return_type
+      return_type = opts[:return_type] || 'MigrationPlan' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic']
+
+      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#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a migration plan
+    # MigrationPlan ViewSet.
+    # @param migration_plan_href [String] URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete(migration_plan_href, opts = {})
+      delete_with_http_info(migration_plan_href, opts)
+      nil
+    end
+
+    # Delete a migration plan
+    # MigrationPlan ViewSet.
+    # @param migration_plan_href [String] URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_with_http_info(migration_plan_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MigrationPlansApi.delete ...'
+      end
+      # verify the required parameter 'migration_plan_href' is set
+      if @api_client.config.client_side_validation && migration_plan_href.nil?
+        fail ArgumentError, "Missing the required parameter 'migration_plan_href' when calling MigrationPlansApi.delete"
+      end
+      # resource path
+      local_var_path = '{migration_plan_href}'.sub('{' + 'migration_plan_href' + '}', CGI.escape(migration_plan_href.to_s).gsub('%2F', '/'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic']
+
+      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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MigrationPlansApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List migration plans
+    # MigrationPlan ViewSet.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @option opts [String] :fields A list of fields to include in the response.
+    # @return [InlineResponse200]
+    def list(opts = {})
+      data, _status_code, _headers = list_with_http_info(opts)
+      data
+    end
+
+    # List migration plans
+    # MigrationPlan ViewSet.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @option opts [String] :fields A list of fields to include in the response.
+    # @return [Array<(InlineResponse200, Integer, Hash)>] InlineResponse200 data, response status code and response headers
+    def list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MigrationPlansApi.list ...'
+      end
+      # resource path
+      local_var_path = '/pulp/api/v3/migration-plans/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'InlineResponse200' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic']
+
+      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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MigrationPlansApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Inspect a migration plan
+    # MigrationPlan ViewSet.
+    # @param migration_plan_href [String] URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :fields A list of fields to include in the response.
+    # @return [MigrationPlan]
+    def read(migration_plan_href, opts = {})
+      data, _status_code, _headers = read_with_http_info(migration_plan_href, opts)
+      data
+    end
+
+    # Inspect a migration plan
+    # MigrationPlan ViewSet.
+    # @param migration_plan_href [String] URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :fields A list of fields to include in the response.
+    # @return [Array<(MigrationPlan, Integer, Hash)>] MigrationPlan data, response status code and response headers
+    def read_with_http_info(migration_plan_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MigrationPlansApi.read ...'
+      end
+      # verify the required parameter 'migration_plan_href' is set
+      if @api_client.config.client_side_validation && migration_plan_href.nil?
+        fail ArgumentError, "Missing the required parameter 'migration_plan_href' when calling MigrationPlansApi.read"
+      end
+      # resource path
+      local_var_path = '{migration_plan_href}'.sub('{' + 'migration_plan_href' + '}', CGI.escape(migration_plan_href.to_s).gsub('%2F', '/'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'MigrationPlan' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic']
+
+      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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MigrationPlansApi#read\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 migration_plan_href [String] URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/
+    # @param data [MigrationPlanRun] 
+    # @param [Hash] opts the optional parameters
+    # @return [AsyncOperationResponse]
+    def run(migration_plan_href, data, opts = {})
+      data, _status_code, _headers = run_with_http_info(migration_plan_href, data, opts)
+      data
+    end
+
+    # Run migration plan
+    # Trigger an asynchronous task to run a migration from Pulp 2.
+    # @param migration_plan_href [String] URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/
+    # @param data [MigrationPlanRun] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
+    def run_with_http_info(migration_plan_href, data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MigrationPlansApi.run ...'
+      end
+      # verify the required parameter 'migration_plan_href' is set
+      if @api_client.config.client_side_validation && migration_plan_href.nil?
+        fail ArgumentError, "Missing the required parameter 'migration_plan_href' when calling MigrationPlansApi.run"
+      end
+      # verify the required parameter 'data' is set
+      if @api_client.config.client_side_validation && data.nil?
+        fail ArgumentError, "Missing the required parameter 'data' when calling MigrationPlansApi.run"
+      end
+      # resource path
+      local_var_path = '{migration_plan_href}run/'.sub('{' + 'migration_plan_href' + '}', CGI.escape(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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(data) 
+
+      # return_type
+      return_type = opts[:return_type] || 'AsyncOperationResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic']
+
+      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#run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end