pulp_container_client 1.0.0rc1
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 +164 -0
- data/Rakefile +10 -0
- data/docs/AsyncOperationResponse.md +17 -0
- data/docs/ContainerBlob.md +25 -0
- data/docs/ContainerContainerDistribution.md +31 -0
- data/docs/ContainerContainerRemote.md +43 -0
- data/docs/ContainerContainerRepository.md +27 -0
- data/docs/ContainerManifest.md +33 -0
- data/docs/ContainerTag.md +25 -0
- data/docs/ContentBlobsApi.md +142 -0
- data/docs/ContentManifestsApi.md +142 -0
- data/docs/ContentSummary.md +21 -0
- data/docs/ContentTagsApi.md +144 -0
- data/docs/DistributionsContainerApi.md +362 -0
- data/docs/InlineResponse200.md +23 -0
- data/docs/InlineResponse2001.md +23 -0
- data/docs/InlineResponse2002.md +23 -0
- data/docs/InlineResponse2003.md +23 -0
- data/docs/InlineResponse2004.md +23 -0
- data/docs/InlineResponse2005.md +23 -0
- data/docs/InlineResponse2006.md +23 -0
- data/docs/ManifestCopy.md +23 -0
- data/docs/RecursiveManage.md +17 -0
- data/docs/RemotesContainerApi.md +366 -0
- data/docs/RepositoriesContainerApi.md +739 -0
- data/docs/RepositoriesContainerVersionsApi.md +214 -0
- data/docs/RepositorySyncURL.md +19 -0
- data/docs/RepositoryVersion.md +25 -0
- data/docs/TagCopy.md +21 -0
- data/docs/TagImage.md +19 -0
- data/docs/UnTagImage.md +17 -0
- data/git_push.sh +58 -0
- data/lib/pulp_container_client/api/content_blobs_api.rb +176 -0
- data/lib/pulp_container_client/api/content_manifests_api.rb +176 -0
- data/lib/pulp_container_client/api/content_tags_api.rb +179 -0
- data/lib/pulp_container_client/api/distributions_container_api.rb +442 -0
- data/lib/pulp_container_client/api/remotes_container_api.rb +448 -0
- data/lib/pulp_container_client/api/repositories_container_api.rb +906 -0
- data/lib/pulp_container_client/api/repositories_container_versions_api.rb +268 -0
- data/lib/pulp_container_client/api_client.rb +402 -0
- data/lib/pulp_container_client/api_error.rb +57 -0
- data/lib/pulp_container_client/configuration.rb +243 -0
- data/lib/pulp_container_client/models/async_operation_response.rb +212 -0
- data/lib/pulp_container_client/models/container_blob.rb +299 -0
- data/lib/pulp_container_client/models/container_container_distribution.rb +342 -0
- data/lib/pulp_container_client/models/container_container_remote.rb +526 -0
- data/lib/pulp_container_client/models/container_container_repository.rb +294 -0
- data/lib/pulp_container_client/models/container_manifest.rb +363 -0
- data/lib/pulp_container_client/models/container_tag.rb +280 -0
- data/lib/pulp_container_client/models/content_summary.rb +246 -0
- data/lib/pulp_container_client/models/inline_response200.rb +247 -0
- data/lib/pulp_container_client/models/inline_response2001.rb +247 -0
- data/lib/pulp_container_client/models/inline_response2002.rb +247 -0
- data/lib/pulp_container_client/models/inline_response2003.rb +247 -0
- data/lib/pulp_container_client/models/inline_response2004.rb +247 -0
- data/lib/pulp_container_client/models/inline_response2005.rb +247 -0
- data/lib/pulp_container_client/models/inline_response2006.rb +247 -0
- data/lib/pulp_container_client/models/manifest_copy.rb +263 -0
- data/lib/pulp_container_client/models/recursive_manage.rb +209 -0
- data/lib/pulp_container_client/models/repository_sync_url.rb +224 -0
- data/lib/pulp_container_client/models/repository_version.rb +244 -0
- data/lib/pulp_container_client/models/tag_copy.rb +229 -0
- data/lib/pulp_container_client/models/tag_image.rb +265 -0
- data/lib/pulp_container_client/models/un_tag_image.rb +231 -0
- data/lib/pulp_container_client/version.rb +15 -0
- data/lib/pulp_container_client.rb +68 -0
- data/pulp_container_client.gemspec +39 -0
- data/spec/api/content_blobs_api_spec.rb +70 -0
- data/spec/api/content_manifests_api_spec.rb +70 -0
- data/spec/api/content_tags_api_spec.rb +71 -0
- data/spec/api/distributions_container_api_spec.rb +120 -0
- data/spec/api/remotes_container_api_spec.rb +122 -0
- data/spec/api/repositories_container_api_spec.rb +200 -0
- data/spec/api/repositories_container_versions_api_spec.rb +91 -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/container_blob_spec.rb +65 -0
- data/spec/models/container_container_distribution_spec.rb +83 -0
- data/spec/models/container_container_remote_spec.rb +123 -0
- data/spec/models/container_container_repository_spec.rb +71 -0
- data/spec/models/container_manifest_spec.rb +89 -0
- data/spec/models/container_tag_spec.rb +65 -0
- data/spec/models/content_summary_spec.rb +53 -0
- data/spec/models/inline_response2001_spec.rb +59 -0
- data/spec/models/inline_response2002_spec.rb +59 -0
- data/spec/models/inline_response2003_spec.rb +59 -0
- data/spec/models/inline_response2004_spec.rb +59 -0
- data/spec/models/inline_response2005_spec.rb +59 -0
- data/spec/models/inline_response2006_spec.rb +59 -0
- data/spec/models/inline_response200_spec.rb +59 -0
- data/spec/models/manifest_copy_spec.rb +63 -0
- data/spec/models/recursive_manage_spec.rb +41 -0
- data/spec/models/repository_sync_url_spec.rb +47 -0
- data/spec/models/repository_version_spec.rb +65 -0
- data/spec/models/tag_copy_spec.rb +53 -0
- data/spec/models/tag_image_spec.rb +47 -0
- data/spec/models/un_tag_image_spec.rb +41 -0
- data/spec/spec_helper.rb +111 -0
- metadata +230 -0
@@ -0,0 +1,739 @@
|
|
1
|
+
# PulpContainerClient::RepositoriesContainerApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**add**](RepositoriesContainerApi.md#add) | **POST** {container_repository_href}add/ |
|
8
|
+
[**copy_manifests**](RepositoriesContainerApi.md#copy_manifests) | **POST** {container_repository_href}copy_manifests/ |
|
9
|
+
[**copy_tags**](RepositoriesContainerApi.md#copy_tags) | **POST** {container_repository_href}copy_tags/ |
|
10
|
+
[**create**](RepositoriesContainerApi.md#create) | **POST** /pulp/api/v3/repositories/container/container/ | Create a container repository
|
11
|
+
[**delete**](RepositoriesContainerApi.md#delete) | **DELETE** {container_repository_href} | Delete a container repository
|
12
|
+
[**list**](RepositoriesContainerApi.md#list) | **GET** /pulp/api/v3/repositories/container/container/ | List container repositorys
|
13
|
+
[**partial_update**](RepositoriesContainerApi.md#partial_update) | **PATCH** {container_repository_href} | Partially update a container repository
|
14
|
+
[**read**](RepositoriesContainerApi.md#read) | **GET** {container_repository_href} | Inspect a container repository
|
15
|
+
[**remove**](RepositoriesContainerApi.md#remove) | **POST** {container_repository_href}remove/ |
|
16
|
+
[**sync**](RepositoriesContainerApi.md#sync) | **POST** {container_repository_href}sync/ |
|
17
|
+
[**tag**](RepositoriesContainerApi.md#tag) | **POST** {container_repository_href}tag/ |
|
18
|
+
[**untag**](RepositoriesContainerApi.md#untag) | **POST** {container_repository_href}untag/ |
|
19
|
+
[**update**](RepositoriesContainerApi.md#update) | **PUT** {container_repository_href} | Update a container repository
|
20
|
+
|
21
|
+
|
22
|
+
|
23
|
+
## add
|
24
|
+
|
25
|
+
> AsyncOperationResponse add(container_repository_href, data)
|
26
|
+
|
27
|
+
|
28
|
+
|
29
|
+
Trigger an asynchronous task to recursively add container content.
|
30
|
+
|
31
|
+
### Example
|
32
|
+
|
33
|
+
```ruby
|
34
|
+
# load the gem
|
35
|
+
require 'pulp_container_client'
|
36
|
+
# setup authorization
|
37
|
+
PulpContainerClient.configure do |config|
|
38
|
+
# Configure HTTP basic authorization: Basic
|
39
|
+
config.username = 'YOUR USERNAME'
|
40
|
+
config.password = 'YOUR PASSWORD'
|
41
|
+
end
|
42
|
+
|
43
|
+
api_instance = PulpContainerClient::RepositoriesContainerApi.new
|
44
|
+
container_repository_href = 'container_repository_href_example' # String | URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/
|
45
|
+
data = PulpContainerClient::RecursiveManage.new # RecursiveManage |
|
46
|
+
|
47
|
+
begin
|
48
|
+
result = api_instance.add(container_repository_href, data)
|
49
|
+
p result
|
50
|
+
rescue PulpContainerClient::ApiError => e
|
51
|
+
puts "Exception when calling RepositoriesContainerApi->add: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
### Parameters
|
56
|
+
|
57
|
+
|
58
|
+
Name | Type | Description | Notes
|
59
|
+
------------- | ------------- | ------------- | -------------
|
60
|
+
**container_repository_href** | **String**| URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/ |
|
61
|
+
**data** | [**RecursiveManage**](RecursiveManage.md)| |
|
62
|
+
|
63
|
+
### Return type
|
64
|
+
|
65
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
66
|
+
|
67
|
+
### Authorization
|
68
|
+
|
69
|
+
[Basic](../README.md#Basic)
|
70
|
+
|
71
|
+
### HTTP request headers
|
72
|
+
|
73
|
+
- **Content-Type**: application/json
|
74
|
+
- **Accept**: application/json
|
75
|
+
|
76
|
+
|
77
|
+
## copy_manifests
|
78
|
+
|
79
|
+
> AsyncOperationResponse copy_manifests(container_repository_href, data)
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
Trigger an asynchronous task to copy manifests
|
84
|
+
|
85
|
+
### Example
|
86
|
+
|
87
|
+
```ruby
|
88
|
+
# load the gem
|
89
|
+
require 'pulp_container_client'
|
90
|
+
# setup authorization
|
91
|
+
PulpContainerClient.configure do |config|
|
92
|
+
# Configure HTTP basic authorization: Basic
|
93
|
+
config.username = 'YOUR USERNAME'
|
94
|
+
config.password = 'YOUR PASSWORD'
|
95
|
+
end
|
96
|
+
|
97
|
+
api_instance = PulpContainerClient::RepositoriesContainerApi.new
|
98
|
+
container_repository_href = 'container_repository_href_example' # String | URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/
|
99
|
+
data = PulpContainerClient::ManifestCopy.new # ManifestCopy |
|
100
|
+
|
101
|
+
begin
|
102
|
+
result = api_instance.copy_manifests(container_repository_href, data)
|
103
|
+
p result
|
104
|
+
rescue PulpContainerClient::ApiError => e
|
105
|
+
puts "Exception when calling RepositoriesContainerApi->copy_manifests: #{e}"
|
106
|
+
end
|
107
|
+
```
|
108
|
+
|
109
|
+
### Parameters
|
110
|
+
|
111
|
+
|
112
|
+
Name | Type | Description | Notes
|
113
|
+
------------- | ------------- | ------------- | -------------
|
114
|
+
**container_repository_href** | **String**| URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/ |
|
115
|
+
**data** | [**ManifestCopy**](ManifestCopy.md)| |
|
116
|
+
|
117
|
+
### Return type
|
118
|
+
|
119
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
120
|
+
|
121
|
+
### Authorization
|
122
|
+
|
123
|
+
[Basic](../README.md#Basic)
|
124
|
+
|
125
|
+
### HTTP request headers
|
126
|
+
|
127
|
+
- **Content-Type**: application/json
|
128
|
+
- **Accept**: application/json
|
129
|
+
|
130
|
+
|
131
|
+
## copy_tags
|
132
|
+
|
133
|
+
> AsyncOperationResponse copy_tags(container_repository_href, data)
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
Trigger an asynchronous task to copy tags
|
138
|
+
|
139
|
+
### Example
|
140
|
+
|
141
|
+
```ruby
|
142
|
+
# load the gem
|
143
|
+
require 'pulp_container_client'
|
144
|
+
# setup authorization
|
145
|
+
PulpContainerClient.configure do |config|
|
146
|
+
# Configure HTTP basic authorization: Basic
|
147
|
+
config.username = 'YOUR USERNAME'
|
148
|
+
config.password = 'YOUR PASSWORD'
|
149
|
+
end
|
150
|
+
|
151
|
+
api_instance = PulpContainerClient::RepositoriesContainerApi.new
|
152
|
+
container_repository_href = 'container_repository_href_example' # String | URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/
|
153
|
+
data = PulpContainerClient::TagCopy.new # TagCopy |
|
154
|
+
|
155
|
+
begin
|
156
|
+
result = api_instance.copy_tags(container_repository_href, data)
|
157
|
+
p result
|
158
|
+
rescue PulpContainerClient::ApiError => e
|
159
|
+
puts "Exception when calling RepositoriesContainerApi->copy_tags: #{e}"
|
160
|
+
end
|
161
|
+
```
|
162
|
+
|
163
|
+
### Parameters
|
164
|
+
|
165
|
+
|
166
|
+
Name | Type | Description | Notes
|
167
|
+
------------- | ------------- | ------------- | -------------
|
168
|
+
**container_repository_href** | **String**| URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/ |
|
169
|
+
**data** | [**TagCopy**](TagCopy.md)| |
|
170
|
+
|
171
|
+
### Return type
|
172
|
+
|
173
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
174
|
+
|
175
|
+
### Authorization
|
176
|
+
|
177
|
+
[Basic](../README.md#Basic)
|
178
|
+
|
179
|
+
### HTTP request headers
|
180
|
+
|
181
|
+
- **Content-Type**: application/json
|
182
|
+
- **Accept**: application/json
|
183
|
+
|
184
|
+
|
185
|
+
## create
|
186
|
+
|
187
|
+
> ContainerContainerRepository create(data)
|
188
|
+
|
189
|
+
Create a container repository
|
190
|
+
|
191
|
+
ViewSet for container repo.
|
192
|
+
|
193
|
+
### Example
|
194
|
+
|
195
|
+
```ruby
|
196
|
+
# load the gem
|
197
|
+
require 'pulp_container_client'
|
198
|
+
# setup authorization
|
199
|
+
PulpContainerClient.configure do |config|
|
200
|
+
# Configure HTTP basic authorization: Basic
|
201
|
+
config.username = 'YOUR USERNAME'
|
202
|
+
config.password = 'YOUR PASSWORD'
|
203
|
+
end
|
204
|
+
|
205
|
+
api_instance = PulpContainerClient::RepositoriesContainerApi.new
|
206
|
+
data = PulpContainerClient::ContainerContainerRepository.new # ContainerContainerRepository |
|
207
|
+
|
208
|
+
begin
|
209
|
+
#Create a container repository
|
210
|
+
result = api_instance.create(data)
|
211
|
+
p result
|
212
|
+
rescue PulpContainerClient::ApiError => e
|
213
|
+
puts "Exception when calling RepositoriesContainerApi->create: #{e}"
|
214
|
+
end
|
215
|
+
```
|
216
|
+
|
217
|
+
### Parameters
|
218
|
+
|
219
|
+
|
220
|
+
Name | Type | Description | Notes
|
221
|
+
------------- | ------------- | ------------- | -------------
|
222
|
+
**data** | [**ContainerContainerRepository**](ContainerContainerRepository.md)| |
|
223
|
+
|
224
|
+
### Return type
|
225
|
+
|
226
|
+
[**ContainerContainerRepository**](ContainerContainerRepository.md)
|
227
|
+
|
228
|
+
### Authorization
|
229
|
+
|
230
|
+
[Basic](../README.md#Basic)
|
231
|
+
|
232
|
+
### HTTP request headers
|
233
|
+
|
234
|
+
- **Content-Type**: application/json
|
235
|
+
- **Accept**: application/json
|
236
|
+
|
237
|
+
|
238
|
+
## delete
|
239
|
+
|
240
|
+
> AsyncOperationResponse delete(container_repository_href)
|
241
|
+
|
242
|
+
Delete a container repository
|
243
|
+
|
244
|
+
Trigger an asynchronous task to delete a repository.
|
245
|
+
|
246
|
+
### Example
|
247
|
+
|
248
|
+
```ruby
|
249
|
+
# load the gem
|
250
|
+
require 'pulp_container_client'
|
251
|
+
# setup authorization
|
252
|
+
PulpContainerClient.configure do |config|
|
253
|
+
# Configure HTTP basic authorization: Basic
|
254
|
+
config.username = 'YOUR USERNAME'
|
255
|
+
config.password = 'YOUR PASSWORD'
|
256
|
+
end
|
257
|
+
|
258
|
+
api_instance = PulpContainerClient::RepositoriesContainerApi.new
|
259
|
+
container_repository_href = 'container_repository_href_example' # String | URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/
|
260
|
+
|
261
|
+
begin
|
262
|
+
#Delete a container repository
|
263
|
+
result = api_instance.delete(container_repository_href)
|
264
|
+
p result
|
265
|
+
rescue PulpContainerClient::ApiError => e
|
266
|
+
puts "Exception when calling RepositoriesContainerApi->delete: #{e}"
|
267
|
+
end
|
268
|
+
```
|
269
|
+
|
270
|
+
### Parameters
|
271
|
+
|
272
|
+
|
273
|
+
Name | Type | Description | Notes
|
274
|
+
------------- | ------------- | ------------- | -------------
|
275
|
+
**container_repository_href** | **String**| URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/ |
|
276
|
+
|
277
|
+
### Return type
|
278
|
+
|
279
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
280
|
+
|
281
|
+
### Authorization
|
282
|
+
|
283
|
+
[Basic](../README.md#Basic)
|
284
|
+
|
285
|
+
### HTTP request headers
|
286
|
+
|
287
|
+
- **Content-Type**: Not defined
|
288
|
+
- **Accept**: application/json
|
289
|
+
|
290
|
+
|
291
|
+
## list
|
292
|
+
|
293
|
+
> InlineResponse2005 list(opts)
|
294
|
+
|
295
|
+
List container repositorys
|
296
|
+
|
297
|
+
ViewSet for container repo.
|
298
|
+
|
299
|
+
### Example
|
300
|
+
|
301
|
+
```ruby
|
302
|
+
# load the gem
|
303
|
+
require 'pulp_container_client'
|
304
|
+
# setup authorization
|
305
|
+
PulpContainerClient.configure do |config|
|
306
|
+
# Configure HTTP basic authorization: Basic
|
307
|
+
config.username = 'YOUR USERNAME'
|
308
|
+
config.password = 'YOUR PASSWORD'
|
309
|
+
end
|
310
|
+
|
311
|
+
api_instance = PulpContainerClient::RepositoriesContainerApi.new
|
312
|
+
opts = {
|
313
|
+
name: 'name_example', # String |
|
314
|
+
name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
|
315
|
+
limit: 56, # Integer | Number of results to return per page.
|
316
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
317
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
318
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
319
|
+
}
|
320
|
+
|
321
|
+
begin
|
322
|
+
#List container repositorys
|
323
|
+
result = api_instance.list(opts)
|
324
|
+
p result
|
325
|
+
rescue PulpContainerClient::ApiError => e
|
326
|
+
puts "Exception when calling RepositoriesContainerApi->list: #{e}"
|
327
|
+
end
|
328
|
+
```
|
329
|
+
|
330
|
+
### Parameters
|
331
|
+
|
332
|
+
|
333
|
+
Name | Type | Description | Notes
|
334
|
+
------------- | ------------- | ------------- | -------------
|
335
|
+
**name** | **String**| | [optional]
|
336
|
+
**name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional]
|
337
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
338
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
339
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
340
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
341
|
+
|
342
|
+
### Return type
|
343
|
+
|
344
|
+
[**InlineResponse2005**](InlineResponse2005.md)
|
345
|
+
|
346
|
+
### Authorization
|
347
|
+
|
348
|
+
[Basic](../README.md#Basic)
|
349
|
+
|
350
|
+
### HTTP request headers
|
351
|
+
|
352
|
+
- **Content-Type**: Not defined
|
353
|
+
- **Accept**: application/json
|
354
|
+
|
355
|
+
|
356
|
+
## partial_update
|
357
|
+
|
358
|
+
> ContainerContainerRepository partial_update(container_repository_href, data)
|
359
|
+
|
360
|
+
Partially update a container repository
|
361
|
+
|
362
|
+
ViewSet for container repo.
|
363
|
+
|
364
|
+
### Example
|
365
|
+
|
366
|
+
```ruby
|
367
|
+
# load the gem
|
368
|
+
require 'pulp_container_client'
|
369
|
+
# setup authorization
|
370
|
+
PulpContainerClient.configure do |config|
|
371
|
+
# Configure HTTP basic authorization: Basic
|
372
|
+
config.username = 'YOUR USERNAME'
|
373
|
+
config.password = 'YOUR PASSWORD'
|
374
|
+
end
|
375
|
+
|
376
|
+
api_instance = PulpContainerClient::RepositoriesContainerApi.new
|
377
|
+
container_repository_href = 'container_repository_href_example' # String | URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/
|
378
|
+
data = PulpContainerClient::ContainerContainerRepository.new # ContainerContainerRepository |
|
379
|
+
|
380
|
+
begin
|
381
|
+
#Partially update a container repository
|
382
|
+
result = api_instance.partial_update(container_repository_href, data)
|
383
|
+
p result
|
384
|
+
rescue PulpContainerClient::ApiError => e
|
385
|
+
puts "Exception when calling RepositoriesContainerApi->partial_update: #{e}"
|
386
|
+
end
|
387
|
+
```
|
388
|
+
|
389
|
+
### Parameters
|
390
|
+
|
391
|
+
|
392
|
+
Name | Type | Description | Notes
|
393
|
+
------------- | ------------- | ------------- | -------------
|
394
|
+
**container_repository_href** | **String**| URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/ |
|
395
|
+
**data** | [**ContainerContainerRepository**](ContainerContainerRepository.md)| |
|
396
|
+
|
397
|
+
### Return type
|
398
|
+
|
399
|
+
[**ContainerContainerRepository**](ContainerContainerRepository.md)
|
400
|
+
|
401
|
+
### Authorization
|
402
|
+
|
403
|
+
[Basic](../README.md#Basic)
|
404
|
+
|
405
|
+
### HTTP request headers
|
406
|
+
|
407
|
+
- **Content-Type**: application/json
|
408
|
+
- **Accept**: application/json
|
409
|
+
|
410
|
+
|
411
|
+
## read
|
412
|
+
|
413
|
+
> ContainerContainerRepository read(container_repository_href, opts)
|
414
|
+
|
415
|
+
Inspect a container repository
|
416
|
+
|
417
|
+
ViewSet for container repo.
|
418
|
+
|
419
|
+
### Example
|
420
|
+
|
421
|
+
```ruby
|
422
|
+
# load the gem
|
423
|
+
require 'pulp_container_client'
|
424
|
+
# setup authorization
|
425
|
+
PulpContainerClient.configure do |config|
|
426
|
+
# Configure HTTP basic authorization: Basic
|
427
|
+
config.username = 'YOUR USERNAME'
|
428
|
+
config.password = 'YOUR PASSWORD'
|
429
|
+
end
|
430
|
+
|
431
|
+
api_instance = PulpContainerClient::RepositoriesContainerApi.new
|
432
|
+
container_repository_href = 'container_repository_href_example' # String | URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/
|
433
|
+
opts = {
|
434
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
435
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
436
|
+
}
|
437
|
+
|
438
|
+
begin
|
439
|
+
#Inspect a container repository
|
440
|
+
result = api_instance.read(container_repository_href, opts)
|
441
|
+
p result
|
442
|
+
rescue PulpContainerClient::ApiError => e
|
443
|
+
puts "Exception when calling RepositoriesContainerApi->read: #{e}"
|
444
|
+
end
|
445
|
+
```
|
446
|
+
|
447
|
+
### Parameters
|
448
|
+
|
449
|
+
|
450
|
+
Name | Type | Description | Notes
|
451
|
+
------------- | ------------- | ------------- | -------------
|
452
|
+
**container_repository_href** | **String**| URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/ |
|
453
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
454
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
455
|
+
|
456
|
+
### Return type
|
457
|
+
|
458
|
+
[**ContainerContainerRepository**](ContainerContainerRepository.md)
|
459
|
+
|
460
|
+
### Authorization
|
461
|
+
|
462
|
+
[Basic](../README.md#Basic)
|
463
|
+
|
464
|
+
### HTTP request headers
|
465
|
+
|
466
|
+
- **Content-Type**: Not defined
|
467
|
+
- **Accept**: application/json
|
468
|
+
|
469
|
+
|
470
|
+
## remove
|
471
|
+
|
472
|
+
> AsyncOperationResponse remove(container_repository_href, data)
|
473
|
+
|
474
|
+
|
475
|
+
|
476
|
+
Trigger an async task to recursively remove container content.
|
477
|
+
|
478
|
+
### Example
|
479
|
+
|
480
|
+
```ruby
|
481
|
+
# load the gem
|
482
|
+
require 'pulp_container_client'
|
483
|
+
# setup authorization
|
484
|
+
PulpContainerClient.configure do |config|
|
485
|
+
# Configure HTTP basic authorization: Basic
|
486
|
+
config.username = 'YOUR USERNAME'
|
487
|
+
config.password = 'YOUR PASSWORD'
|
488
|
+
end
|
489
|
+
|
490
|
+
api_instance = PulpContainerClient::RepositoriesContainerApi.new
|
491
|
+
container_repository_href = 'container_repository_href_example' # String | URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/
|
492
|
+
data = PulpContainerClient::RecursiveManage.new # RecursiveManage |
|
493
|
+
|
494
|
+
begin
|
495
|
+
result = api_instance.remove(container_repository_href, data)
|
496
|
+
p result
|
497
|
+
rescue PulpContainerClient::ApiError => e
|
498
|
+
puts "Exception when calling RepositoriesContainerApi->remove: #{e}"
|
499
|
+
end
|
500
|
+
```
|
501
|
+
|
502
|
+
### Parameters
|
503
|
+
|
504
|
+
|
505
|
+
Name | Type | Description | Notes
|
506
|
+
------------- | ------------- | ------------- | -------------
|
507
|
+
**container_repository_href** | **String**| URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/ |
|
508
|
+
**data** | [**RecursiveManage**](RecursiveManage.md)| |
|
509
|
+
|
510
|
+
### Return type
|
511
|
+
|
512
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
513
|
+
|
514
|
+
### Authorization
|
515
|
+
|
516
|
+
[Basic](../README.md#Basic)
|
517
|
+
|
518
|
+
### HTTP request headers
|
519
|
+
|
520
|
+
- **Content-Type**: application/json
|
521
|
+
- **Accept**: application/json
|
522
|
+
|
523
|
+
|
524
|
+
## sync
|
525
|
+
|
526
|
+
> AsyncOperationResponse sync(container_repository_href, data)
|
527
|
+
|
528
|
+
|
529
|
+
|
530
|
+
Trigger an asynchronous task to sync content.
|
531
|
+
|
532
|
+
### Example
|
533
|
+
|
534
|
+
```ruby
|
535
|
+
# load the gem
|
536
|
+
require 'pulp_container_client'
|
537
|
+
# setup authorization
|
538
|
+
PulpContainerClient.configure do |config|
|
539
|
+
# Configure HTTP basic authorization: Basic
|
540
|
+
config.username = 'YOUR USERNAME'
|
541
|
+
config.password = 'YOUR PASSWORD'
|
542
|
+
end
|
543
|
+
|
544
|
+
api_instance = PulpContainerClient::RepositoriesContainerApi.new
|
545
|
+
container_repository_href = 'container_repository_href_example' # String | URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/
|
546
|
+
data = PulpContainerClient::RepositorySyncURL.new # RepositorySyncURL |
|
547
|
+
|
548
|
+
begin
|
549
|
+
result = api_instance.sync(container_repository_href, data)
|
550
|
+
p result
|
551
|
+
rescue PulpContainerClient::ApiError => e
|
552
|
+
puts "Exception when calling RepositoriesContainerApi->sync: #{e}"
|
553
|
+
end
|
554
|
+
```
|
555
|
+
|
556
|
+
### Parameters
|
557
|
+
|
558
|
+
|
559
|
+
Name | Type | Description | Notes
|
560
|
+
------------- | ------------- | ------------- | -------------
|
561
|
+
**container_repository_href** | **String**| URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/ |
|
562
|
+
**data** | [**RepositorySyncURL**](RepositorySyncURL.md)| |
|
563
|
+
|
564
|
+
### Return type
|
565
|
+
|
566
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
567
|
+
|
568
|
+
### Authorization
|
569
|
+
|
570
|
+
[Basic](../README.md#Basic)
|
571
|
+
|
572
|
+
### HTTP request headers
|
573
|
+
|
574
|
+
- **Content-Type**: application/json
|
575
|
+
- **Accept**: application/json
|
576
|
+
|
577
|
+
|
578
|
+
## tag
|
579
|
+
|
580
|
+
> AsyncOperationResponse tag(container_repository_href, data)
|
581
|
+
|
582
|
+
|
583
|
+
|
584
|
+
Trigger an asynchronous task to tag an image in the repository
|
585
|
+
|
586
|
+
### Example
|
587
|
+
|
588
|
+
```ruby
|
589
|
+
# load the gem
|
590
|
+
require 'pulp_container_client'
|
591
|
+
# setup authorization
|
592
|
+
PulpContainerClient.configure do |config|
|
593
|
+
# Configure HTTP basic authorization: Basic
|
594
|
+
config.username = 'YOUR USERNAME'
|
595
|
+
config.password = 'YOUR PASSWORD'
|
596
|
+
end
|
597
|
+
|
598
|
+
api_instance = PulpContainerClient::RepositoriesContainerApi.new
|
599
|
+
container_repository_href = 'container_repository_href_example' # String | URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/
|
600
|
+
data = PulpContainerClient::TagImage.new # TagImage |
|
601
|
+
|
602
|
+
begin
|
603
|
+
result = api_instance.tag(container_repository_href, data)
|
604
|
+
p result
|
605
|
+
rescue PulpContainerClient::ApiError => e
|
606
|
+
puts "Exception when calling RepositoriesContainerApi->tag: #{e}"
|
607
|
+
end
|
608
|
+
```
|
609
|
+
|
610
|
+
### Parameters
|
611
|
+
|
612
|
+
|
613
|
+
Name | Type | Description | Notes
|
614
|
+
------------- | ------------- | ------------- | -------------
|
615
|
+
**container_repository_href** | **String**| URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/ |
|
616
|
+
**data** | [**TagImage**](TagImage.md)| |
|
617
|
+
|
618
|
+
### Return type
|
619
|
+
|
620
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
621
|
+
|
622
|
+
### Authorization
|
623
|
+
|
624
|
+
[Basic](../README.md#Basic)
|
625
|
+
|
626
|
+
### HTTP request headers
|
627
|
+
|
628
|
+
- **Content-Type**: application/json
|
629
|
+
- **Accept**: application/json
|
630
|
+
|
631
|
+
|
632
|
+
## untag
|
633
|
+
|
634
|
+
> AsyncOperationResponse untag(container_repository_href, data)
|
635
|
+
|
636
|
+
|
637
|
+
|
638
|
+
Trigger an asynchronous task to untag an image in the repository
|
639
|
+
|
640
|
+
### Example
|
641
|
+
|
642
|
+
```ruby
|
643
|
+
# load the gem
|
644
|
+
require 'pulp_container_client'
|
645
|
+
# setup authorization
|
646
|
+
PulpContainerClient.configure do |config|
|
647
|
+
# Configure HTTP basic authorization: Basic
|
648
|
+
config.username = 'YOUR USERNAME'
|
649
|
+
config.password = 'YOUR PASSWORD'
|
650
|
+
end
|
651
|
+
|
652
|
+
api_instance = PulpContainerClient::RepositoriesContainerApi.new
|
653
|
+
container_repository_href = 'container_repository_href_example' # String | URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/
|
654
|
+
data = PulpContainerClient::UnTagImage.new # UnTagImage |
|
655
|
+
|
656
|
+
begin
|
657
|
+
result = api_instance.untag(container_repository_href, data)
|
658
|
+
p result
|
659
|
+
rescue PulpContainerClient::ApiError => e
|
660
|
+
puts "Exception when calling RepositoriesContainerApi->untag: #{e}"
|
661
|
+
end
|
662
|
+
```
|
663
|
+
|
664
|
+
### Parameters
|
665
|
+
|
666
|
+
|
667
|
+
Name | Type | Description | Notes
|
668
|
+
------------- | ------------- | ------------- | -------------
|
669
|
+
**container_repository_href** | **String**| URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/ |
|
670
|
+
**data** | [**UnTagImage**](UnTagImage.md)| |
|
671
|
+
|
672
|
+
### Return type
|
673
|
+
|
674
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
675
|
+
|
676
|
+
### Authorization
|
677
|
+
|
678
|
+
[Basic](../README.md#Basic)
|
679
|
+
|
680
|
+
### HTTP request headers
|
681
|
+
|
682
|
+
- **Content-Type**: application/json
|
683
|
+
- **Accept**: application/json
|
684
|
+
|
685
|
+
|
686
|
+
## update
|
687
|
+
|
688
|
+
> AsyncOperationResponse update(container_repository_href, data)
|
689
|
+
|
690
|
+
Update a container repository
|
691
|
+
|
692
|
+
Trigger an asynchronous task to update a repository.
|
693
|
+
|
694
|
+
### Example
|
695
|
+
|
696
|
+
```ruby
|
697
|
+
# load the gem
|
698
|
+
require 'pulp_container_client'
|
699
|
+
# setup authorization
|
700
|
+
PulpContainerClient.configure do |config|
|
701
|
+
# Configure HTTP basic authorization: Basic
|
702
|
+
config.username = 'YOUR USERNAME'
|
703
|
+
config.password = 'YOUR PASSWORD'
|
704
|
+
end
|
705
|
+
|
706
|
+
api_instance = PulpContainerClient::RepositoriesContainerApi.new
|
707
|
+
container_repository_href = 'container_repository_href_example' # String | URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/
|
708
|
+
data = PulpContainerClient::ContainerContainerRepository.new # ContainerContainerRepository |
|
709
|
+
|
710
|
+
begin
|
711
|
+
#Update a container repository
|
712
|
+
result = api_instance.update(container_repository_href, data)
|
713
|
+
p result
|
714
|
+
rescue PulpContainerClient::ApiError => e
|
715
|
+
puts "Exception when calling RepositoriesContainerApi->update: #{e}"
|
716
|
+
end
|
717
|
+
```
|
718
|
+
|
719
|
+
### Parameters
|
720
|
+
|
721
|
+
|
722
|
+
Name | Type | Description | Notes
|
723
|
+
------------- | ------------- | ------------- | -------------
|
724
|
+
**container_repository_href** | **String**| URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/ |
|
725
|
+
**data** | [**ContainerContainerRepository**](ContainerContainerRepository.md)| |
|
726
|
+
|
727
|
+
### Return type
|
728
|
+
|
729
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
730
|
+
|
731
|
+
### Authorization
|
732
|
+
|
733
|
+
[Basic](../README.md#Basic)
|
734
|
+
|
735
|
+
### HTTP request headers
|
736
|
+
|
737
|
+
- **Content-Type**: application/json
|
738
|
+
- **Accept**: application/json
|
739
|
+
|