pulp_cookbook_client 0.1.0b9

data/docs/PaginatedcookbookCookbookRepositoryResponseList.md

@@ -0,0 +1,23 @@
+# PulpCookbookClient::PaginatedcookbookCookbookRepositoryResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<CookbookCookbookRepositoryResponse>**](CookbookCookbookRepositoryResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpCookbookClient'
+
+instance = PulpCookbookClient::PaginatedcookbookCookbookRepositoryResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PatchedcookbookCookbookDistribution.md

@@ -0,0 +1,27 @@
+# PulpCookbookClient::PatchedcookbookCookbookDistribution
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | [optional] 
+**content_guard** | **String** | An optional content-guard. | [optional] 
+**pulp_labels** | [**Object**](.md) |  | [optional] 
+**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | [optional] 
+**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] 
+**publication** | **String** | Publication to be served | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpCookbookClient'
+
+instance = PulpCookbookClient::PatchedcookbookCookbookDistribution.new(base_path: null,
+                                 content_guard: null,
+                                 pulp_labels: null,
+                                 name: null,
+                                 repository: null,
+                                 publication: null)
+```
+
+

data/docs/PatchedcookbookCookbookRemote.md

@@ -0,0 +1,59 @@
+# PulpCookbookClient::PatchedcookbookCookbookRemote
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A unique name for this remote. | [optional] 
+**url** | **String** | The URL of an external content source. | [optional] 
+**ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] 
+**client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] 
+**client_key** | **String** | A PEM encoded private key used for authentication. | [optional] 
+**tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] 
+**proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] 
+**proxy_username** | **String** | The username to authenticte to the proxy. | [optional] 
+**proxy_password** | **String** | The password to authenticte to the proxy. | [optional] 
+**username** | **String** | The username to be used for authentication when syncing. | [optional] 
+**password** | **String** | The password to be used for authentication when syncing. | [optional] 
+**pulp_labels** | [**Object**](.md) |  | [optional] 
+**download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] 
+**max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] 
+**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. | [optional] 
+**total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
+**connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
+**sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
+**sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
+**headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional] 
+**rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] 
+**cookbooks** | [**Object**](.md) | An optional JSON object in the format {\"<cookbook name>\": \"<version_string>\" }. Used to limit the cookbooks to synchronize from the remote | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpCookbookClient'
+
+instance = PulpCookbookClient::PatchedcookbookCookbookRemote.new(name: null,
+                                 url: null,
+                                 ca_cert: null,
+                                 client_cert: null,
+                                 client_key: null,
+                                 tls_validation: null,
+                                 proxy_url: null,
+                                 proxy_username: null,
+                                 proxy_password: null,
+                                 username: null,
+                                 password: null,
+                                 pulp_labels: null,
+                                 download_concurrency: null,
+                                 max_retries: null,
+                                 policy: null,
+                                 total_timeout: null,
+                                 connect_timeout: null,
+                                 sock_connect_timeout: null,
+                                 sock_read_timeout: null,
+                                 headers: null,
+                                 rate_limit: null,
+                                 cookbooks: null)
+```
+
+

data/docs/PatchedcookbookCookbookRepository.md

@@ -0,0 +1,25 @@
+# PulpCookbookClient::PatchedcookbookCookbookRepository
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_labels** | [**Object**](.md) |  | [optional] 
+**name** | **String** | A unique name for this repository. | [optional] 
+**description** | **String** | An optional description. | [optional] 
+**retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. This is provided as a tech preview in Pulp 3 and may change in the future. | [optional] 
+**remote** | **String** | An optional remote to use by default when syncing. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpCookbookClient'
+
+instance = PulpCookbookClient::PatchedcookbookCookbookRepository.new(pulp_labels: null,
+                                 name: null,
+                                 description: null,
+                                 retain_repo_versions: null,
+                                 remote: null)
+```
+
+

data/docs/PolicyEnum.md

@@ -0,0 +1,16 @@
+# PulpCookbookClient::PolicyEnum
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'PulpCookbookClient'
+
+instance = PulpCookbookClient::PolicyEnum.new()
+```
+
+

data/docs/PublicationsCookbookApi.md

@@ -0,0 +1,257 @@
+# PulpCookbookClient::PublicationsCookbookApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](PublicationsCookbookApi.md#create) | **POST** /pulp/api/v3/publications/cookbook/cookbook/ | Create a cookbook publication
+[**delete**](PublicationsCookbookApi.md#delete) | **DELETE** {cookbook_cookbook_publication_href} | Delete a cookbook publication
+[**list**](PublicationsCookbookApi.md#list) | **GET** /pulp/api/v3/publications/cookbook/cookbook/ | List cookbook publications
+[**read**](PublicationsCookbookApi.md#read) | **GET** {cookbook_cookbook_publication_href} | Inspect a cookbook publication
+
+
+
+## create
+
+> AsyncOperationResponse create(cookbook_cookbook_publication)
+
+Create a cookbook publication
+
+Trigger an asynchronous task to publish 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::PublicationsCookbookApi.new
+cookbook_cookbook_publication = PulpCookbookClient::CookbookCookbookPublication.new # CookbookCookbookPublication | 
+
+begin
+  #Create a cookbook publication
+  result = api_instance.create(cookbook_cookbook_publication)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling PublicationsCookbookApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cookbook_cookbook_publication** | [**CookbookCookbookPublication**](CookbookCookbookPublication.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
+
+
+## delete
+
+> delete(cookbook_cookbook_publication_href)
+
+Delete a cookbook publication
+
+File Publication Endpoint.   A CookbookPublication contains metadata about all the Cookbook Content in a particular Cookbook Repository Version. Once a CookbookPublication has been created, it can be hosted using the Cookbook Distribution API.
+
+### 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::PublicationsCookbookApi.new
+cookbook_cookbook_publication_href = 'cookbook_cookbook_publication_href_example' # String | 
+
+begin
+  #Delete a cookbook publication
+  api_instance.delete(cookbook_cookbook_publication_href)
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling PublicationsCookbookApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cookbook_cookbook_publication_href** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> PaginatedcookbookCookbookPublicationResponseList list(opts)
+
+List cookbook publications
+
+File Publication Endpoint.   A CookbookPublication contains metadata about all the Cookbook Content in a particular Cookbook Repository Version. Once a CookbookPublication has been created, it can be hosted using the Cookbook Distribution API.
+
+### 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::PublicationsCookbookApi.new
+opts = {
+  content: 'content_example', # String | Content Unit referenced by HREF
+  content__in: 'content__in_example', # String | Content Unit referenced by HREF
+  limit: 56, # Integer | Number of results to return per page.
+  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_created: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | ISO 8601 formatted dates are supported
+  pulp_created__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than value
+  pulp_created__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than or equal to value
+  pulp_created__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than value
+  pulp_created__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than or equal to value
+  pulp_created__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_created is between two comma separated values
+  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
+  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 publications
+  result = api_instance.list(opts)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling PublicationsCookbookApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **content** | **String**| Content Unit referenced by HREF | [optional] 
+ **content__in** | **String**| Content Unit referenced by HREF | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [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_created** | **DateTime**| ISO 8601 formatted dates are supported | [optional] 
+ **pulp_created__gt** | **DateTime**| Filter results where pulp_created is greater than value | [optional] 
+ **pulp_created__gte** | **DateTime**| Filter results where pulp_created is greater than or equal to value | [optional] 
+ **pulp_created__lt** | **DateTime**| Filter results where pulp_created is less than value | [optional] 
+ **pulp_created__lte** | **DateTime**| Filter results where pulp_created is less than or equal to value | [optional] 
+ **pulp_created__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_created is between two comma separated values | [optional] 
+ **repository_version** | [**String**](.md)| Repository Version referenced by HREF | [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
+
+[**PaginatedcookbookCookbookPublicationResponseList**](PaginatedcookbookCookbookPublicationResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> CookbookCookbookPublicationResponse read(cookbook_cookbook_publication_href, opts)
+
+Inspect a cookbook publication
+
+File Publication Endpoint.   A CookbookPublication contains metadata about all the Cookbook Content in a particular Cookbook Repository Version. Once a CookbookPublication has been created, it can be hosted using the Cookbook Distribution API.
+
+### 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::PublicationsCookbookApi.new
+cookbook_cookbook_publication_href = 'cookbook_cookbook_publication_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 publication
+  result = api_instance.read(cookbook_cookbook_publication_href, opts)
+  p result
+rescue PulpCookbookClient::ApiError => e
+  puts "Exception when calling PublicationsCookbookApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cookbook_cookbook_publication_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
+
+[**CookbookCookbookPublicationResponse**](CookbookCookbookPublicationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+