pulp_deb_client 2.5.0b1 → 2.6.0b1

data/docs/RepositoriesAptApi.md

@@ -5,23 +5,23 @@ All URIs are relative to *http://pulp*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**create**](RepositoriesAptApi.md#create) | **POST** /pulp/api/v3/repositories/deb/apt/ | Create an apt repository
-[**delete**](RepositoriesAptApi.md#delete) | **DELETE** {apt_repository_href} | Delete an apt repository
+[**delete**](RepositoriesAptApi.md#delete) | **DELETE** {deb_apt_repository_href} | Delete an apt repository
 [**list**](RepositoriesAptApi.md#list) | **GET** /pulp/api/v3/repositories/deb/apt/ | List apt repositorys
-[**modify**](RepositoriesAptApi.md#modify) | **POST** {apt_repository_href}modify/ | Modify Repository Content
-[**partial_update**](RepositoriesAptApi.md#partial_update) | **PATCH** {apt_repository_href} | Partially update an apt repository
-[**read**](RepositoriesAptApi.md#read) | **GET** {apt_repository_href} | Inspect an apt repository
-[**sync**](RepositoriesAptApi.md#sync) | **POST** {apt_repository_href}sync/ | Sync from remote
-[**update**](RepositoriesAptApi.md#update) | **PUT** {apt_repository_href} | Update an apt repository
+[**modify**](RepositoriesAptApi.md#modify) | **POST** {deb_apt_repository_href}modify/ | Modify Repository Content
+[**partial_update**](RepositoriesAptApi.md#partial_update) | **PATCH** {deb_apt_repository_href} | Update an apt repository
+[**read**](RepositoriesAptApi.md#read) | **GET** {deb_apt_repository_href} | Inspect an apt repository
+[**sync**](RepositoriesAptApi.md#sync) | **POST** {deb_apt_repository_href}sync/ | Sync from remote
+[**update**](RepositoriesAptApi.md#update) | **PUT** {deb_apt_repository_href} | Update an apt repository
 
 
 
 ## create
 
-> DebAptRepository create(data)
+> DebAptRepositoryResponse create(deb_apt_repository)
 
 Create an apt repository
 
-A ViewSet for AptRepository.
+An AptRepository is the locally stored, Pulp-internal representation of a APT repository.  It may be filled with content via synchronization or content upload to create an AptRepositoryVersion.
 
 ### Example
 
@@ -30,17 +30,17 @@ A ViewSet for AptRepository.
 require 'pulp_deb_client'
 # setup authorization
 PulpDebClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpDebClient::RepositoriesAptApi.new
-data = PulpDebClient::DebAptRepository.new # DebAptRepository | 
+deb_apt_repository = PulpDebClient::DebAptRepository.new # DebAptRepository | 
 
 begin
   #Create an apt repository
-  result = api_instance.create(data)
+  result = api_instance.create(deb_apt_repository)
   p result
 rescue PulpDebClient::ApiError => e
   puts "Exception when calling RepositoriesAptApi->create: #{e}"
@@ -52,25 +52,25 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **data** | [**DebAptRepository**](DebAptRepository.md)|  | 
+ **deb_apt_repository** | [**DebAptRepository**](DebAptRepository.md)|  | 
 
 ### Return type
 
-[**DebAptRepository**](DebAptRepository.md)
+[**DebAptRepositoryResponse**](DebAptRepositoryResponse.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json
 
 
 ## delete
 
-> AsyncOperationResponse delete(apt_repository_href)
+> AsyncOperationResponse delete(deb_apt_repository_href, opts)
 
 Delete an apt repository
 
@@ -83,17 +83,22 @@ Trigger an asynchronous delete task
 require 'pulp_deb_client'
 # setup authorization
 PulpDebClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpDebClient::RepositoriesAptApi.new
-apt_repository_href = 'apt_repository_href_example' # String | URI of Apt Repository. e.g.: /pulp/api/v3/repositories/deb/apt/1/
+deb_apt_repository_href = 'deb_apt_repository_href_example' # String | 
+opts = {
+  name: 'name_example', # String | name
+  name__in: 'name__in_example', # String | name__in
+  ordering: 'ordering_example' # String | Which field to use when ordering the results.
+}
 
 begin
   #Delete an apt repository
-  result = api_instance.delete(apt_repository_href)
+  result = api_instance.delete(deb_apt_repository_href, opts)
   p result
 rescue PulpDebClient::ApiError => e
   puts "Exception when calling RepositoriesAptApi->delete: #{e}"
@@ -105,7 +110,10 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **apt_repository_href** | **String**| URI of Apt Repository. e.g.: /pulp/api/v3/repositories/deb/apt/1/ | 
+ **deb_apt_repository_href** | **String**|  | 
+ **name** | **String**| name | [optional] 
+ **name__in** | **String**| name__in | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
 
 ### Return type
 
@@ -113,7 +121,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -127,7 +135,7 @@ Name | Type | Description  | Notes
 
 List apt repositorys
 
-A ViewSet for AptRepository.
+An AptRepository is the locally stored, Pulp-internal representation of a APT repository.  It may be filled with content via synchronization or content upload to create an AptRepositoryVersion.
 
 ### Example
 
@@ -136,18 +144,18 @@ A ViewSet for AptRepository.
 require 'pulp_deb_client'
 # setup authorization
 PulpDebClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpDebClient::RepositoriesAptApi.new
 opts = {
-  ordering: 'ordering_example', # String | Which field to use when ordering the results.
-  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.
+  name: 'name_example', # String | name
+  name__in: 'name__in_example', # String | name__in
   offset: 56, # Integer | The initial index from which to return the results.
+  ordering: 'ordering_example', # String | Which field to use when ordering 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.
 }
@@ -166,11 +174,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **ordering** | **String**| Which field to use when ordering the results. | [optional] 
- **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] 
+ **name** | **String**| name | [optional] 
+ **name__in** | **String**| name__in | [optional] 
  **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | **String**| Which field to use when ordering 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] 
 
@@ -180,7 +188,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -190,7 +198,7 @@ Name | Type | Description  | Notes
 
 ## modify
 
-> AsyncOperationResponse modify(apt_repository_href, data)
+> AsyncOperationResponse modify(deb_apt_repository_href, repository_add_remove_content)
 
 Modify Repository Content
 
@@ -203,18 +211,18 @@ Trigger an asynchronous task to create a new repository version.
 require 'pulp_deb_client'
 # setup authorization
 PulpDebClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpDebClient::RepositoriesAptApi.new
-apt_repository_href = 'apt_repository_href_example' # String | URI of Apt Repository. e.g.: /pulp/api/v3/repositories/deb/apt/1/
-data = PulpDebClient::RepositoryAddRemoveContent.new # RepositoryAddRemoveContent | 
+deb_apt_repository_href = 'deb_apt_repository_href_example' # String | 
+repository_add_remove_content = PulpDebClient::RepositoryAddRemoveContent.new # RepositoryAddRemoveContent | 
 
 begin
   #Modify Repository Content
-  result = api_instance.modify(apt_repository_href, data)
+  result = api_instance.modify(deb_apt_repository_href, repository_add_remove_content)
   p result
 rescue PulpDebClient::ApiError => e
   puts "Exception when calling RepositoriesAptApi->modify: #{e}"
@@ -226,8 +234,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **apt_repository_href** | **String**| URI of Apt Repository. e.g.: /pulp/api/v3/repositories/deb/apt/1/ | 
- **data** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md)|  | 
+ **deb_apt_repository_href** | **String**|  | 
+ **repository_add_remove_content** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md)|  | 
 
 ### Return type
 
@@ -235,19 +243,19 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json
 
 
 ## partial_update
 
-> AsyncOperationResponse partial_update(apt_repository_href, data)
+> AsyncOperationResponse partial_update(deb_apt_repository_href, patcheddeb_apt_repository, opts)
 
-Partially update an apt repository
+Update an apt repository
 
 Trigger an asynchronous partial update task
 
@@ -258,18 +266,23 @@ Trigger an asynchronous partial update task
 require 'pulp_deb_client'
 # setup authorization
 PulpDebClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpDebClient::RepositoriesAptApi.new
-apt_repository_href = 'apt_repository_href_example' # String | URI of Apt Repository. e.g.: /pulp/api/v3/repositories/deb/apt/1/
-data = PulpDebClient::DebAptRepository.new # DebAptRepository | 
+deb_apt_repository_href = 'deb_apt_repository_href_example' # String | 
+patcheddeb_apt_repository = PulpDebClient::PatcheddebAptRepository.new # PatcheddebAptRepository | 
+opts = {
+  name: 'name_example', # String | name
+  name__in: 'name__in_example', # String | name__in
+  ordering: 'ordering_example' # String | Which field to use when ordering the results.
+}
 
 begin
-  #Partially update an apt repository
-  result = api_instance.partial_update(apt_repository_href, data)
+  #Update an apt repository
+  result = api_instance.partial_update(deb_apt_repository_href, patcheddeb_apt_repository, opts)
   p result
 rescue PulpDebClient::ApiError => e
   puts "Exception when calling RepositoriesAptApi->partial_update: #{e}"
@@ -281,8 +294,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **apt_repository_href** | **String**| URI of Apt Repository. e.g.: /pulp/api/v3/repositories/deb/apt/1/ | 
- **data** | [**DebAptRepository**](DebAptRepository.md)|  | 
+ **deb_apt_repository_href** | **String**|  | 
+ **patcheddeb_apt_repository** | [**PatcheddebAptRepository**](PatcheddebAptRepository.md)|  | 
+ **name** | **String**| name | [optional] 
+ **name__in** | **String**| name__in | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
 
 ### Return type
 
@@ -290,21 +306,21 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json
 
 
 ## read
 
-> DebAptRepository read(apt_repository_href, opts)
+> DebAptRepositoryResponse read(deb_apt_repository_href, opts)
 
 Inspect an apt repository
 
-A ViewSet for AptRepository.
+An AptRepository is the locally stored, Pulp-internal representation of a APT repository.  It may be filled with content via synchronization or content upload to create an AptRepositoryVersion.
 
 ### Example
 
@@ -313,13 +329,13 @@ A ViewSet for AptRepository.
 require 'pulp_deb_client'
 # setup authorization
 PulpDebClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpDebClient::RepositoriesAptApi.new
-apt_repository_href = 'apt_repository_href_example' # String | URI of Apt Repository. e.g.: /pulp/api/v3/repositories/deb/apt/1/
+deb_apt_repository_href = 'deb_apt_repository_href_example' # String | 
 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.
@@ -327,7 +343,7 @@ opts = {
 
 begin
   #Inspect an apt repository
-  result = api_instance.read(apt_repository_href, opts)
+  result = api_instance.read(deb_apt_repository_href, opts)
   p result
 rescue PulpDebClient::ApiError => e
   puts "Exception when calling RepositoriesAptApi->read: #{e}"
@@ -339,17 +355,17 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **apt_repository_href** | **String**| URI of Apt Repository. e.g.: /pulp/api/v3/repositories/deb/apt/1/ | 
+ **deb_apt_repository_href** | **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
 
-[**DebAptRepository**](DebAptRepository.md)
+[**DebAptRepositoryResponse**](DebAptRepositoryResponse.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -359,7 +375,7 @@ Name | Type | Description  | Notes
 
 ## sync
 
-> AsyncOperationResponse sync(apt_repository_href, data)
+> AsyncOperationResponse sync(deb_apt_repository_href, repository_sync_url)
 
 Sync from remote
 
@@ -372,18 +388,18 @@ Trigger an asynchronous task to sync content
 require 'pulp_deb_client'
 # setup authorization
 PulpDebClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpDebClient::RepositoriesAptApi.new
-apt_repository_href = 'apt_repository_href_example' # String | URI of Apt Repository. e.g.: /pulp/api/v3/repositories/deb/apt/1/
-data = PulpDebClient::RepositorySyncURL.new # RepositorySyncURL | 
+deb_apt_repository_href = 'deb_apt_repository_href_example' # String | 
+repository_sync_url = PulpDebClient::RepositorySyncURL.new # RepositorySyncURL | 
 
 begin
   #Sync from remote
-  result = api_instance.sync(apt_repository_href, data)
+  result = api_instance.sync(deb_apt_repository_href, repository_sync_url)
   p result
 rescue PulpDebClient::ApiError => e
   puts "Exception when calling RepositoriesAptApi->sync: #{e}"
@@ -395,8 +411,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **apt_repository_href** | **String**| URI of Apt Repository. e.g.: /pulp/api/v3/repositories/deb/apt/1/ | 
- **data** | [**RepositorySyncURL**](RepositorySyncURL.md)|  | 
+ **deb_apt_repository_href** | **String**|  | 
+ **repository_sync_url** | [**RepositorySyncURL**](RepositorySyncURL.md)|  | 
 
 ### Return type
 
@@ -404,17 +420,17 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json
 
 
 ## update
 
-> AsyncOperationResponse update(apt_repository_href, data)
+> AsyncOperationResponse update(deb_apt_repository_href, deb_apt_repository, opts)
 
 Update an apt repository
 
@@ -427,18 +443,23 @@ Trigger an asynchronous update task
 require 'pulp_deb_client'
 # setup authorization
 PulpDebClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpDebClient::RepositoriesAptApi.new
-apt_repository_href = 'apt_repository_href_example' # String | URI of Apt Repository. e.g.: /pulp/api/v3/repositories/deb/apt/1/
-data = PulpDebClient::DebAptRepository.new # DebAptRepository | 
+deb_apt_repository_href = 'deb_apt_repository_href_example' # String | 
+deb_apt_repository = PulpDebClient::DebAptRepository.new # DebAptRepository | 
+opts = {
+  name: 'name_example', # String | name
+  name__in: 'name__in_example', # String | name__in
+  ordering: 'ordering_example' # String | Which field to use when ordering the results.
+}
 
 begin
   #Update an apt repository
-  result = api_instance.update(apt_repository_href, data)
+  result = api_instance.update(deb_apt_repository_href, deb_apt_repository, opts)
   p result
 rescue PulpDebClient::ApiError => e
   puts "Exception when calling RepositoriesAptApi->update: #{e}"
@@ -450,8 +471,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **apt_repository_href** | **String**| URI of Apt Repository. e.g.: /pulp/api/v3/repositories/deb/apt/1/ | 
- **data** | [**DebAptRepository**](DebAptRepository.md)|  | 
+ **deb_apt_repository_href** | **String**|  | 
+ **deb_apt_repository** | [**DebAptRepository**](DebAptRepository.md)|  | 
+ **name** | **String**| name | [optional] 
+ **name__in** | **String**| name__in | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
 
 ### Return type
 
@@ -459,10 +483,10 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json