pulp_ansible_client 0.2.0b1

data/docs/RemotesCollectionApi.md

@@ -0,0 +1,411 @@
+# PulpAnsibleClient::RemotesCollectionApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](RemotesCollectionApi.md#create) | **POST** /pulp/api/v3/remotes/ansible/collection/ | Create a collection remote
+[**delete**](RemotesCollectionApi.md#delete) | **DELETE** {collection_remote_href} | Delete a collection remote
+[**list**](RemotesCollectionApi.md#list) | **GET** /pulp/api/v3/remotes/ansible/collection/ | List collection remotes
+[**partial_update**](RemotesCollectionApi.md#partial_update) | **PATCH** {collection_remote_href} | Partially update a collection remote
+[**read**](RemotesCollectionApi.md#read) | **GET** {collection_remote_href} | Inspect a collection remote
+[**sync**](RemotesCollectionApi.md#sync) | **POST** {collection_remote_href}sync/ | 
+[**update**](RemotesCollectionApi.md#update) | **PUT** {collection_remote_href} | Update a collection remote
+
+
+
+## create
+
+> CollectionRemote create(data)
+
+Create a collection remote
+
+ViewSet for Collection Remotes.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesCollectionApi.new
+data = PulpAnsibleClient::CollectionRemote.new # CollectionRemote | 
+
+begin
+  #Create a collection remote
+  result = api_instance.create(data)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesCollectionApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**CollectionRemote**](CollectionRemote.md)|  | 
+
+### Return type
+
+[**CollectionRemote**](CollectionRemote.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> AsyncOperationResponse delete(collection_remote_href)
+
+Delete a collection remote
+
+Trigger an asynchronous delete task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesCollectionApi.new
+collection_remote_href = 'collection_remote_href_example' # String | URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/
+
+begin
+  #Delete a collection remote
+  result = api_instance.delete(collection_remote_href)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesCollectionApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **collection_remote_href** | **String**| URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2004 list(opts)
+
+List collection remotes
+
+ViewSet for Collection Remotes.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesCollectionApi.new
+opts = {
+  name: 'name_example', # String | 
+  name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
+  _last_updated__lt: '_last_updated__lt_example', # String | Filter results where _last_updated is less than value
+  _last_updated__lte: '_last_updated__lte_example', # String | Filter results where _last_updated is less than or equal to value
+  _last_updated__gt: '_last_updated__gt_example', # String | Filter results where _last_updated is greater than value
+  _last_updated__gte: '_last_updated__gte_example', # String | Filter results where _last_updated is greater than or equal to value
+  _last_updated__range: '_last_updated__range_example', # String | Filter results where _last_updated is between two comma separated values
+  _last_updated: '_last_updated_example', # String | ISO 8601 formatted dates are supported
+  page: 56, # Integer | A page number within the paginated result set.
+  page_size: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  #List collection remotes
+  result = api_instance.list(opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesCollectionApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**|  | [optional] 
+ **name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional] 
+ **_last_updated__lt** | **String**| Filter results where _last_updated is less than value | [optional] 
+ **_last_updated__lte** | **String**| Filter results where _last_updated is less than or equal to value | [optional] 
+ **_last_updated__gt** | **String**| Filter results where _last_updated is greater than value | [optional] 
+ **_last_updated__gte** | **String**| Filter results where _last_updated is greater than or equal to value | [optional] 
+ **_last_updated__range** | **String**| Filter results where _last_updated is between two comma separated values | [optional] 
+ **_last_updated** | **String**| ISO 8601 formatted dates are supported | [optional] 
+ **page** | **Integer**| A page number within the paginated result set. | [optional] 
+ **page_size** | **Integer**| Number of results to return per page. | [optional] 
+
+### Return type
+
+[**InlineResponse2004**](InlineResponse2004.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(collection_remote_href, data)
+
+Partially update a collection remote
+
+Trigger an asynchronous partial update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesCollectionApi.new
+collection_remote_href = 'collection_remote_href_example' # String | URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/
+data = PulpAnsibleClient::CollectionRemote.new # CollectionRemote | 
+
+begin
+  #Partially update a collection remote
+  result = api_instance.partial_update(collection_remote_href, data)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesCollectionApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **collection_remote_href** | **String**| URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ | 
+ **data** | [**CollectionRemote**](CollectionRemote.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## read
+
+> CollectionRemote read(collection_remote_href)
+
+Inspect a collection remote
+
+ViewSet for Collection Remotes.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesCollectionApi.new
+collection_remote_href = 'collection_remote_href_example' # String | URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/
+
+begin
+  #Inspect a collection remote
+  result = api_instance.read(collection_remote_href)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesCollectionApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **collection_remote_href** | **String**| URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ | 
+
+### Return type
+
+[**CollectionRemote**](CollectionRemote.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## sync
+
+> AsyncOperationResponse sync(collection_remote_href, data)
+
+
+
+Trigger an asynchronous task to sync Collection content.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesCollectionApi.new
+collection_remote_href = 'collection_remote_href_example' # String | URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/
+data = PulpAnsibleClient::RepositorySyncURL.new # RepositorySyncURL | 
+
+begin
+  result = api_instance.sync(collection_remote_href, data)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesCollectionApi->sync: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **collection_remote_href** | **String**| URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ | 
+ **data** | [**RepositorySyncURL**](RepositorySyncURL.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(collection_remote_href, data)
+
+Update a collection remote
+
+Trigger an asynchronous update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::RemotesCollectionApi.new
+collection_remote_href = 'collection_remote_href_example' # String | URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/
+data = PulpAnsibleClient::CollectionRemote.new # CollectionRemote | 
+
+begin
+  #Update a collection remote
+  result = api_instance.update(collection_remote_href, data)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesCollectionApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **collection_remote_href** | **String**| URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ | 
+ **data** | [**CollectionRemote**](CollectionRemote.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/RepositorySyncURL.md

@@ -0,0 +1,19 @@
+# PulpAnsibleClient::RepositorySyncURL
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**repository** | **String** | A URI of the repository to be synchronized. | 
+**mirror** | **Boolean** | If ``True``, synchronization will remove all content that is not present in the remote repository. If ``False``, sync will be additive only. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'PulpAnsibleClient'
+
+instance = PulpAnsibleClient::RepositorySyncURL.new(repository: null,
+                                 mirror: null)
+```
+
+

data/docs/Role.md

@@ -0,0 +1,29 @@
+# PulpAnsibleClient::Role
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_created** | **DateTime** | Timestamp of creation. | [optional] 
+**_artifact** | **String** | Artifact file representing the physical content | 
+**_href** | **String** |  | [optional] 
+**_type** | **String** |  | [optional] 
+**version** | **String** |  | 
+**name** | **String** |  | 
+**namespace** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpAnsibleClient'
+
+instance = PulpAnsibleClient::Role.new(_created: null,
+                                 _artifact: null,
+                                 _href: null,
+                                 _type: null,
+                                 version: null,
+                                 name: null,
+                                 namespace: null)
+```
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://openapi-generator.tech
+#
+# 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"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+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://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${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://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/pulp_ansible_client/api/ansible_collections_api.rb

@@ -0,0 +1,94 @@
+=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.0.0
+
+=end
+
+require 'uri'
+
+module PulpAnsibleClient
+  class AnsibleCollectionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Upload a collection
+    # Create an artifact and trigger an asynchronous task to create Collection content from it.
+    # @param file [File] The Collection tarball.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :sha256 An optional sha256 checksum of the uploaded file.
+    # @return [AsyncOperationResponse]
+    def upload_collection(file, opts = {})
+      data, _status_code, _headers = upload_collection_with_http_info(file, opts)
+      data
+    end
+
+    # Upload a collection
+    # Create an artifact and trigger an asynchronous task to create Collection content from it.
+    # @param file [File] The Collection tarball.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :sha256 An optional sha256 checksum of the uploaded file.
+    # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
+    def upload_collection_with_http_info(file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnsibleCollectionsApi.upload_collection ...'
+      end
+      # verify the required parameter 'file' is set
+      if @api_client.config.client_side_validation && file.nil?
+        fail ArgumentError, "Missing the required parameter 'file' when calling AnsibleCollectionsApi.upload_collection"
+      end
+      if @api_client.config.client_side_validation && !opts[:'sha256'].nil? && opts[:'sha256'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"sha256"]" when calling AnsibleCollectionsApi.upload_collection, the character length must be great than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/ansible/collections/'
+
+      # 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(['multipart/form-data', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['file'] = file
+      form_params['sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil?
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # 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: AnsibleCollectionsApi#upload_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end