pulp_ansible_client 0.21.8 → 0.22.0

data/docs/ApiCollectionsApi.md

@@ -1,112 +0,0 @@
-# PulpAnsibleClient::ApiCollectionsApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get**](ApiCollectionsApi.md#get) | **GET** {ansible_collection_href}api/v2/collections/ | 
-[**post**](ApiCollectionsApi.md#post) | **POST** {ansible_collection_href}api/v2/collections/ | 
-
-
-
-## get
-
-> PaginatedGalaxyCollectionResponseList get(ansible_collection_href, opts)
-
-
-
-View for Collection models.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_ansible_client'
-
-api_instance = PulpAnsibleClient::ApiCollectionsApi.new
-ansible_collection_href = 'ansible_collection_href_example' # String | 
-opts = {
-  page: 56, # Integer | A page number within the paginated result set.
-  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
-  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
-}
-
-begin
-  result = api_instance.get(ansible_collection_href, opts)
-  p result
-rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling ApiCollectionsApi->get: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **ansible_collection_href** | **String**|  | 
- **page** | **Integer**| A page number within the paginated result set. | [optional] 
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
-
-### Return type
-
-[**PaginatedGalaxyCollectionResponseList**](PaginatedGalaxyCollectionResponseList.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## post
-
-> GalaxyCollectionResponse post(ansible_collection_href, galaxy_collection)
-
-
-
-Queues a task that creates a new Collection from an uploaded artifact.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_ansible_client'
-
-api_instance = PulpAnsibleClient::ApiCollectionsApi.new
-ansible_collection_href = 'ansible_collection_href_example' # String | 
-galaxy_collection = PulpAnsibleClient::GalaxyCollection.new # GalaxyCollection | 
-
-begin
-  result = api_instance.post(ansible_collection_href, galaxy_collection)
-  p result
-rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling ApiCollectionsApi->post: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **ansible_collection_href** | **String**|  | 
- **galaxy_collection** | [**GalaxyCollection**](GalaxyCollection.md)|  | 
-
-### Return type
-
-[**GalaxyCollectionResponse**](GalaxyCollectionResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-

data/docs/GalaxyCollection.md

@@ -1,23 +0,0 @@
-# PulpAnsibleClient::GalaxyCollection
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | 
-**name** | **String** |  | 
-**created** | **DateTime** |  | 
-**modified** | **DateTime** |  | 
-
-## Code Sample
-
-```ruby
-require 'PulpAnsibleClient'
-
-instance = PulpAnsibleClient::GalaxyCollection.new(id: null,
-                                 name: null,
-                                 created: null,
-                                 modified: null)
-```
-
-

data/docs/GalaxyCollectionResponse.md

@@ -1,31 +0,0 @@
-# PulpAnsibleClient::GalaxyCollectionResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | 
-**name** | **String** |  | 
-**namespace** | [**Object**](.md) | Create a namespace dict. | [optional] [readonly] 
-**href** | **String** | Get href. | [optional] [readonly] 
-**versions_url** | **String** | Get versions_url. | [optional] [readonly] 
-**created** | **DateTime** |  | 
-**modified** | **DateTime** |  | 
-**latest_version** | [**Object**](.md) | Get latest version. | [optional] [readonly] 
-
-## Code Sample
-
-```ruby
-require 'PulpAnsibleClient'
-
-instance = PulpAnsibleClient::GalaxyCollectionResponse.new(id: null,
-                                 name: null,
-                                 namespace: null,
-                                 href: null,
-                                 versions_url: null,
-                                 created: null,
-                                 modified: null,
-                                 latest_version: null)
-```
-
-

data/docs/GalaxyCollectionVersionResponse.md

@@ -1,27 +0,0 @@
-# PulpAnsibleClient::GalaxyCollectionVersionResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**version** | **String** |  | 
-**href** | **String** | Get href. | [optional] [readonly] 
-**namespace** | [**Object**](.md) | Create a namespace dict. | [optional] [readonly] 
-**collection** | [**Object**](.md) | Create a collection dict. | [optional] [readonly] 
-**artifact** | [**Object**](.md) | Create an artifact dict. | [optional] [readonly] 
-**metadata** | [**CollectionMetadataResponse**](CollectionMetadataResponse.md) |  | 
-
-## Code Sample
-
-```ruby
-require 'PulpAnsibleClient'
-
-instance = PulpAnsibleClient::GalaxyCollectionVersionResponse.new(version: null,
-                                 href: null,
-                                 namespace: null,
-                                 collection: null,
-                                 artifact: null,
-                                 metadata: null)
-```
-
-

data/docs/GalaxyDetailApi.md

@@ -1,61 +0,0 @@
-# PulpAnsibleClient::GalaxyDetailApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get**](GalaxyDetailApi.md#get) | **GET** {ansible_collection_href} | 
-
-
-
-## get
-
-> GalaxyCollectionResponse get(ansible_collection_href, opts)
-
-
-
-Get the detail view of a Collection.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_ansible_client'
-
-api_instance = PulpAnsibleClient::GalaxyDetailApi.new
-ansible_collection_href = 'ansible_collection_href_example' # String | 
-opts = {
-  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
-  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
-}
-
-begin
-  result = api_instance.get(ansible_collection_href, opts)
-  p result
-rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling GalaxyDetailApi->get: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **ansible_collection_href** | **String**|  | 
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
-
-### Return type
-
-[**GalaxyCollectionResponse**](GalaxyCollectionResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/PaginatedGalaxyCollectionVersionResponseList.md

@@ -1,23 +0,0 @@
-# PulpAnsibleClient::PaginatedGalaxyCollectionVersionResponseList
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<GalaxyCollectionVersionResponse>**](GalaxyCollectionVersionResponse.md) |  | 
-
-## Code Sample
-
-```ruby
-require 'PulpAnsibleClient'
-
-instance = PulpAnsibleClient::PaginatedGalaxyCollectionVersionResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?page=4,
-                                 previous: http://api.example.org/accounts/?page=2,
-                                 results: null)
-```
-
-

data/docs/PulpAnsibleApiV2CollectionsVersionsApi.md

@@ -1,66 +0,0 @@
-# PulpAnsibleClient::PulpAnsibleApiV2CollectionsVersionsApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get**](PulpAnsibleApiV2CollectionsVersionsApi.md#get) | **GET** /pulp_ansible/galaxy/{path}/api/v2/collections/{namespace}/{name}/versions/{version}/ | 
-
-
-
-## get
-
-> get(name, namespace, path, version, opts)
-
-
-
-Return a response to the \"GET\" action.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_ansible_client'
-
-api_instance = PulpAnsibleClient::PulpAnsibleApiV2CollectionsVersionsApi.new
-name = 'name_example' # String | 
-namespace = 'namespace_example' # String | 
-path = 'path_example' # String | 
-version = 'version_example' # String | 
-opts = {
-  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
-  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
-}
-
-begin
-  api_instance.get(name, namespace, path, version, opts)
-rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleApiV2CollectionsVersionsApi->get: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **name** | **String**|  | 
- **namespace** | **String**|  | 
- **path** | **String**|  | 
- **version** | **String**|  | 
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-

data/lib/pulp_ansible_client/api/api_collections_api.rb

@@ -1,159 +0,0 @@
-=begin
-#Pulp 3 API
-
-#Fetch, Upload, Organize, and Distribute Software Packages
-
-The version of the OpenAPI document: v3
-Contact: pulp-list@redhat.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
-
-=end
-
-require 'cgi'
-
-module PulpAnsibleClient
-  class ApiCollectionsApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # View for Collection models.
-    # @param ansible_collection_href [String] 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page A page number within the paginated result set.
-    # @option opts [Array<String>] :fields A list of fields to include in the response.
-    # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
-    # @return [PaginatedGalaxyCollectionResponseList]
-    def get(ansible_collection_href, opts = {})
-      data, _status_code, _headers = get_with_http_info(ansible_collection_href, opts)
-      data
-    end
-
-    # View for Collection models.
-    # @param ansible_collection_href [String] 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page A page number within the paginated result set.
-    # @option opts [Array<String>] :fields A list of fields to include in the response.
-    # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
-    # @return [Array<(PaginatedGalaxyCollectionResponseList, Integer, Hash)>] PaginatedGalaxyCollectionResponseList data, response status code and response headers
-    def get_with_http_info(ansible_collection_href, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: ApiCollectionsApi.get ...'
-      end
-      # verify the required parameter 'ansible_collection_href' is set
-      if @api_client.config.client_side_validation && ansible_collection_href.nil?
-        fail ArgumentError, "Missing the required parameter 'ansible_collection_href' when calling ApiCollectionsApi.get"
-      end
-      # resource path
-      local_var_path = '{ansible_collection_href}api/v2/collections/'.sub('{' + 'ansible_collection_href' + '}', CGI.escape(ansible_collection_href.to_s).gsub('%2F', '/'))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
-      query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
-      query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_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] || 'PaginatedGalaxyCollectionResponseList' 
-
-      # auth_names
-      auth_names = opts[:auth_names] || []
-
-      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: ApiCollectionsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Queues a task that creates a new Collection from an uploaded artifact.
-    # @param ansible_collection_href [String] 
-    # @param galaxy_collection [GalaxyCollection] 
-    # @param [Hash] opts the optional parameters
-    # @return [GalaxyCollectionResponse]
-    def post(ansible_collection_href, galaxy_collection, opts = {})
-      data, _status_code, _headers = post_with_http_info(ansible_collection_href, galaxy_collection, opts)
-      data
-    end
-
-    # Queues a task that creates a new Collection from an uploaded artifact.
-    # @param ansible_collection_href [String] 
-    # @param galaxy_collection [GalaxyCollection] 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(GalaxyCollectionResponse, Integer, Hash)>] GalaxyCollectionResponse data, response status code and response headers
-    def post_with_http_info(ansible_collection_href, galaxy_collection, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: ApiCollectionsApi.post ...'
-      end
-      # verify the required parameter 'ansible_collection_href' is set
-      if @api_client.config.client_side_validation && ansible_collection_href.nil?
-        fail ArgumentError, "Missing the required parameter 'ansible_collection_href' when calling ApiCollectionsApi.post"
-      end
-      # verify the required parameter 'galaxy_collection' is set
-      if @api_client.config.client_side_validation && galaxy_collection.nil?
-        fail ArgumentError, "Missing the required parameter 'galaxy_collection' when calling ApiCollectionsApi.post"
-      end
-      # resource path
-      local_var_path = '{ansible_collection_href}api/v2/collections/'.sub('{' + 'ansible_collection_href' + '}', CGI.escape(ansible_collection_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(galaxy_collection) 
-
-      # return_type
-      return_type = opts[:return_type] || 'GalaxyCollectionResponse' 
-
-      # auth_names
-      auth_names = opts[:auth_names] || []
-
-      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: ApiCollectionsApi#post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end

data/lib/pulp_ansible_client/api/galaxy_detail_api.rb

@@ -1,88 +0,0 @@
-=begin
-#Pulp 3 API
-
-#Fetch, Upload, Organize, and Distribute Software Packages
-
-The version of the OpenAPI document: v3
-Contact: pulp-list@redhat.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
-
-=end
-
-require 'cgi'
-
-module PulpAnsibleClient
-  class GalaxyDetailApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Get the detail view of a Collection.
-    # @param ansible_collection_href [String] 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :fields A list of fields to include in the response.
-    # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
-    # @return [GalaxyCollectionResponse]
-    def get(ansible_collection_href, opts = {})
-      data, _status_code, _headers = get_with_http_info(ansible_collection_href, opts)
-      data
-    end
-
-    # Get the detail view of a Collection.
-    # @param ansible_collection_href [String] 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :fields A list of fields to include in the response.
-    # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
-    # @return [Array<(GalaxyCollectionResponse, Integer, Hash)>] GalaxyCollectionResponse data, response status code and response headers
-    def get_with_http_info(ansible_collection_href, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: GalaxyDetailApi.get ...'
-      end
-      # verify the required parameter 'ansible_collection_href' is set
-      if @api_client.config.client_side_validation && ansible_collection_href.nil?
-        fail ArgumentError, "Missing the required parameter 'ansible_collection_href' when calling GalaxyDetailApi.get"
-      end
-      # resource path
-      local_var_path = '{ansible_collection_href}'.sub('{' + 'ansible_collection_href' + '}', CGI.escape(ansible_collection_href.to_s).gsub('%2F', '/'))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
-      query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_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] || 'GalaxyCollectionResponse' 
-
-      # auth_names
-      auth_names = opts[:auth_names] || []
-
-      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: GalaxyDetailApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end