pulp_cookbook_client 0.1.0b9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +162 -0
- data/Rakefile +10 -0
- data/docs/AsyncOperationResponse.md +17 -0
- data/docs/ContentCookbooksApi.md +208 -0
- data/docs/ContentSummary.md +21 -0
- data/docs/ContentSummaryResponse.md +21 -0
- data/docs/CookbookCookbookDistribution.md +27 -0
- data/docs/CookbookCookbookDistributionResponse.md +33 -0
- data/docs/CookbookCookbookPackageContent.md +25 -0
- data/docs/CookbookCookbookPackageContentResponse.md +29 -0
- data/docs/CookbookCookbookPublication.md +19 -0
- data/docs/CookbookCookbookPublicationResponse.md +25 -0
- data/docs/CookbookCookbookRemote.md +59 -0
- data/docs/CookbookCookbookRemoteResponse.md +55 -0
- data/docs/CookbookCookbookRepository.md +25 -0
- data/docs/CookbookCookbookRepositoryResponse.md +33 -0
- data/docs/DistributionsCookbookApi.md +372 -0
- data/docs/PaginatedRepositoryVersionResponseList.md +23 -0
- data/docs/PaginatedcookbookCookbookDistributionResponseList.md +23 -0
- data/docs/PaginatedcookbookCookbookPackageContentResponseList.md +23 -0
- data/docs/PaginatedcookbookCookbookPublicationResponseList.md +23 -0
- data/docs/PaginatedcookbookCookbookRemoteResponseList.md +23 -0
- data/docs/PaginatedcookbookCookbookRepositoryResponseList.md +23 -0
- data/docs/PatchedcookbookCookbookDistribution.md +27 -0
- data/docs/PatchedcookbookCookbookRemote.md +59 -0
- data/docs/PatchedcookbookCookbookRepository.md +25 -0
- data/docs/PolicyEnum.md +16 -0
- data/docs/PublicationsCookbookApi.md +257 -0
- data/docs/RemotesCookbookApi.md +376 -0
- data/docs/RepositoriesCookbookApi.md +475 -0
- data/docs/RepositoriesCookbookVersionsApi.md +271 -0
- data/docs/RepositoryAddRemoveContent.md +21 -0
- data/docs/RepositorySyncURL.md +19 -0
- data/docs/RepositoryVersion.md +17 -0
- data/docs/RepositoryVersionResponse.md +27 -0
- data/git_push.sh +58 -0
- data/lib/pulp_cookbook_client/api/content_cookbooks_api.rb +264 -0
- data/lib/pulp_cookbook_client/api/distributions_cookbook_api.rb +457 -0
- data/lib/pulp_cookbook_client/api/publications_cookbook_api.rb +312 -0
- data/lib/pulp_cookbook_client/api/remotes_cookbook_api.rb +463 -0
- data/lib/pulp_cookbook_client/api/repositories_cookbook_api.rb +583 -0
- data/lib/pulp_cookbook_client/api/repositories_cookbook_versions_api.rb +339 -0
- data/lib/pulp_cookbook_client/api_client.rb +406 -0
- data/lib/pulp_cookbook_client/api_error.rb +57 -0
- data/lib/pulp_cookbook_client/configuration.rb +250 -0
- data/lib/pulp_cookbook_client/models/async_operation_response.rb +213 -0
- data/lib/pulp_cookbook_client/models/content_summary.rb +246 -0
- data/lib/pulp_cookbook_client/models/content_summary_response.rb +246 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_distribution.rb +308 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_distribution_response.rb +299 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_package_content.rb +287 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_package_content_response.rb +272 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_publication.rb +217 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_publication_response.rb +248 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_remote.rb +677 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_remote_response.rb +493 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_repository.rb +304 -0
- data/lib/pulp_cookbook_client/models/cookbook_cookbook_repository_response.rb +307 -0
- data/lib/pulp_cookbook_client/models/paginated_repository_version_response_list.rb +237 -0
- data/lib/pulp_cookbook_client/models/paginatedcookbook_cookbook_distribution_response_list.rb +237 -0
- data/lib/pulp_cookbook_client/models/paginatedcookbook_cookbook_package_content_response_list.rb +237 -0
- data/lib/pulp_cookbook_client/models/paginatedcookbook_cookbook_publication_response_list.rb +237 -0
- data/lib/pulp_cookbook_client/models/paginatedcookbook_cookbook_remote_response_list.rb +237 -0
- data/lib/pulp_cookbook_client/models/paginatedcookbook_cookbook_repository_response_list.rb +237 -0
- data/lib/pulp_cookbook_client/models/patchedcookbook_cookbook_distribution.rb +290 -0
- data/lib/pulp_cookbook_client/models/patchedcookbook_cookbook_remote.rb +659 -0
- data/lib/pulp_cookbook_client/models/patchedcookbook_cookbook_repository.rb +295 -0
- data/lib/pulp_cookbook_client/models/policy_enum.rb +37 -0
- data/lib/pulp_cookbook_client/models/repository_add_remove_content.rb +232 -0
- data/lib/pulp_cookbook_client/models/repository_sync_url.rb +220 -0
- data/lib/pulp_cookbook_client/models/repository_version.rb +208 -0
- data/lib/pulp_cookbook_client/models/repository_version_response.rb +255 -0
- data/lib/pulp_cookbook_client/version.rb +15 -0
- data/lib/pulp_cookbook_client.rb +72 -0
- data/pulp_cookbook_client.gemspec +39 -0
- data/spec/api/content_cookbooks_api_spec.rb +87 -0
- data/spec/api/distributions_cookbook_api_spec.rb +125 -0
- data/spec/api/publications_cookbook_api_spec.rb +98 -0
- data/spec/api/remotes_cookbook_api_spec.rb +127 -0
- data/spec/api/repositories_cookbook_api_spec.rb +146 -0
- data/spec/api/repositories_cookbook_versions_api_spec.rb +104 -0
- data/spec/api_client_spec.rb +188 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/async_operation_response_spec.rb +41 -0
- data/spec/models/content_summary_response_spec.rb +53 -0
- data/spec/models/content_summary_spec.rb +53 -0
- data/spec/models/cookbook_cookbook_distribution_response_spec.rb +89 -0
- data/spec/models/cookbook_cookbook_distribution_spec.rb +71 -0
- data/spec/models/cookbook_cookbook_package_content_response_spec.rb +77 -0
- data/spec/models/cookbook_cookbook_package_content_spec.rb +65 -0
- data/spec/models/cookbook_cookbook_publication_response_spec.rb +65 -0
- data/spec/models/cookbook_cookbook_publication_spec.rb +47 -0
- data/spec/models/cookbook_cookbook_remote_response_spec.rb +155 -0
- data/spec/models/cookbook_cookbook_remote_spec.rb +167 -0
- data/spec/models/cookbook_cookbook_repository_response_spec.rb +89 -0
- data/spec/models/cookbook_cookbook_repository_spec.rb +65 -0
- data/spec/models/paginated_repository_version_response_list_spec.rb +59 -0
- data/spec/models/paginatedcookbook_cookbook_distribution_response_list_spec.rb +59 -0
- data/spec/models/paginatedcookbook_cookbook_package_content_response_list_spec.rb +59 -0
- data/spec/models/paginatedcookbook_cookbook_publication_response_list_spec.rb +59 -0
- data/spec/models/paginatedcookbook_cookbook_remote_response_list_spec.rb +59 -0
- data/spec/models/paginatedcookbook_cookbook_repository_response_list_spec.rb +59 -0
- data/spec/models/patchedcookbook_cookbook_distribution_spec.rb +71 -0
- data/spec/models/patchedcookbook_cookbook_remote_spec.rb +167 -0
- data/spec/models/patchedcookbook_cookbook_repository_spec.rb +65 -0
- data/spec/models/policy_enum_spec.rb +35 -0
- data/spec/models/repository_add_remove_content_spec.rb +53 -0
- data/spec/models/repository_sync_url_spec.rb +47 -0
- data/spec/models/repository_version_response_spec.rb +71 -0
- data/spec/models/repository_version_spec.rb +41 -0
- data/spec/spec_helper.rb +111 -0
- metadata +251 -0
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpCookbookClient::PaginatedcookbookCookbookRepositoryResponseList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
**_next** | **String** | | [optional]
|
9
|
+
**previous** | **String** | | [optional]
|
10
|
+
**results** | [**Array<CookbookCookbookRepositoryResponse>**](CookbookCookbookRepositoryResponse.md) | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpCookbookClient'
|
16
|
+
|
17
|
+
instance = PulpCookbookClient::PaginatedcookbookCookbookRepositoryResponseList.new(count: 123,
|
18
|
+
_next: http://api.example.org/accounts/?offset=400&limit=100,
|
19
|
+
previous: http://api.example.org/accounts/?offset=200&limit=100,
|
20
|
+
results: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# PulpCookbookClient::PatchedcookbookCookbookDistribution
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**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]
|
8
|
+
**content_guard** | **String** | An optional content-guard. | [optional]
|
9
|
+
**pulp_labels** | [**Object**](.md) | | [optional]
|
10
|
+
**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | [optional]
|
11
|
+
**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
|
12
|
+
**publication** | **String** | Publication to be served | [optional]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'PulpCookbookClient'
|
18
|
+
|
19
|
+
instance = PulpCookbookClient::PatchedcookbookCookbookDistribution.new(base_path: null,
|
20
|
+
content_guard: null,
|
21
|
+
pulp_labels: null,
|
22
|
+
name: null,
|
23
|
+
repository: null,
|
24
|
+
publication: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,59 @@
|
|
1
|
+
# PulpCookbookClient::PatchedcookbookCookbookRemote
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | A unique name for this remote. | [optional]
|
8
|
+
**url** | **String** | The URL of an external content source. | [optional]
|
9
|
+
**ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
|
10
|
+
**client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional]
|
11
|
+
**client_key** | **String** | A PEM encoded private key used for authentication. | [optional]
|
12
|
+
**tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional]
|
13
|
+
**proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional]
|
14
|
+
**proxy_username** | **String** | The username to authenticte to the proxy. | [optional]
|
15
|
+
**proxy_password** | **String** | The password to authenticte to the proxy. | [optional]
|
16
|
+
**username** | **String** | The username to be used for authentication when syncing. | [optional]
|
17
|
+
**password** | **String** | The password to be used for authentication when syncing. | [optional]
|
18
|
+
**pulp_labels** | [**Object**](.md) | | [optional]
|
19
|
+
**download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
|
20
|
+
**max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional]
|
21
|
+
**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]
|
22
|
+
**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]
|
23
|
+
**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]
|
24
|
+
**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]
|
25
|
+
**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]
|
26
|
+
**headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional]
|
27
|
+
**rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional]
|
28
|
+
**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]
|
29
|
+
|
30
|
+
## Code Sample
|
31
|
+
|
32
|
+
```ruby
|
33
|
+
require 'PulpCookbookClient'
|
34
|
+
|
35
|
+
instance = PulpCookbookClient::PatchedcookbookCookbookRemote.new(name: null,
|
36
|
+
url: null,
|
37
|
+
ca_cert: null,
|
38
|
+
client_cert: null,
|
39
|
+
client_key: null,
|
40
|
+
tls_validation: null,
|
41
|
+
proxy_url: null,
|
42
|
+
proxy_username: null,
|
43
|
+
proxy_password: null,
|
44
|
+
username: null,
|
45
|
+
password: null,
|
46
|
+
pulp_labels: null,
|
47
|
+
download_concurrency: null,
|
48
|
+
max_retries: null,
|
49
|
+
policy: null,
|
50
|
+
total_timeout: null,
|
51
|
+
connect_timeout: null,
|
52
|
+
sock_connect_timeout: null,
|
53
|
+
sock_read_timeout: null,
|
54
|
+
headers: null,
|
55
|
+
rate_limit: null,
|
56
|
+
cookbooks: null)
|
57
|
+
```
|
58
|
+
|
59
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# PulpCookbookClient::PatchedcookbookCookbookRepository
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**pulp_labels** | [**Object**](.md) | | [optional]
|
8
|
+
**name** | **String** | A unique name for this repository. | [optional]
|
9
|
+
**description** | **String** | An optional description. | [optional]
|
10
|
+
**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]
|
11
|
+
**remote** | **String** | An optional remote to use by default when syncing. | [optional]
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'PulpCookbookClient'
|
17
|
+
|
18
|
+
instance = PulpCookbookClient::PatchedcookbookCookbookRepository.new(pulp_labels: null,
|
19
|
+
name: null,
|
20
|
+
description: null,
|
21
|
+
retain_repo_versions: null,
|
22
|
+
remote: null)
|
23
|
+
```
|
24
|
+
|
25
|
+
|
data/docs/PolicyEnum.md
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
# PulpCookbookClient::PolicyEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
|
8
|
+
## Code Sample
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'PulpCookbookClient'
|
12
|
+
|
13
|
+
instance = PulpCookbookClient::PolicyEnum.new()
|
14
|
+
```
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,257 @@
|
|
1
|
+
# PulpCookbookClient::PublicationsCookbookApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pulp*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create**](PublicationsCookbookApi.md#create) | **POST** /pulp/api/v3/publications/cookbook/cookbook/ | Create a cookbook publication
|
8
|
+
[**delete**](PublicationsCookbookApi.md#delete) | **DELETE** {cookbook_cookbook_publication_href} | Delete a cookbook publication
|
9
|
+
[**list**](PublicationsCookbookApi.md#list) | **GET** /pulp/api/v3/publications/cookbook/cookbook/ | List cookbook publications
|
10
|
+
[**read**](PublicationsCookbookApi.md#read) | **GET** {cookbook_cookbook_publication_href} | Inspect a cookbook publication
|
11
|
+
|
12
|
+
|
13
|
+
|
14
|
+
## create
|
15
|
+
|
16
|
+
> AsyncOperationResponse create(cookbook_cookbook_publication)
|
17
|
+
|
18
|
+
Create a cookbook publication
|
19
|
+
|
20
|
+
Trigger an asynchronous task to publish cookbook content.
|
21
|
+
|
22
|
+
### Example
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
# load the gem
|
26
|
+
require 'pulp_cookbook_client'
|
27
|
+
# setup authorization
|
28
|
+
PulpCookbookClient.configure do |config|
|
29
|
+
# Configure HTTP basic authorization: basicAuth
|
30
|
+
config.username = 'YOUR USERNAME'
|
31
|
+
config.password = 'YOUR PASSWORD'
|
32
|
+
end
|
33
|
+
|
34
|
+
api_instance = PulpCookbookClient::PublicationsCookbookApi.new
|
35
|
+
cookbook_cookbook_publication = PulpCookbookClient::CookbookCookbookPublication.new # CookbookCookbookPublication |
|
36
|
+
|
37
|
+
begin
|
38
|
+
#Create a cookbook publication
|
39
|
+
result = api_instance.create(cookbook_cookbook_publication)
|
40
|
+
p result
|
41
|
+
rescue PulpCookbookClient::ApiError => e
|
42
|
+
puts "Exception when calling PublicationsCookbookApi->create: #{e}"
|
43
|
+
end
|
44
|
+
```
|
45
|
+
|
46
|
+
### Parameters
|
47
|
+
|
48
|
+
|
49
|
+
Name | Type | Description | Notes
|
50
|
+
------------- | ------------- | ------------- | -------------
|
51
|
+
**cookbook_cookbook_publication** | [**CookbookCookbookPublication**](CookbookCookbookPublication.md)| |
|
52
|
+
|
53
|
+
### Return type
|
54
|
+
|
55
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
56
|
+
|
57
|
+
### Authorization
|
58
|
+
|
59
|
+
[basicAuth](../README.md#basicAuth)
|
60
|
+
|
61
|
+
### HTTP request headers
|
62
|
+
|
63
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
64
|
+
- **Accept**: application/json
|
65
|
+
|
66
|
+
|
67
|
+
## delete
|
68
|
+
|
69
|
+
> delete(cookbook_cookbook_publication_href)
|
70
|
+
|
71
|
+
Delete a cookbook publication
|
72
|
+
|
73
|
+
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.
|
74
|
+
|
75
|
+
### Example
|
76
|
+
|
77
|
+
```ruby
|
78
|
+
# load the gem
|
79
|
+
require 'pulp_cookbook_client'
|
80
|
+
# setup authorization
|
81
|
+
PulpCookbookClient.configure do |config|
|
82
|
+
# Configure HTTP basic authorization: basicAuth
|
83
|
+
config.username = 'YOUR USERNAME'
|
84
|
+
config.password = 'YOUR PASSWORD'
|
85
|
+
end
|
86
|
+
|
87
|
+
api_instance = PulpCookbookClient::PublicationsCookbookApi.new
|
88
|
+
cookbook_cookbook_publication_href = 'cookbook_cookbook_publication_href_example' # String |
|
89
|
+
|
90
|
+
begin
|
91
|
+
#Delete a cookbook publication
|
92
|
+
api_instance.delete(cookbook_cookbook_publication_href)
|
93
|
+
rescue PulpCookbookClient::ApiError => e
|
94
|
+
puts "Exception when calling PublicationsCookbookApi->delete: #{e}"
|
95
|
+
end
|
96
|
+
```
|
97
|
+
|
98
|
+
### Parameters
|
99
|
+
|
100
|
+
|
101
|
+
Name | Type | Description | Notes
|
102
|
+
------------- | ------------- | ------------- | -------------
|
103
|
+
**cookbook_cookbook_publication_href** | **String**| |
|
104
|
+
|
105
|
+
### Return type
|
106
|
+
|
107
|
+
nil (empty response body)
|
108
|
+
|
109
|
+
### Authorization
|
110
|
+
|
111
|
+
[basicAuth](../README.md#basicAuth)
|
112
|
+
|
113
|
+
### HTTP request headers
|
114
|
+
|
115
|
+
- **Content-Type**: Not defined
|
116
|
+
- **Accept**: Not defined
|
117
|
+
|
118
|
+
|
119
|
+
## list
|
120
|
+
|
121
|
+
> PaginatedcookbookCookbookPublicationResponseList list(opts)
|
122
|
+
|
123
|
+
List cookbook publications
|
124
|
+
|
125
|
+
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.
|
126
|
+
|
127
|
+
### Example
|
128
|
+
|
129
|
+
```ruby
|
130
|
+
# load the gem
|
131
|
+
require 'pulp_cookbook_client'
|
132
|
+
# setup authorization
|
133
|
+
PulpCookbookClient.configure do |config|
|
134
|
+
# Configure HTTP basic authorization: basicAuth
|
135
|
+
config.username = 'YOUR USERNAME'
|
136
|
+
config.password = 'YOUR PASSWORD'
|
137
|
+
end
|
138
|
+
|
139
|
+
api_instance = PulpCookbookClient::PublicationsCookbookApi.new
|
140
|
+
opts = {
|
141
|
+
content: 'content_example', # String | Content Unit referenced by HREF
|
142
|
+
content__in: 'content__in_example', # String | Content Unit referenced by HREF
|
143
|
+
limit: 56, # Integer | Number of results to return per page.
|
144
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
145
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
146
|
+
pulp_created: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | ISO 8601 formatted dates are supported
|
147
|
+
pulp_created__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than value
|
148
|
+
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
|
149
|
+
pulp_created__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than value
|
150
|
+
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
|
151
|
+
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
|
152
|
+
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
|
153
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
154
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
155
|
+
}
|
156
|
+
|
157
|
+
begin
|
158
|
+
#List cookbook publications
|
159
|
+
result = api_instance.list(opts)
|
160
|
+
p result
|
161
|
+
rescue PulpCookbookClient::ApiError => e
|
162
|
+
puts "Exception when calling PublicationsCookbookApi->list: #{e}"
|
163
|
+
end
|
164
|
+
```
|
165
|
+
|
166
|
+
### Parameters
|
167
|
+
|
168
|
+
|
169
|
+
Name | Type | Description | Notes
|
170
|
+
------------- | ------------- | ------------- | -------------
|
171
|
+
**content** | **String**| Content Unit referenced by HREF | [optional]
|
172
|
+
**content__in** | **String**| Content Unit referenced by HREF | [optional]
|
173
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
174
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
175
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
176
|
+
**pulp_created** | **DateTime**| ISO 8601 formatted dates are supported | [optional]
|
177
|
+
**pulp_created__gt** | **DateTime**| Filter results where pulp_created is greater than value | [optional]
|
178
|
+
**pulp_created__gte** | **DateTime**| Filter results where pulp_created is greater than or equal to value | [optional]
|
179
|
+
**pulp_created__lt** | **DateTime**| Filter results where pulp_created is less than value | [optional]
|
180
|
+
**pulp_created__lte** | **DateTime**| Filter results where pulp_created is less than or equal to value | [optional]
|
181
|
+
**pulp_created__range** | [**Array<DateTime>**](DateTime.md)| Filter results where pulp_created is between two comma separated values | [optional]
|
182
|
+
**repository_version** | [**String**](.md)| Repository Version referenced by HREF | [optional]
|
183
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
184
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
185
|
+
|
186
|
+
### Return type
|
187
|
+
|
188
|
+
[**PaginatedcookbookCookbookPublicationResponseList**](PaginatedcookbookCookbookPublicationResponseList.md)
|
189
|
+
|
190
|
+
### Authorization
|
191
|
+
|
192
|
+
[basicAuth](../README.md#basicAuth)
|
193
|
+
|
194
|
+
### HTTP request headers
|
195
|
+
|
196
|
+
- **Content-Type**: Not defined
|
197
|
+
- **Accept**: application/json
|
198
|
+
|
199
|
+
|
200
|
+
## read
|
201
|
+
|
202
|
+
> CookbookCookbookPublicationResponse read(cookbook_cookbook_publication_href, opts)
|
203
|
+
|
204
|
+
Inspect a cookbook publication
|
205
|
+
|
206
|
+
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.
|
207
|
+
|
208
|
+
### Example
|
209
|
+
|
210
|
+
```ruby
|
211
|
+
# load the gem
|
212
|
+
require 'pulp_cookbook_client'
|
213
|
+
# setup authorization
|
214
|
+
PulpCookbookClient.configure do |config|
|
215
|
+
# Configure HTTP basic authorization: basicAuth
|
216
|
+
config.username = 'YOUR USERNAME'
|
217
|
+
config.password = 'YOUR PASSWORD'
|
218
|
+
end
|
219
|
+
|
220
|
+
api_instance = PulpCookbookClient::PublicationsCookbookApi.new
|
221
|
+
cookbook_cookbook_publication_href = 'cookbook_cookbook_publication_href_example' # String |
|
222
|
+
opts = {
|
223
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
224
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
225
|
+
}
|
226
|
+
|
227
|
+
begin
|
228
|
+
#Inspect a cookbook publication
|
229
|
+
result = api_instance.read(cookbook_cookbook_publication_href, opts)
|
230
|
+
p result
|
231
|
+
rescue PulpCookbookClient::ApiError => e
|
232
|
+
puts "Exception when calling PublicationsCookbookApi->read: #{e}"
|
233
|
+
end
|
234
|
+
```
|
235
|
+
|
236
|
+
### Parameters
|
237
|
+
|
238
|
+
|
239
|
+
Name | Type | Description | Notes
|
240
|
+
------------- | ------------- | ------------- | -------------
|
241
|
+
**cookbook_cookbook_publication_href** | **String**| |
|
242
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
243
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
244
|
+
|
245
|
+
### Return type
|
246
|
+
|
247
|
+
[**CookbookCookbookPublicationResponse**](CookbookCookbookPublicationResponse.md)
|
248
|
+
|
249
|
+
### Authorization
|
250
|
+
|
251
|
+
[basicAuth](../README.md#basicAuth)
|
252
|
+
|
253
|
+
### HTTP request headers
|
254
|
+
|
255
|
+
- **Content-Type**: Not defined
|
256
|
+
- **Accept**: application/json
|
257
|
+
|