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,475 @@
|
|
1
|
+
# PulpCookbookClient::RepositoriesCookbookApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pulp*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create**](RepositoriesCookbookApi.md#create) | **POST** /pulp/api/v3/repositories/cookbook/cookbook/ | Create a cookbook repository
|
8
|
+
[**delete**](RepositoriesCookbookApi.md#delete) | **DELETE** {cookbook_cookbook_repository_href} | Delete a cookbook repository
|
9
|
+
[**list**](RepositoriesCookbookApi.md#list) | **GET** /pulp/api/v3/repositories/cookbook/cookbook/ | List cookbook repositorys
|
10
|
+
[**modify**](RepositoriesCookbookApi.md#modify) | **POST** {cookbook_cookbook_repository_href}modify/ | Modify Repository Content
|
11
|
+
[**partial_update**](RepositoriesCookbookApi.md#partial_update) | **PATCH** {cookbook_cookbook_repository_href} | Update a cookbook repository
|
12
|
+
[**read**](RepositoriesCookbookApi.md#read) | **GET** {cookbook_cookbook_repository_href} | Inspect a cookbook repository
|
13
|
+
[**sync**](RepositoriesCookbookApi.md#sync) | **POST** {cookbook_cookbook_repository_href}sync/ |
|
14
|
+
[**update**](RepositoriesCookbookApi.md#update) | **PUT** {cookbook_cookbook_repository_href} | Update a cookbook repository
|
15
|
+
|
16
|
+
|
17
|
+
|
18
|
+
## create
|
19
|
+
|
20
|
+
> CookbookCookbookRepositoryResponse create(cookbook_cookbook_repository)
|
21
|
+
|
22
|
+
Create a cookbook repository
|
23
|
+
|
24
|
+
Cookbook Repository Endpoint. CookbookRepository represents a single cookbook repository, to which content can be synced, added, or removed.
|
25
|
+
|
26
|
+
### Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
# load the gem
|
30
|
+
require 'pulp_cookbook_client'
|
31
|
+
# setup authorization
|
32
|
+
PulpCookbookClient.configure do |config|
|
33
|
+
# Configure HTTP basic authorization: basicAuth
|
34
|
+
config.username = 'YOUR USERNAME'
|
35
|
+
config.password = 'YOUR PASSWORD'
|
36
|
+
end
|
37
|
+
|
38
|
+
api_instance = PulpCookbookClient::RepositoriesCookbookApi.new
|
39
|
+
cookbook_cookbook_repository = PulpCookbookClient::CookbookCookbookRepository.new # CookbookCookbookRepository |
|
40
|
+
|
41
|
+
begin
|
42
|
+
#Create a cookbook repository
|
43
|
+
result = api_instance.create(cookbook_cookbook_repository)
|
44
|
+
p result
|
45
|
+
rescue PulpCookbookClient::ApiError => e
|
46
|
+
puts "Exception when calling RepositoriesCookbookApi->create: #{e}"
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
### Parameters
|
51
|
+
|
52
|
+
|
53
|
+
Name | Type | Description | Notes
|
54
|
+
------------- | ------------- | ------------- | -------------
|
55
|
+
**cookbook_cookbook_repository** | [**CookbookCookbookRepository**](CookbookCookbookRepository.md)| |
|
56
|
+
|
57
|
+
### Return type
|
58
|
+
|
59
|
+
[**CookbookCookbookRepositoryResponse**](CookbookCookbookRepositoryResponse.md)
|
60
|
+
|
61
|
+
### Authorization
|
62
|
+
|
63
|
+
[basicAuth](../README.md#basicAuth)
|
64
|
+
|
65
|
+
### HTTP request headers
|
66
|
+
|
67
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
68
|
+
- **Accept**: application/json
|
69
|
+
|
70
|
+
|
71
|
+
## delete
|
72
|
+
|
73
|
+
> AsyncOperationResponse delete(cookbook_cookbook_repository_href)
|
74
|
+
|
75
|
+
Delete a cookbook repository
|
76
|
+
|
77
|
+
Trigger an asynchronous delete task
|
78
|
+
|
79
|
+
### Example
|
80
|
+
|
81
|
+
```ruby
|
82
|
+
# load the gem
|
83
|
+
require 'pulp_cookbook_client'
|
84
|
+
# setup authorization
|
85
|
+
PulpCookbookClient.configure do |config|
|
86
|
+
# Configure HTTP basic authorization: basicAuth
|
87
|
+
config.username = 'YOUR USERNAME'
|
88
|
+
config.password = 'YOUR PASSWORD'
|
89
|
+
end
|
90
|
+
|
91
|
+
api_instance = PulpCookbookClient::RepositoriesCookbookApi.new
|
92
|
+
cookbook_cookbook_repository_href = 'cookbook_cookbook_repository_href_example' # String |
|
93
|
+
|
94
|
+
begin
|
95
|
+
#Delete a cookbook repository
|
96
|
+
result = api_instance.delete(cookbook_cookbook_repository_href)
|
97
|
+
p result
|
98
|
+
rescue PulpCookbookClient::ApiError => e
|
99
|
+
puts "Exception when calling RepositoriesCookbookApi->delete: #{e}"
|
100
|
+
end
|
101
|
+
```
|
102
|
+
|
103
|
+
### Parameters
|
104
|
+
|
105
|
+
|
106
|
+
Name | Type | Description | Notes
|
107
|
+
------------- | ------------- | ------------- | -------------
|
108
|
+
**cookbook_cookbook_repository_href** | **String**| |
|
109
|
+
|
110
|
+
### Return type
|
111
|
+
|
112
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
113
|
+
|
114
|
+
### Authorization
|
115
|
+
|
116
|
+
[basicAuth](../README.md#basicAuth)
|
117
|
+
|
118
|
+
### HTTP request headers
|
119
|
+
|
120
|
+
- **Content-Type**: Not defined
|
121
|
+
- **Accept**: application/json
|
122
|
+
|
123
|
+
|
124
|
+
## list
|
125
|
+
|
126
|
+
> PaginatedcookbookCookbookRepositoryResponseList list(opts)
|
127
|
+
|
128
|
+
List cookbook repositorys
|
129
|
+
|
130
|
+
Cookbook Repository Endpoint. CookbookRepository represents a single cookbook repository, to which content can be synced, added, or removed.
|
131
|
+
|
132
|
+
### Example
|
133
|
+
|
134
|
+
```ruby
|
135
|
+
# load the gem
|
136
|
+
require 'pulp_cookbook_client'
|
137
|
+
# setup authorization
|
138
|
+
PulpCookbookClient.configure do |config|
|
139
|
+
# Configure HTTP basic authorization: basicAuth
|
140
|
+
config.username = 'YOUR USERNAME'
|
141
|
+
config.password = 'YOUR PASSWORD'
|
142
|
+
end
|
143
|
+
|
144
|
+
api_instance = PulpCookbookClient::RepositoriesCookbookApi.new
|
145
|
+
opts = {
|
146
|
+
limit: 56, # Integer | Number of results to return per page.
|
147
|
+
name: 'name_example', # String |
|
148
|
+
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
149
|
+
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
150
|
+
name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
151
|
+
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
152
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
153
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
154
|
+
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
155
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
156
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
157
|
+
}
|
158
|
+
|
159
|
+
begin
|
160
|
+
#List cookbook repositorys
|
161
|
+
result = api_instance.list(opts)
|
162
|
+
p result
|
163
|
+
rescue PulpCookbookClient::ApiError => e
|
164
|
+
puts "Exception when calling RepositoriesCookbookApi->list: #{e}"
|
165
|
+
end
|
166
|
+
```
|
167
|
+
|
168
|
+
### Parameters
|
169
|
+
|
170
|
+
|
171
|
+
Name | Type | Description | Notes
|
172
|
+
------------- | ------------- | ------------- | -------------
|
173
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
174
|
+
**name** | **String**| | [optional]
|
175
|
+
**name__contains** | **String**| Filter results where name contains value | [optional]
|
176
|
+
**name__icontains** | **String**| Filter results where name contains value | [optional]
|
177
|
+
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
178
|
+
**name__startswith** | **String**| Filter results where name starts with value | [optional]
|
179
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
180
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
181
|
+
**pulp_label_select** | **String**| Filter labels by search string | [optional]
|
182
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
183
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
184
|
+
|
185
|
+
### Return type
|
186
|
+
|
187
|
+
[**PaginatedcookbookCookbookRepositoryResponseList**](PaginatedcookbookCookbookRepositoryResponseList.md)
|
188
|
+
|
189
|
+
### Authorization
|
190
|
+
|
191
|
+
[basicAuth](../README.md#basicAuth)
|
192
|
+
|
193
|
+
### HTTP request headers
|
194
|
+
|
195
|
+
- **Content-Type**: Not defined
|
196
|
+
- **Accept**: application/json
|
197
|
+
|
198
|
+
|
199
|
+
## modify
|
200
|
+
|
201
|
+
> AsyncOperationResponse modify(cookbook_cookbook_repository_href, repository_add_remove_content)
|
202
|
+
|
203
|
+
Modify Repository Content
|
204
|
+
|
205
|
+
Trigger an asynchronous task to create a new repository version.
|
206
|
+
|
207
|
+
### Example
|
208
|
+
|
209
|
+
```ruby
|
210
|
+
# load the gem
|
211
|
+
require 'pulp_cookbook_client'
|
212
|
+
# setup authorization
|
213
|
+
PulpCookbookClient.configure do |config|
|
214
|
+
# Configure HTTP basic authorization: basicAuth
|
215
|
+
config.username = 'YOUR USERNAME'
|
216
|
+
config.password = 'YOUR PASSWORD'
|
217
|
+
end
|
218
|
+
|
219
|
+
api_instance = PulpCookbookClient::RepositoriesCookbookApi.new
|
220
|
+
cookbook_cookbook_repository_href = 'cookbook_cookbook_repository_href_example' # String |
|
221
|
+
repository_add_remove_content = PulpCookbookClient::RepositoryAddRemoveContent.new # RepositoryAddRemoveContent |
|
222
|
+
|
223
|
+
begin
|
224
|
+
#Modify Repository Content
|
225
|
+
result = api_instance.modify(cookbook_cookbook_repository_href, repository_add_remove_content)
|
226
|
+
p result
|
227
|
+
rescue PulpCookbookClient::ApiError => e
|
228
|
+
puts "Exception when calling RepositoriesCookbookApi->modify: #{e}"
|
229
|
+
end
|
230
|
+
```
|
231
|
+
|
232
|
+
### Parameters
|
233
|
+
|
234
|
+
|
235
|
+
Name | Type | Description | Notes
|
236
|
+
------------- | ------------- | ------------- | -------------
|
237
|
+
**cookbook_cookbook_repository_href** | **String**| |
|
238
|
+
**repository_add_remove_content** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md)| |
|
239
|
+
|
240
|
+
### Return type
|
241
|
+
|
242
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
243
|
+
|
244
|
+
### Authorization
|
245
|
+
|
246
|
+
[basicAuth](../README.md#basicAuth)
|
247
|
+
|
248
|
+
### HTTP request headers
|
249
|
+
|
250
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
251
|
+
- **Accept**: application/json
|
252
|
+
|
253
|
+
|
254
|
+
## partial_update
|
255
|
+
|
256
|
+
> AsyncOperationResponse partial_update(cookbook_cookbook_repository_href, patchedcookbook_cookbook_repository)
|
257
|
+
|
258
|
+
Update a cookbook repository
|
259
|
+
|
260
|
+
Trigger an asynchronous partial update task
|
261
|
+
|
262
|
+
### Example
|
263
|
+
|
264
|
+
```ruby
|
265
|
+
# load the gem
|
266
|
+
require 'pulp_cookbook_client'
|
267
|
+
# setup authorization
|
268
|
+
PulpCookbookClient.configure do |config|
|
269
|
+
# Configure HTTP basic authorization: basicAuth
|
270
|
+
config.username = 'YOUR USERNAME'
|
271
|
+
config.password = 'YOUR PASSWORD'
|
272
|
+
end
|
273
|
+
|
274
|
+
api_instance = PulpCookbookClient::RepositoriesCookbookApi.new
|
275
|
+
cookbook_cookbook_repository_href = 'cookbook_cookbook_repository_href_example' # String |
|
276
|
+
patchedcookbook_cookbook_repository = PulpCookbookClient::PatchedcookbookCookbookRepository.new # PatchedcookbookCookbookRepository |
|
277
|
+
|
278
|
+
begin
|
279
|
+
#Update a cookbook repository
|
280
|
+
result = api_instance.partial_update(cookbook_cookbook_repository_href, patchedcookbook_cookbook_repository)
|
281
|
+
p result
|
282
|
+
rescue PulpCookbookClient::ApiError => e
|
283
|
+
puts "Exception when calling RepositoriesCookbookApi->partial_update: #{e}"
|
284
|
+
end
|
285
|
+
```
|
286
|
+
|
287
|
+
### Parameters
|
288
|
+
|
289
|
+
|
290
|
+
Name | Type | Description | Notes
|
291
|
+
------------- | ------------- | ------------- | -------------
|
292
|
+
**cookbook_cookbook_repository_href** | **String**| |
|
293
|
+
**patchedcookbook_cookbook_repository** | [**PatchedcookbookCookbookRepository**](PatchedcookbookCookbookRepository.md)| |
|
294
|
+
|
295
|
+
### Return type
|
296
|
+
|
297
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
298
|
+
|
299
|
+
### Authorization
|
300
|
+
|
301
|
+
[basicAuth](../README.md#basicAuth)
|
302
|
+
|
303
|
+
### HTTP request headers
|
304
|
+
|
305
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
306
|
+
- **Accept**: application/json
|
307
|
+
|
308
|
+
|
309
|
+
## read
|
310
|
+
|
311
|
+
> CookbookCookbookRepositoryResponse read(cookbook_cookbook_repository_href, opts)
|
312
|
+
|
313
|
+
Inspect a cookbook repository
|
314
|
+
|
315
|
+
Cookbook Repository Endpoint. CookbookRepository represents a single cookbook repository, to which content can be synced, added, or removed.
|
316
|
+
|
317
|
+
### Example
|
318
|
+
|
319
|
+
```ruby
|
320
|
+
# load the gem
|
321
|
+
require 'pulp_cookbook_client'
|
322
|
+
# setup authorization
|
323
|
+
PulpCookbookClient.configure do |config|
|
324
|
+
# Configure HTTP basic authorization: basicAuth
|
325
|
+
config.username = 'YOUR USERNAME'
|
326
|
+
config.password = 'YOUR PASSWORD'
|
327
|
+
end
|
328
|
+
|
329
|
+
api_instance = PulpCookbookClient::RepositoriesCookbookApi.new
|
330
|
+
cookbook_cookbook_repository_href = 'cookbook_cookbook_repository_href_example' # String |
|
331
|
+
opts = {
|
332
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
333
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
334
|
+
}
|
335
|
+
|
336
|
+
begin
|
337
|
+
#Inspect a cookbook repository
|
338
|
+
result = api_instance.read(cookbook_cookbook_repository_href, opts)
|
339
|
+
p result
|
340
|
+
rescue PulpCookbookClient::ApiError => e
|
341
|
+
puts "Exception when calling RepositoriesCookbookApi->read: #{e}"
|
342
|
+
end
|
343
|
+
```
|
344
|
+
|
345
|
+
### Parameters
|
346
|
+
|
347
|
+
|
348
|
+
Name | Type | Description | Notes
|
349
|
+
------------- | ------------- | ------------- | -------------
|
350
|
+
**cookbook_cookbook_repository_href** | **String**| |
|
351
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
352
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
353
|
+
|
354
|
+
### Return type
|
355
|
+
|
356
|
+
[**CookbookCookbookRepositoryResponse**](CookbookCookbookRepositoryResponse.md)
|
357
|
+
|
358
|
+
### Authorization
|
359
|
+
|
360
|
+
[basicAuth](../README.md#basicAuth)
|
361
|
+
|
362
|
+
### HTTP request headers
|
363
|
+
|
364
|
+
- **Content-Type**: Not defined
|
365
|
+
- **Accept**: application/json
|
366
|
+
|
367
|
+
|
368
|
+
## sync
|
369
|
+
|
370
|
+
> AsyncOperationResponse sync(cookbook_cookbook_repository_href, repository_sync_url)
|
371
|
+
|
372
|
+
|
373
|
+
|
374
|
+
Trigger an asynchronous task to sync cookbook content.
|
375
|
+
|
376
|
+
### Example
|
377
|
+
|
378
|
+
```ruby
|
379
|
+
# load the gem
|
380
|
+
require 'pulp_cookbook_client'
|
381
|
+
# setup authorization
|
382
|
+
PulpCookbookClient.configure do |config|
|
383
|
+
# Configure HTTP basic authorization: basicAuth
|
384
|
+
config.username = 'YOUR USERNAME'
|
385
|
+
config.password = 'YOUR PASSWORD'
|
386
|
+
end
|
387
|
+
|
388
|
+
api_instance = PulpCookbookClient::RepositoriesCookbookApi.new
|
389
|
+
cookbook_cookbook_repository_href = 'cookbook_cookbook_repository_href_example' # String |
|
390
|
+
repository_sync_url = PulpCookbookClient::RepositorySyncURL.new # RepositorySyncURL |
|
391
|
+
|
392
|
+
begin
|
393
|
+
result = api_instance.sync(cookbook_cookbook_repository_href, repository_sync_url)
|
394
|
+
p result
|
395
|
+
rescue PulpCookbookClient::ApiError => e
|
396
|
+
puts "Exception when calling RepositoriesCookbookApi->sync: #{e}"
|
397
|
+
end
|
398
|
+
```
|
399
|
+
|
400
|
+
### Parameters
|
401
|
+
|
402
|
+
|
403
|
+
Name | Type | Description | Notes
|
404
|
+
------------- | ------------- | ------------- | -------------
|
405
|
+
**cookbook_cookbook_repository_href** | **String**| |
|
406
|
+
**repository_sync_url** | [**RepositorySyncURL**](RepositorySyncURL.md)| |
|
407
|
+
|
408
|
+
### Return type
|
409
|
+
|
410
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
411
|
+
|
412
|
+
### Authorization
|
413
|
+
|
414
|
+
[basicAuth](../README.md#basicAuth)
|
415
|
+
|
416
|
+
### HTTP request headers
|
417
|
+
|
418
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
419
|
+
- **Accept**: application/json
|
420
|
+
|
421
|
+
|
422
|
+
## update
|
423
|
+
|
424
|
+
> AsyncOperationResponse update(cookbook_cookbook_repository_href, cookbook_cookbook_repository)
|
425
|
+
|
426
|
+
Update a cookbook repository
|
427
|
+
|
428
|
+
Trigger an asynchronous update task
|
429
|
+
|
430
|
+
### Example
|
431
|
+
|
432
|
+
```ruby
|
433
|
+
# load the gem
|
434
|
+
require 'pulp_cookbook_client'
|
435
|
+
# setup authorization
|
436
|
+
PulpCookbookClient.configure do |config|
|
437
|
+
# Configure HTTP basic authorization: basicAuth
|
438
|
+
config.username = 'YOUR USERNAME'
|
439
|
+
config.password = 'YOUR PASSWORD'
|
440
|
+
end
|
441
|
+
|
442
|
+
api_instance = PulpCookbookClient::RepositoriesCookbookApi.new
|
443
|
+
cookbook_cookbook_repository_href = 'cookbook_cookbook_repository_href_example' # String |
|
444
|
+
cookbook_cookbook_repository = PulpCookbookClient::CookbookCookbookRepository.new # CookbookCookbookRepository |
|
445
|
+
|
446
|
+
begin
|
447
|
+
#Update a cookbook repository
|
448
|
+
result = api_instance.update(cookbook_cookbook_repository_href, cookbook_cookbook_repository)
|
449
|
+
p result
|
450
|
+
rescue PulpCookbookClient::ApiError => e
|
451
|
+
puts "Exception when calling RepositoriesCookbookApi->update: #{e}"
|
452
|
+
end
|
453
|
+
```
|
454
|
+
|
455
|
+
### Parameters
|
456
|
+
|
457
|
+
|
458
|
+
Name | Type | Description | Notes
|
459
|
+
------------- | ------------- | ------------- | -------------
|
460
|
+
**cookbook_cookbook_repository_href** | **String**| |
|
461
|
+
**cookbook_cookbook_repository** | [**CookbookCookbookRepository**](CookbookCookbookRepository.md)| |
|
462
|
+
|
463
|
+
### Return type
|
464
|
+
|
465
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
466
|
+
|
467
|
+
### Authorization
|
468
|
+
|
469
|
+
[basicAuth](../README.md#basicAuth)
|
470
|
+
|
471
|
+
### HTTP request headers
|
472
|
+
|
473
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
474
|
+
- **Accept**: application/json
|
475
|
+
|