pulp_cookbook_client 0.1.0b9

data/docs/RepositoriesCookbookApi.md

@@ -0,0 +1,475 @@
+# PulpCookbookClient::RepositoriesCookbookApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](RepositoriesCookbookApi.md#create) | **POST** /pulp/api/v3/repositories/cookbook/cookbook/ | Create a cookbook repository
+[**delete**](RepositoriesCookbookApi.md#delete) | **DELETE** {cookbook_cookbook_repository_href} | Delete a cookbook repository
+[**list**](RepositoriesCookbookApi.md#list) | **GET** /pulp/api/v3/repositories/cookbook/cookbook/ | List cookbook repositorys
+[**modify**](RepositoriesCookbookApi.md#modify) | **POST** {cookbook_cookbook_repository_href}modify/ | Modify Repository Content
+[**partial_update**](RepositoriesCookbookApi.md#partial_update) | **PATCH** {cookbook_cookbook_repository_href} | Update a cookbook repository
+[**read**](RepositoriesCookbookApi.md#read) | **GET** {cookbook_cookbook_repository_href} | Inspect a cookbook repository
+[**sync**](RepositoriesCookbookApi.md#sync) | **POST** {cookbook_cookbook_repository_href}sync/ | 
+[**update**](RepositoriesCookbookApi.md#update) | **PUT** {cookbook_cookbook_repository_href} | Update a cookbook repository
+
+
+
+## create
+
+> CookbookCookbookRepositoryResponse create(cookbook_cookbook_repository)
+
+Create a cookbook repository
+
+Cookbook Repository Endpoint.   CookbookRepository represents a single cookbook repository, to which content can be synced, added, or removed.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_cookbook_client'
+# setup authorization
+PulpCookbookClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpCookbookClient::RepositoriesCookbookApi.new
+cookbook_cookbook_repository = PulpCookbookClient::CookbookCookbookRepository.new # CookbookCookbookRepository | 
+
+begin
+  #Create a cookbook repository
+  result = api_instance.create(cookbook_cookbook_repository)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling RepositoriesCookbookApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cookbook_cookbook_repository** | [**CookbookCookbookRepository**](CookbookCookbookRepository.md)|  | 
+
+### Return type
+
+[**CookbookCookbookRepositoryResponse**](CookbookCookbookRepositoryResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## delete
+
+> AsyncOperationResponse delete(cookbook_cookbook_repository_href)
+
+Delete a cookbook repository
+
+Trigger an asynchronous delete task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_cookbook_client'
+# setup authorization
+PulpCookbookClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpCookbookClient::RepositoriesCookbookApi.new
+cookbook_cookbook_repository_href = 'cookbook_cookbook_repository_href_example' # String | 
+
+begin
+  #Delete a cookbook repository
+  result = api_instance.delete(cookbook_cookbook_repository_href)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling RepositoriesCookbookApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cookbook_cookbook_repository_href** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> PaginatedcookbookCookbookRepositoryResponseList list(opts)
+
+List cookbook repositorys
+
+Cookbook Repository Endpoint.   CookbookRepository represents a single cookbook repository, to which content can be synced, added, or removed.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_cookbook_client'
+# setup authorization
+PulpCookbookClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpCookbookClient::RepositoriesCookbookApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | 
+  name__contains: 'name__contains_example', # String | Filter results where name contains value
+  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
+  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
+  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
+  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 cookbook repositorys
+  result = api_instance.list(opts)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling RepositoriesCookbookApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **name** | **String**|  | [optional] 
+ **name__contains** | **String**| Filter results where name contains value | [optional] 
+ **name__icontains** | **String**| Filter results where name contains value | [optional] 
+ **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional] 
+ **name__startswith** | **String**| Filter results where name starts with value | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **pulp_label_select** | **String**| Filter labels by search string | [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
+
+[**PaginatedcookbookCookbookRepositoryResponseList**](PaginatedcookbookCookbookRepositoryResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## modify
+
+> AsyncOperationResponse modify(cookbook_cookbook_repository_href, repository_add_remove_content)
+
+Modify Repository Content
+
+Trigger an asynchronous task to create a new repository version.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_cookbook_client'
+# setup authorization
+PulpCookbookClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpCookbookClient::RepositoriesCookbookApi.new
+cookbook_cookbook_repository_href = 'cookbook_cookbook_repository_href_example' # String | 
+repository_add_remove_content = PulpCookbookClient::RepositoryAddRemoveContent.new # RepositoryAddRemoveContent | 
+
+begin
+  #Modify Repository Content
+  result = api_instance.modify(cookbook_cookbook_repository_href, repository_add_remove_content)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling RepositoriesCookbookApi->modify: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cookbook_cookbook_repository_href** | **String**|  | 
+ **repository_add_remove_content** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(cookbook_cookbook_repository_href, patchedcookbook_cookbook_repository)
+
+Update a cookbook repository
+
+Trigger an asynchronous partial update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_cookbook_client'
+# setup authorization
+PulpCookbookClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpCookbookClient::RepositoriesCookbookApi.new
+cookbook_cookbook_repository_href = 'cookbook_cookbook_repository_href_example' # String | 
+patchedcookbook_cookbook_repository = PulpCookbookClient::PatchedcookbookCookbookRepository.new # PatchedcookbookCookbookRepository | 
+
+begin
+  #Update a cookbook repository
+  result = api_instance.partial_update(cookbook_cookbook_repository_href, patchedcookbook_cookbook_repository)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling RepositoriesCookbookApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cookbook_cookbook_repository_href** | **String**|  | 
+ **patchedcookbook_cookbook_repository** | [**PatchedcookbookCookbookRepository**](PatchedcookbookCookbookRepository.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## read
+
+> CookbookCookbookRepositoryResponse read(cookbook_cookbook_repository_href, opts)
+
+Inspect a cookbook repository
+
+Cookbook Repository Endpoint.   CookbookRepository represents a single cookbook repository, to which content can be synced, added, or removed.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_cookbook_client'
+# setup authorization
+PulpCookbookClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpCookbookClient::RepositoriesCookbookApi.new
+cookbook_cookbook_repository_href = 'cookbook_cookbook_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.
+}
+
+begin
+  #Inspect a cookbook repository
+  result = api_instance.read(cookbook_cookbook_repository_href, opts)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling RepositoriesCookbookApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cookbook_cookbook_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
+
+[**CookbookCookbookRepositoryResponse**](CookbookCookbookRepositoryResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## sync
+
+> AsyncOperationResponse sync(cookbook_cookbook_repository_href, repository_sync_url)
+
+
+
+Trigger an asynchronous task to sync cookbook content.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_cookbook_client'
+# setup authorization
+PulpCookbookClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpCookbookClient::RepositoriesCookbookApi.new
+cookbook_cookbook_repository_href = 'cookbook_cookbook_repository_href_example' # String | 
+repository_sync_url = PulpCookbookClient::RepositorySyncURL.new # RepositorySyncURL | 
+
+begin
+  result = api_instance.sync(cookbook_cookbook_repository_href, repository_sync_url)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling RepositoriesCookbookApi->sync: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cookbook_cookbook_repository_href** | **String**|  | 
+ **repository_sync_url** | [**RepositorySyncURL**](RepositorySyncURL.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(cookbook_cookbook_repository_href, cookbook_cookbook_repository)
+
+Update a cookbook repository
+
+Trigger an asynchronous update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_cookbook_client'
+# setup authorization
+PulpCookbookClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpCookbookClient::RepositoriesCookbookApi.new
+cookbook_cookbook_repository_href = 'cookbook_cookbook_repository_href_example' # String | 
+cookbook_cookbook_repository = PulpCookbookClient::CookbookCookbookRepository.new # CookbookCookbookRepository | 
+
+begin
+  #Update a cookbook repository
+  result = api_instance.update(cookbook_cookbook_repository_href, cookbook_cookbook_repository)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling RepositoriesCookbookApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cookbook_cookbook_repository_href** | **String**|  | 
+ **cookbook_cookbook_repository** | [**CookbookCookbookRepository**](CookbookCookbookRepository.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+