pulp_ansible_client 0.2.0b5 → 0.2.0b6

data/docs/RepositoriesAnsibleApi.md

@@ -0,0 +1,409 @@
+# PulpAnsibleClient::RepositoriesAnsibleApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](RepositoriesAnsibleApi.md#create) | **POST** /pulp/api/v3/repositories/ansible/ansible/ | Create an ansible repository
+[**delete**](RepositoriesAnsibleApi.md#delete) | **DELETE** {ansible_repository_href} | Delete an ansible repository
+[**list**](RepositoriesAnsibleApi.md#list) | **GET** /pulp/api/v3/repositories/ansible/ansible/ | List ansible repositorys
+[**partial_update**](RepositoriesAnsibleApi.md#partial_update) | **PATCH** {ansible_repository_href} | Partially update an ansible repository
+[**read**](RepositoriesAnsibleApi.md#read) | **GET** {ansible_repository_href} | Inspect an ansible repository
+[**sync**](RepositoriesAnsibleApi.md#sync) | **POST** {ansible_repository_href}sync/ | 
+[**update**](RepositoriesAnsibleApi.md#update) | **PUT** {ansible_repository_href} | Update an ansible repository
+
+
+
+## create
+
+> AnsibleAnsibleRepository create(data)
+
+Create an ansible repository
+
+ViewSet for Ansible 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::RepositoriesAnsibleApi.new
+data = PulpAnsibleClient::AnsibleAnsibleRepository.new # AnsibleAnsibleRepository | 
+
+begin
+  #Create an ansible repository
+  result = api_instance.create(data)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RepositoriesAnsibleApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**AnsibleAnsibleRepository**](AnsibleAnsibleRepository.md)|  | 
+
+### Return type
+
+[**AnsibleAnsibleRepository**](AnsibleAnsibleRepository.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> AsyncOperationResponse delete(ansible_repository_href)
+
+Delete an ansible repository
+
+Trigger an asynchronous task to delete a repository.
+
+### 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::RepositoriesAnsibleApi.new
+ansible_repository_href = 'ansible_repository_href_example' # String | URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/
+
+begin
+  #Delete an ansible repository
+  result = api_instance.delete(ansible_repository_href)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RepositoriesAnsibleApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_repository_href** | **String**| URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/ | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2007 list(opts)
+
+List ansible repositorys
+
+ViewSet for Ansible 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::RepositoriesAnsibleApi.new
+opts = {
+  name: 'name_example', # String | 
+  name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
+  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
+  #List ansible repositorys
+  result = api_instance.list(opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RepositoriesAnsibleApi->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] 
+ **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
+
+[**InlineResponse2007**](InlineResponse2007.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AnsibleAnsibleRepository partial_update(ansible_repository_href, data)
+
+Partially update an ansible repository
+
+ViewSet for Ansible 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::RepositoriesAnsibleApi.new
+ansible_repository_href = 'ansible_repository_href_example' # String | URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/
+data = PulpAnsibleClient::AnsibleAnsibleRepository.new # AnsibleAnsibleRepository | 
+
+begin
+  #Partially update an ansible repository
+  result = api_instance.partial_update(ansible_repository_href, data)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RepositoriesAnsibleApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_repository_href** | **String**| URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/ | 
+ **data** | [**AnsibleAnsibleRepository**](AnsibleAnsibleRepository.md)|  | 
+
+### Return type
+
+[**AnsibleAnsibleRepository**](AnsibleAnsibleRepository.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## read
+
+> AnsibleAnsibleRepository read(ansible_repository_href, opts)
+
+Inspect an ansible repository
+
+ViewSet for Ansible 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::RepositoriesAnsibleApi.new
+ansible_repository_href = 'ansible_repository_href_example' # String | URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/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.
+}
+
+begin
+  #Inspect an ansible repository
+  result = api_instance.read(ansible_repository_href, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RepositoriesAnsibleApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_repository_href** | **String**| URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/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] 
+
+### Return type
+
+[**AnsibleAnsibleRepository**](AnsibleAnsibleRepository.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## sync
+
+> AsyncOperationResponse sync(ansible_repository_href, data)
+
+
+
+Trigger an asynchronous task to sync Ansible 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::RepositoriesAnsibleApi.new
+ansible_repository_href = 'ansible_repository_href_example' # String | URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/
+data = PulpAnsibleClient::RepositorySyncURL.new # RepositorySyncURL | 
+
+begin
+  result = api_instance.sync(ansible_repository_href, data)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RepositoriesAnsibleApi->sync: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_repository_href** | **String**| URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/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(ansible_repository_href, data)
+
+Update an ansible repository
+
+Trigger an asynchronous task to update a repository.
+
+### 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::RepositoriesAnsibleApi.new
+ansible_repository_href = 'ansible_repository_href_example' # String | URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/
+data = PulpAnsibleClient::AnsibleAnsibleRepository.new # AnsibleAnsibleRepository | 
+
+begin
+  #Update an ansible repository
+  result = api_instance.update(ansible_repository_href, data)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RepositoriesAnsibleApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_repository_href** | **String**| URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/ | 
+ **data** | [**AnsibleAnsibleRepository**](AnsibleAnsibleRepository.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/RepositoriesAnsibleVersionsApi.md

@@ -0,0 +1,214 @@
+# PulpAnsibleClient::RepositoriesAnsibleVersionsApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete**](RepositoriesAnsibleVersionsApi.md#delete) | **DELETE** {ansible_repository_version_href} | Delete a repository version
+[**list**](RepositoriesAnsibleVersionsApi.md#list) | **GET** {ansible_repository_href}versions/ | List repository versions
+[**read**](RepositoriesAnsibleVersionsApi.md#read) | **GET** {ansible_repository_version_href} | Inspect a repository version
+
+
+
+## delete
+
+> AsyncOperationResponse delete(ansible_repository_version_href)
+
+Delete a repository version
+
+Trigger an asynchronous task to delete a repositroy version.
+
+### 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::RepositoriesAnsibleVersionsApi.new
+ansible_repository_version_href = 'ansible_repository_version_href_example' # String | URI of Repository Version. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/versions/1/
+
+begin
+  #Delete a repository version
+  result = api_instance.delete(ansible_repository_version_href)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RepositoriesAnsibleVersionsApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_repository_version_href** | **String**| URI of Repository Version. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/versions/1/ | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2008 list(ansible_ansible_repository_href, opts)
+
+List repository versions
+
+RpmRepositoryVersion represents a single file repository version.
+
+### 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::RepositoriesAnsibleVersionsApi.new
+ansible_ansible_repository_href = 'ansible_ansible_repository_href_example' # String | URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/
+opts = {
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  number: 3.4, # Float | 
+  number__lt: 3.4, # Float | Filter results where number is less than value
+  number__lte: 3.4, # Float | Filter results where number is less than or equal to value
+  number__gt: 3.4, # Float | Filter results where number is greater than value
+  number__gte: 3.4, # Float | Filter results where number is greater than or equal to value
+  number__range: 3.4, # Float | Filter results where number is between two comma separated values
+  pulp_created__lt: 'pulp_created__lt_example', # String | Filter results where pulp_created is less than value
+  pulp_created__lte: 'pulp_created__lte_example', # String | Filter results where pulp_created is less than or equal to value
+  pulp_created__gt: 'pulp_created__gt_example', # String | Filter results where pulp_created is greater than value
+  pulp_created__gte: 'pulp_created__gte_example', # String | Filter results where pulp_created is greater than or equal to value
+  pulp_created__range: 'pulp_created__range_example', # String | Filter results where pulp_created is between two comma separated values
+  content: 'content_example', # String | Content Unit referenced by HREF
+  pulp_created: 'pulp_created_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.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #List repository versions
+  result = api_instance.list(ansible_ansible_repository_href, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RepositoriesAnsibleVersionsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_ansible_repository_href** | **String**| URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/ | 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **number** | **Float**|  | [optional] 
+ **number__lt** | **Float**| Filter results where number is less than value | [optional] 
+ **number__lte** | **Float**| Filter results where number is less than or equal to value | [optional] 
+ **number__gt** | **Float**| Filter results where number is greater than value | [optional] 
+ **number__gte** | **Float**| Filter results where number is greater than or equal to value | [optional] 
+ **number__range** | **Float**| Filter results where number is between two comma separated values | [optional] 
+ **pulp_created__lt** | **String**| Filter results where pulp_created is less than value | [optional] 
+ **pulp_created__lte** | **String**| Filter results where pulp_created is less than or equal to value | [optional] 
+ **pulp_created__gt** | **String**| Filter results where pulp_created is greater than value | [optional] 
+ **pulp_created__gte** | **String**| Filter results where pulp_created is greater than or equal to value | [optional] 
+ **pulp_created__range** | **String**| Filter results where pulp_created is between two comma separated values | [optional] 
+ **content** | **String**| Content Unit referenced by HREF | [optional] 
+ **pulp_created** | **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] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**InlineResponse2008**](InlineResponse2008.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> RepositoryVersion read(ansible_repository_version_href, opts)
+
+Inspect a repository version
+
+RpmRepositoryVersion represents a single file repository version.
+
+### 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::RepositoriesAnsibleVersionsApi.new
+ansible_repository_version_href = 'ansible_repository_version_href_example' # String | URI of Repository Version. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/versions/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.
+}
+
+begin
+  #Inspect a repository version
+  result = api_instance.read(ansible_repository_version_href, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RepositoriesAnsibleVersionsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_repository_version_href** | **String**| URI of Repository Version. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/versions/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] 
+
+### Return type
+
+[**RepositoryVersion**](RepositoryVersion.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RepositorySyncURL.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**repository** | **String** | A URI of the repository to be synchronized. | 
+**remote** | **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
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'PulpAnsibleClient'
 
-instance = PulpAnsibleClient::RepositorySyncURL.new(repository: null,
+instance = PulpAnsibleClient::RepositorySyncURL.new(remote: null,
                                  mirror: null)
 ```
 

data/docs/RepositoryVersion.md

@@ -0,0 +1,25 @@
+# PulpAnsibleClient::RepositoryVersion
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**number** | **Integer** |  | [optional] [readonly] 
+**base_version** | **String** | A repository version whose content was used as the initial set of content for this repository version | [optional] 
+**content_summary** | [**ContentSummary**](ContentSummary.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpAnsibleClient'
+
+instance = PulpAnsibleClient::RepositoryVersion.new(pulp_href: null,
+                                 pulp_created: null,
+                                 number: null,
+                                 base_version: null,
+                                 content_summary: null)
+```
+
+

data/docs/Tag.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** |  | [optional] 
+**name** | **String** |  | [optional] [readonly] 
 
 ## Code Sample