pulp_ansible_client 0.2.0b15 → 0.2.0

data/docs/PulpAnsibleGalaxyApiCollectionsApi.md

@@ -4,91 +4,31 @@ All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create**](PulpAnsibleGalaxyApiCollectionsApi.md#create) | **POST** /pulp_ansible/galaxy/{path}/api/v2/collections/ | 
-[**list**](PulpAnsibleGalaxyApiCollectionsApi.md#list) | **GET** /pulp_ansible/galaxy/{path}/api/v2/collections/ | 
-[**list_0**](PulpAnsibleGalaxyApiCollectionsApi.md#list_0) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collections/ | 
-[**read**](PulpAnsibleGalaxyApiCollectionsApi.md#read) | **GET** {collection_href} | 
+[**list**](PulpAnsibleGalaxyApiCollectionsApi.md#list) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collections/ | 
+[**read**](PulpAnsibleGalaxyApiCollectionsApi.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/ | 
+[**update**](PulpAnsibleGalaxyApiCollectionsApi.md#update) | **PUT** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/ | 
 
 
 
-## create
-
-> GalaxyCollection create(path, data)
-
-
-
-Queues a task that creates a new Collection from an uploaded artifact.
-
-### 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::PulpAnsibleGalaxyApiCollectionsApi.new
-path = 'path_example' # String | 
-data = PulpAnsibleClient::GalaxyCollection.new # GalaxyCollection | 
-
-begin
-  result = api_instance.create(path, data)
-  p result
-rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleGalaxyApiCollectionsApi->create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **path** | **String**|  | 
- **data** | [**GalaxyCollection**](GalaxyCollection.md)|  | 
-
-### Return type
-
-[**GalaxyCollection**](GalaxyCollection.md)
-
-### Authorization
-
-[Basic](../README.md#Basic)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
 ## list
 
-> InlineResponse20011 list(path, opts)
+> InlineResponse20013 list(path, opts)
 
 
 
-View for Collection models.
+ViewSet for Collections.
 
 ### 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::PulpAnsibleGalaxyApiCollectionsApi.new
 path = 'path_example' # String | 
 opts = {
-  page: 56, # Integer | A page number within the paginated result set.
+  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.
 }
@@ -107,17 +47,18 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **path** | **String**|  | 
- **page** | **Integer**| A page number within the paginated result set. | [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
 
-[**InlineResponse20011**](InlineResponse20011.md)
+[**InlineResponse20013**](InlineResponse20013.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+No authorization required
 
 ### HTTP request headers
 
@@ -125,9 +66,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## list_0
+## read
 
-> InlineResponse20013 list_0(path, opts)
+> CollectionResponse read(name, namespace, path, opts)
 
 
 
@@ -138,27 +79,21 @@ ViewSet for Collections.
 ```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::PulpAnsibleGalaxyApiCollectionsApi.new
+name = 'name_example' # String | 
+namespace = 'namespace_example' # String | 
 path = 'path_example' # String | 
 opts = {
-  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
-  result = api_instance.list_0(path, opts)
+  result = api_instance.read(name, namespace, path, opts)
   p result
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleGalaxyApiCollectionsApi->list_0: #{e}"
+  puts "Exception when calling PulpAnsibleGalaxyApiCollectionsApi->read: #{e}"
 end
 ```
 
@@ -167,19 +102,19 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **name** | **String**|  | 
+ **namespace** | **String**|  | 
  **path** | **String**|  | 
- **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
 
-[**InlineResponse20013**](InlineResponse20013.md)
+[**CollectionResponse**](CollectionResponse.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+No authorization required
 
 ### HTTP request headers
 
@@ -187,38 +122,31 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## read
+## update
 
-> GalaxyCollection read(collection_href, opts)
+> CollectionResponse update(name, namespace, path, collection)
 
 
 
-Get the detail view of a Collection.
+Update a Collection object.
 
 ### 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::PulpAnsibleGalaxyApiCollectionsApi.new
-collection_href = 'collection_href_example' # String | URI of Collection. e.g.: /pulp_ansible/galaxy/1/api/v2/collections/1/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.
-}
+name = 'name_example' # String | 
+namespace = 'namespace_example' # String | 
+path = 'path_example' # String | 
+collection = PulpAnsibleClient::Collection.new # Collection | 
 
 begin
-  result = api_instance.read(collection_href, opts)
+  result = api_instance.update(name, namespace, path, collection)
   p result
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleGalaxyApiCollectionsApi->read: #{e}"
+  puts "Exception when calling PulpAnsibleGalaxyApiCollectionsApi->update: #{e}"
 end
 ```
 
@@ -227,20 +155,21 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **collection_href** | **String**| URI of Collection. e.g.: /pulp_ansible/galaxy/1/api/v2/collections/1/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] 
+ **name** | **String**|  | 
+ **namespace** | **String**|  | 
+ **path** | **String**|  | 
+ **collection** | [**Collection**](Collection.md)|  | 
 
 ### Return type
 
-[**GalaxyCollection**](GalaxyCollection.md)
+[**CollectionResponse**](CollectionResponse.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json
 

data/docs/PulpAnsibleGalaxyApiV2VersionsApi.md

@@ -4,44 +4,38 @@ All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**list**](PulpAnsibleGalaxyApiV2VersionsApi.md#list) | **GET** {collection_href}versions/ | 
+[**read**](PulpAnsibleGalaxyApiV2VersionsApi.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/v2/collections/{namespace}/{name}/versions/{version}/ | 
 
 
 
-## list
+## read
 
-> InlineResponse20012 list(collection_href, opts)
+> read(name, namespace, path, version, opts)
 
 
 
-APIView for Collections by namespace/name.
+Return a response to the \"GET\" action.
 
 ### 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::PulpAnsibleGalaxyApiV2VersionsApi.new
-collection_href = 'collection_href_example' # String | URI of Collection. e.g.: /pulp_ansible/galaxy/1/api/v2/collections/1/1/
+name = 'name_example' # String | 
+namespace = 'namespace_example' # String | 
+path = 'path_example' # String | 
+version = 'version_example' # String | 
 opts = {
-  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
-  result = api_instance.list(collection_href, opts)
-  p result
+  api_instance.read(name, namespace, path, version, opts)
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleGalaxyApiV2VersionsApi->list: #{e}"
+  puts "Exception when calling PulpAnsibleGalaxyApiV2VersionsApi->read: #{e}"
 end
 ```
 
@@ -50,22 +44,23 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **collection_href** | **String**| URI of Collection. e.g.: /pulp_ansible/galaxy/1/api/v2/collections/1/1/ | 
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **name** | **String**|  | 
+ **namespace** | **String**|  | 
+ **path** | **String**|  | 
+ **version** | **String**|  | 
  **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
 
-[**InlineResponse20012**](InlineResponse20012.md)
+nil (empty response body)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+No authorization required
 
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: application/json
+- **Accept**: Not defined
 

data/docs/PulpAnsibleGalaxyApiV3CollectionsApi.md

@@ -5,7 +5,6 @@ All URIs are relative to *http://pulp*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**create**](PulpAnsibleGalaxyApiV3CollectionsApi.md#create) | **POST** /pulp_ansible/galaxy/{path}/api/v3/artifacts/collections/ | Upload a collection
-[**read**](PulpAnsibleGalaxyApiV3CollectionsApi.md#read) | **GET** {collection_import_href} | Inspect a collection import
 
 
 
@@ -22,12 +21,6 @@ Create an artifact and trigger an asynchronous task to create Collection content
 ```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::PulpAnsibleGalaxyApiV3CollectionsApi.new
 path = 'path_example' # String | 
@@ -66,71 +59,10 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+No authorization required
 
 ### HTTP request headers
 
 - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
 - **Accept**: application/json
 
-
-## read
-
-> CollectionImportDetail read(collection_import_href, opts)
-
-Inspect a collection import
-
-Returns a CollectionImport object.
-
-### 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::PulpAnsibleGalaxyApiV3CollectionsApi.new
-collection_import_href = 'collection_import_href_example' # String | URI of Collection Import. e.g.: /pulp_ansible/galaxy/1/api/v3/imports/collections/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.
-  since: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Filter messages since a given timestamp
-}
-
-begin
-  #Inspect a collection import
-  result = api_instance.read(collection_import_href, opts)
-  p result
-rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleGalaxyApiV3CollectionsApi->read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **collection_import_href** | **String**| URI of Collection Import. e.g.: /pulp_ansible/galaxy/1/api/v3/imports/collections/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] 
- **since** | **DateTime**| Filter messages since a given timestamp | [optional] 
-
-### Return type
-
-[**CollectionImportDetail**](CollectionImportDetail.md)
-
-### Authorization
-
-[Basic](../README.md#Basic)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/PulpAnsibleGalaxyApiV3CollectionsCertifiedApi.md

@@ -0,0 +1,63 @@
+# PulpAnsibleClient::PulpAnsibleGalaxyApiV3CollectionsCertifiedApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**set_certified**](PulpAnsibleGalaxyApiV3CollectionsCertifiedApi.md#set_certified) | **PUT** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/versions/{version}/certified/ | 
+
+
+
+## set_certified
+
+> CollectionVersionResponse set_certified(name, namespace, path, version, collection_version)
+
+
+
+Set collection version certified status.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+
+api_instance = PulpAnsibleClient::PulpAnsibleGalaxyApiV3CollectionsCertifiedApi.new
+name = 'name_example' # String | 
+namespace = 'namespace_example' # String | 
+path = 'path_example' # String | 
+version = 'version_example' # String | 
+collection_version = PulpAnsibleClient::CollectionVersion.new # CollectionVersion | 
+
+begin
+  result = api_instance.set_certified(name, namespace, path, version, collection_version)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleGalaxyApiV3CollectionsCertifiedApi->set_certified: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**|  | 
+ **namespace** | **String**|  | 
+ **path** | **String**|  | 
+ **version** | **String**|  | 
+ **collection_version** | [**CollectionVersion**](CollectionVersion.md)|  | 
+
+### Return type
+
+[**CollectionVersionResponse**](CollectionVersionResponse.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/PulpAnsibleGalaxyApiV3VersionsApi.md

@@ -0,0 +1,172 @@
+# PulpAnsibleClient::PulpAnsibleGalaxyApiV3VersionsApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](PulpAnsibleGalaxyApiV3VersionsApi.md#list) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/versions/ | 
+[**read**](PulpAnsibleGalaxyApiV3VersionsApi.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/versions/{version}/ | 
+
+
+
+## list
+
+> InlineResponse20014 list(name, namespace, path, opts)
+
+
+
+Returns paginated CollectionVersions list.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+
+api_instance = PulpAnsibleClient::PulpAnsibleGalaxyApiV3VersionsApi.new
+name = 'name_example' # String | 
+namespace = 'namespace_example' # String | 
+path = 'path_example' # String | 
+opts = {
+  certification: 'certification_example', # String | certification
+  deprecated: 'deprecated_example', # String | deprecated
+  is_highest: 'is_highest_example', # String | is_highest
+  limit: 56, # Integer | Number of results to return per page.
+  name2: 'name_example', # String | name
+  namespace2: 'namespace_example', # String | namespace
+  offset: 56, # Integer | The initial index from which to return the results.
+  q: 'q_example', # String | q
+  repository_version: 'repository_version_example', # String | repository_version
+  repository_version_added: 'repository_version_added_example', # String | repository_version_added
+  repository_version_removed: 'repository_version_removed_example', # String | repository_version_removed
+  tags: 'tags_example', # String | tags
+  version: 'version_example', # String | version
+  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
+  result = api_instance.list(name, namespace, path, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleGalaxyApiV3VersionsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**|  | 
+ **namespace** | **String**|  | 
+ **path** | **String**|  | 
+ **certification** | **String**| certification | [optional] 
+ **deprecated** | **String**| deprecated | [optional] 
+ **is_highest** | **String**| is_highest | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **name2** | **String**| name | [optional] 
+ **namespace2** | **String**| namespace | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **q** | **String**| q | [optional] 
+ **repository_version** | **String**| repository_version | [optional] 
+ **repository_version_added** | **String**| repository_version_added | [optional] 
+ **repository_version_removed** | **String**| repository_version_removed | [optional] 
+ **tags** | **String**| tags | [optional] 
+ **version** | **String**| version | [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
+
+[**InlineResponse20014**](InlineResponse20014.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> CollectionVersionResponse read(name, namespace, path, version, opts)
+
+
+
+Returns a CollectionVersion object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+
+api_instance = PulpAnsibleClient::PulpAnsibleGalaxyApiV3VersionsApi.new
+name = 'name_example' # String | 
+namespace = 'namespace_example' # String | 
+path = 'path_example' # String | 
+version = 'version_example' # String | 
+opts = {
+  certification: 'certification_example', # String | certification
+  deprecated: 'deprecated_example', # String | deprecated
+  is_highest: 'is_highest_example', # String | is_highest
+  name2: 'name_example', # String | name
+  namespace2: 'namespace_example', # String | namespace
+  q: 'q_example', # String | q
+  repository_version: 'repository_version_example', # String | repository_version
+  repository_version_added: 'repository_version_added_example', # String | repository_version_added
+  repository_version_removed: 'repository_version_removed_example', # String | repository_version_removed
+  tags: 'tags_example', # String | tags
+  version2: 'version_example', # String | version
+  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
+  result = api_instance.read(name, namespace, path, version, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleGalaxyApiV3VersionsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**|  | 
+ **namespace** | **String**|  | 
+ **path** | **String**|  | 
+ **version** | **String**|  | 
+ **certification** | **String**| certification | [optional] 
+ **deprecated** | **String**| deprecated | [optional] 
+ **is_highest** | **String**| is_highest | [optional] 
+ **name2** | **String**| name | [optional] 
+ **namespace2** | **String**| namespace | [optional] 
+ **q** | **String**| q | [optional] 
+ **repository_version** | **String**| repository_version | [optional] 
+ **repository_version_added** | **String**| repository_version_added | [optional] 
+ **repository_version_removed** | **String**| repository_version_removed | [optional] 
+ **tags** | **String**| tags | [optional] 
+ **version2** | **String**| version | [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
+
+[**CollectionVersionResponse**](CollectionVersionResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+