pulp_python_client 3.0.0b9

data/docs/RepositoriesPythonApi.md

@@ -0,0 +1,468 @@
+# PulpPythonClient::RepositoriesPythonApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](RepositoriesPythonApi.md#create) | **POST** /pulp/api/v3/repositories/python/python/ | Create a python repository
+[**delete**](RepositoriesPythonApi.md#delete) | **DELETE** {python_repository_href} | Delete a python repository
+[**list**](RepositoriesPythonApi.md#list) | **GET** /pulp/api/v3/repositories/python/python/ | List python repositorys
+[**modify**](RepositoriesPythonApi.md#modify) | **POST** {python_repository_href}modify/ | Modify Repository Content
+[**partial_update**](RepositoriesPythonApi.md#partial_update) | **PATCH** {python_repository_href} | Partially update a python repository
+[**read**](RepositoriesPythonApi.md#read) | **GET** {python_repository_href} | Inspect a python repository
+[**sync**](RepositoriesPythonApi.md#sync) | **POST** {python_repository_href}sync/ | Sync from remote
+[**update**](RepositoriesPythonApi.md#update) | **PUT** {python_repository_href} | Update a python repository
+
+
+
+## create
+
+> PythonPythonRepositoryRead create(data)
+
+Create a python repository
+
+A ViewSet for PythonRepository.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::RepositoriesPythonApi.new
+data = PulpPythonClient::PythonPythonRepository.new # PythonPythonRepository | 
+
+begin
+  #Create a python repository
+  result = api_instance.create(data)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RepositoriesPythonApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**PythonPythonRepository**](PythonPythonRepository.md)|  | 
+
+### Return type
+
+[**PythonPythonRepositoryRead**](PythonPythonRepositoryRead.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> AsyncOperationResponse delete(python_repository_href)
+
+Delete a python repository
+
+Trigger an asynchronous delete task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::RepositoriesPythonApi.new
+python_repository_href = 'python_repository_href_example' # String | URI of Python Repository. e.g.: /pulp/api/v3/repositories/python/python/1/
+
+begin
+  #Delete a python repository
+  result = api_instance.delete(python_repository_href)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RepositoriesPythonApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_repository_href** | **String**| URI of Python Repository. e.g.: /pulp/api/v3/repositories/python/python/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 python repositorys
+
+A ViewSet for PythonRepository.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::RepositoriesPythonApi.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.
+  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 python repositorys
+  result = api_instance.list(opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RepositoriesPythonApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+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] 
+ **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
+
+[**InlineResponse2004**](InlineResponse2004.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## modify
+
+> AsyncOperationResponse modify(python_repository_href, data)
+
+Modify Repository Content
+
+Trigger an asynchronous task to create a new repository version.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::RepositoriesPythonApi.new
+python_repository_href = 'python_repository_href_example' # String | URI of Python Repository. e.g.: /pulp/api/v3/repositories/python/python/1/
+data = PulpPythonClient::RepositoryAddRemoveContent.new # RepositoryAddRemoveContent | 
+
+begin
+  #Modify Repository Content
+  result = api_instance.modify(python_repository_href, data)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RepositoriesPythonApi->modify: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_repository_href** | **String**| URI of Python Repository. e.g.: /pulp/api/v3/repositories/python/python/1/ | 
+ **data** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(python_repository_href, data)
+
+Partially update a python repository
+
+Trigger an asynchronous partial update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::RepositoriesPythonApi.new
+python_repository_href = 'python_repository_href_example' # String | URI of Python Repository. e.g.: /pulp/api/v3/repositories/python/python/1/
+data = PulpPythonClient::PythonPythonRepository.new # PythonPythonRepository | 
+
+begin
+  #Partially update a python repository
+  result = api_instance.partial_update(python_repository_href, data)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RepositoriesPythonApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_repository_href** | **String**| URI of Python Repository. e.g.: /pulp/api/v3/repositories/python/python/1/ | 
+ **data** | [**PythonPythonRepository**](PythonPythonRepository.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## read
+
+> PythonPythonRepositoryRead read(python_repository_href, opts)
+
+Inspect a python repository
+
+A ViewSet for PythonRepository.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::RepositoriesPythonApi.new
+python_repository_href = 'python_repository_href_example' # String | URI of Python Repository. e.g.: /pulp/api/v3/repositories/python/python/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 python repository
+  result = api_instance.read(python_repository_href, opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RepositoriesPythonApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_repository_href** | **String**| URI of Python Repository. e.g.: /pulp/api/v3/repositories/python/python/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
+
+[**PythonPythonRepositoryRead**](PythonPythonRepositoryRead.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## sync
+
+> AsyncOperationResponse sync(python_repository_href, data)
+
+Sync from remote
+
+Trigger an asynchronous task to sync Python content.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::RepositoriesPythonApi.new
+python_repository_href = 'python_repository_href_example' # String | URI of Python Repository. e.g.: /pulp/api/v3/repositories/python/python/1/
+data = PulpPythonClient::RepositorySyncURL.new # RepositorySyncURL | 
+
+begin
+  #Sync from remote
+  result = api_instance.sync(python_repository_href, data)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RepositoriesPythonApi->sync: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_repository_href** | **String**| URI of Python Repository. e.g.: /pulp/api/v3/repositories/python/python/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(python_repository_href, data)
+
+Update a python repository
+
+Trigger an asynchronous update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::RepositoriesPythonApi.new
+python_repository_href = 'python_repository_href_example' # String | URI of Python Repository. e.g.: /pulp/api/v3/repositories/python/python/1/
+data = PulpPythonClient::PythonPythonRepository.new # PythonPythonRepository | 
+
+begin
+  #Update a python repository
+  result = api_instance.update(python_repository_href, data)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RepositoriesPythonApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_repository_href** | **String**| URI of Python Repository. e.g.: /pulp/api/v3/repositories/python/python/1/ | 
+ **data** | [**PythonPythonRepository**](PythonPythonRepository.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+