pulp_cookbook_client 0.1.0b9

data/docs/RemotesCookbookApi.md

@@ -0,0 +1,376 @@
+# PulpCookbookClient::RemotesCookbookApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](RemotesCookbookApi.md#create) | **POST** /pulp/api/v3/remotes/cookbook/cookbook/ | Create a cookbook remote
+[**delete**](RemotesCookbookApi.md#delete) | **DELETE** {cookbook_cookbook_remote_href} | Delete a cookbook remote
+[**list**](RemotesCookbookApi.md#list) | **GET** /pulp/api/v3/remotes/cookbook/cookbook/ | List cookbook remotes
+[**partial_update**](RemotesCookbookApi.md#partial_update) | **PATCH** {cookbook_cookbook_remote_href} | Update a cookbook remote
+[**read**](RemotesCookbookApi.md#read) | **GET** {cookbook_cookbook_remote_href} | Inspect a cookbook remote
+[**update**](RemotesCookbookApi.md#update) | **PUT** {cookbook_cookbook_remote_href} | Update a cookbook remote
+
+
+
+## create
+
+> CookbookCookbookRemoteResponse create(cookbook_cookbook_remote)
+
+Create a cookbook remote
+
+Cookbook Remote Endpoint.   CookbookRemote represents an external source of Cookbook Content.  The target url of a CookbookRemote must point to a universe API endpont.
+
+### 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::RemotesCookbookApi.new
+cookbook_cookbook_remote = PulpCookbookClient::CookbookCookbookRemote.new # CookbookCookbookRemote | 
+
+begin
+  #Create a cookbook remote
+  result = api_instance.create(cookbook_cookbook_remote)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling RemotesCookbookApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cookbook_cookbook_remote** | [**CookbookCookbookRemote**](CookbookCookbookRemote.md)|  | 
+
+### Return type
+
+[**CookbookCookbookRemoteResponse**](CookbookCookbookRemoteResponse.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_remote_href)
+
+Delete a cookbook remote
+
+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::RemotesCookbookApi.new
+cookbook_cookbook_remote_href = 'cookbook_cookbook_remote_href_example' # String | 
+
+begin
+  #Delete a cookbook remote
+  result = api_instance.delete(cookbook_cookbook_remote_href)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling RemotesCookbookApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cookbook_cookbook_remote_href** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> PaginatedcookbookCookbookRemoteResponseList list(opts)
+
+List cookbook remotes
+
+Cookbook Remote Endpoint.   CookbookRemote represents an external source of Cookbook Content.  The target url of a CookbookRemote must point to a universe API endpont.
+
+### 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::RemotesCookbookApi.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
+  pulp_last_updated: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | ISO 8601 formatted dates are supported
+  pulp_last_updated__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than value
+  pulp_last_updated__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than or equal to value
+  pulp_last_updated__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than value
+  pulp_last_updated__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than or equal to value
+  pulp_last_updated__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_last_updated is between two comma separated values
+  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 remotes
+  result = api_instance.list(opts)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling RemotesCookbookApi->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] 
+ **pulp_last_updated** | **DateTime**| ISO 8601 formatted dates are supported | [optional] 
+ **pulp_last_updated__gt** | **DateTime**| Filter results where pulp_last_updated is greater than value | [optional] 
+ **pulp_last_updated__gte** | **DateTime**| Filter results where pulp_last_updated is greater than or equal to value | [optional] 
+ **pulp_last_updated__lt** | **DateTime**| Filter results where pulp_last_updated is less than value | [optional] 
+ **pulp_last_updated__lte** | **DateTime**| Filter results where pulp_last_updated is less than or equal to value | [optional] 
+ **pulp_last_updated__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_last_updated is between two comma separated values | [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
+
+[**PaginatedcookbookCookbookRemoteResponseList**](PaginatedcookbookCookbookRemoteResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(cookbook_cookbook_remote_href, patchedcookbook_cookbook_remote)
+
+Update a cookbook remote
+
+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::RemotesCookbookApi.new
+cookbook_cookbook_remote_href = 'cookbook_cookbook_remote_href_example' # String | 
+patchedcookbook_cookbook_remote = PulpCookbookClient::PatchedcookbookCookbookRemote.new # PatchedcookbookCookbookRemote | 
+
+begin
+  #Update a cookbook remote
+  result = api_instance.partial_update(cookbook_cookbook_remote_href, patchedcookbook_cookbook_remote)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling RemotesCookbookApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cookbook_cookbook_remote_href** | **String**|  | 
+ **patchedcookbook_cookbook_remote** | [**PatchedcookbookCookbookRemote**](PatchedcookbookCookbookRemote.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
+
+> CookbookCookbookRemoteResponse read(cookbook_cookbook_remote_href, opts)
+
+Inspect a cookbook remote
+
+Cookbook Remote Endpoint.   CookbookRemote represents an external source of Cookbook Content.  The target url of a CookbookRemote must point to a universe API endpont.
+
+### 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::RemotesCookbookApi.new
+cookbook_cookbook_remote_href = 'cookbook_cookbook_remote_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 remote
+  result = api_instance.read(cookbook_cookbook_remote_href, opts)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling RemotesCookbookApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cookbook_cookbook_remote_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
+
+[**CookbookCookbookRemoteResponse**](CookbookCookbookRemoteResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(cookbook_cookbook_remote_href, cookbook_cookbook_remote)
+
+Update a cookbook remote
+
+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::RemotesCookbookApi.new
+cookbook_cookbook_remote_href = 'cookbook_cookbook_remote_href_example' # String | 
+cookbook_cookbook_remote = PulpCookbookClient::CookbookCookbookRemote.new # CookbookCookbookRemote | 
+
+begin
+  #Update a cookbook remote
+  result = api_instance.update(cookbook_cookbook_remote_href, cookbook_cookbook_remote)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling RemotesCookbookApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cookbook_cookbook_remote_href** | **String**|  | 
+ **cookbook_cookbook_remote** | [**CookbookCookbookRemote**](CookbookCookbookRemote.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
+