pulp_file_client 0.1.0b4 → 0.1.0rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +35 -9
- data/docs/ContentFilesApi.md +2 -2
- data/docs/ContentSummary.md +21 -0
- data/docs/DistributionsFileApi.md +8 -8
- data/docs/FileExportersFileApi.md +408 -0
- data/docs/{FileContent.md → FileFileContent.md} +2 -6
- data/docs/{FileDistribution.md → FileFileDistribution.md} +2 -2
- data/docs/FileFileFileSystemExporter.md +23 -0
- data/docs/{FilePublication.md → FileFilePublication.md} +2 -2
- data/docs/{FileRemote.md → FileFileRemote.md} +10 -14
- data/docs/FileFileRepository.md +27 -0
- data/docs/InlineResponse200.md +1 -1
- data/docs/InlineResponse2001.md +1 -1
- data/docs/InlineResponse2002.md +1 -1
- data/docs/InlineResponse2003.md +1 -1
- data/docs/InlineResponse2004.md +23 -0
- data/docs/InlineResponse2005.md +23 -0
- data/docs/InlineResponse2006.md +23 -0
- data/docs/PublicationExport.md +17 -0
- data/docs/PublicationsFileApi.md +9 -9
- data/docs/RemotesFileApi.md +12 -67
- data/docs/RepositoriesFileApi.md +464 -0
- data/docs/RepositoriesFileVersionsApi.md +214 -0
- data/docs/RepositoryAddRemoveContent.md +21 -0
- data/docs/RepositorySyncURL.md +2 -2
- data/docs/RepositoryVersion.md +25 -0
- data/lib/pulp_file_client/api/content_files_api.rb +4 -4
- data/lib/pulp_file_client/api/distributions_file_api.rb +10 -10
- data/lib/pulp_file_client/api/file_exporters_file_api.rb +496 -0
- data/lib/pulp_file_client/api/publications_file_api.rb +15 -15
- data/lib/pulp_file_client/api/remotes_file_api.rb +16 -84
- data/lib/pulp_file_client/api/repositories_file_api.rb +566 -0
- data/lib/pulp_file_client/api/repositories_file_versions_api.rb +268 -0
- data/lib/pulp_file_client/api_client.rb +1 -1
- data/lib/pulp_file_client/api_error.rb +1 -1
- data/lib/pulp_file_client/configuration.rb +1 -1
- data/lib/pulp_file_client/models/async_operation_response.rb +12 -2
- data/lib/pulp_file_client/models/content_summary.rb +246 -0
- data/lib/pulp_file_client/models/{file_content.rb → file_file_content.rb} +16 -26
- data/lib/pulp_file_client/models/{file_distribution.rb → file_file_distribution.rb} +17 -23
- data/lib/pulp_file_client/models/file_file_file_system_exporter.rb +284 -0
- data/lib/pulp_file_client/models/{file_publication.rb → file_file_publication.rb} +16 -5
- data/lib/pulp_file_client/models/{file_remote.rb → file_file_remote.rb} +69 -105
- data/lib/pulp_file_client/models/file_file_repository.rb +294 -0
- data/lib/pulp_file_client/models/inline_response200.rb +15 -3
- data/lib/pulp_file_client/models/inline_response2001.rb +15 -3
- data/lib/pulp_file_client/models/inline_response2002.rb +15 -3
- data/lib/pulp_file_client/models/inline_response2003.rb +15 -3
- data/lib/pulp_file_client/models/inline_response2004.rb +247 -0
- data/lib/pulp_file_client/models/inline_response2005.rb +247 -0
- data/lib/pulp_file_client/models/inline_response2006.rb +247 -0
- data/lib/pulp_file_client/models/publication_export.rb +212 -0
- data/lib/pulp_file_client/models/repository_add_remove_content.rb +231 -0
- data/lib/pulp_file_client/models/repository_sync_url.rb +22 -12
- data/lib/pulp_file_client/models/repository_version.rb +244 -0
- data/lib/pulp_file_client/version.rb +2 -2
- data/lib/pulp_file_client.rb +17 -5
- data/pulp_file_client.gemspec +1 -1
- data/spec/api/content_files_api_spec.rb +2 -2
- data/spec/api/distributions_file_api_spec.rb +2 -2
- data/spec/api/file_exporters_file_api_spec.rb +128 -0
- data/spec/api/publications_file_api_spec.rb +6 -6
- data/spec/api/remotes_file_api_spec.rb +4 -16
- data/spec/api/repositories_file_api_spec.rb +140 -0
- data/spec/api/repositories_file_versions_api_spec.rb +91 -0
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/async_operation_response_spec.rb +1 -1
- data/spec/models/content_summary_spec.rb +53 -0
- data/spec/models/{file_content_spec.rb → file_file_content_spec.rb} +7 -19
- data/spec/models/{file_distribution_spec.rb → file_file_distribution_spec.rb} +7 -7
- data/spec/models/file_file_file_system_exporter_spec.rb +59 -0
- data/spec/models/{file_publication_spec.rb → file_file_publication_spec.rb} +7 -7
- data/spec/models/{file_remote_spec.rb → file_file_remote_spec.rb} +11 -23
- data/spec/models/file_file_repository_spec.rb +71 -0
- data/spec/models/inline_response2001_spec.rb +1 -1
- data/spec/models/inline_response2002_spec.rb +1 -1
- data/spec/models/inline_response2003_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/publication_export_spec.rb +41 -0
- data/spec/models/repository_add_remove_content_spec.rb +53 -0
- data/spec/models/repository_sync_url_spec.rb +2 -2
- data/spec/models/repository_version_spec.rb +65 -0
- data/spec/spec_helper.rb +1 -1
- metadata +66 -18
@@ -0,0 +1,464 @@
|
|
1
|
+
# PulpFileClient::RepositoriesFileApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create**](RepositoriesFileApi.md#create) | **POST** /pulp/api/v3/repositories/file/file/ | Create a file repository
|
8
|
+
[**delete**](RepositoriesFileApi.md#delete) | **DELETE** {file_repository_href} | Delete a file repository
|
9
|
+
[**list**](RepositoriesFileApi.md#list) | **GET** /pulp/api/v3/repositories/file/file/ | List file repositorys
|
10
|
+
[**modify**](RepositoriesFileApi.md#modify) | **POST** {file_repository_href}modify/ |
|
11
|
+
[**partial_update**](RepositoriesFileApi.md#partial_update) | **PATCH** {file_repository_href} | Partially update a file repository
|
12
|
+
[**read**](RepositoriesFileApi.md#read) | **GET** {file_repository_href} | Inspect a file repository
|
13
|
+
[**sync**](RepositoriesFileApi.md#sync) | **POST** {file_repository_href}sync/ |
|
14
|
+
[**update**](RepositoriesFileApi.md#update) | **PUT** {file_repository_href} | Update a file repository
|
15
|
+
|
16
|
+
|
17
|
+
|
18
|
+
## create
|
19
|
+
|
20
|
+
> FileFileRepository create(data)
|
21
|
+
|
22
|
+
Create a file repository
|
23
|
+
|
24
|
+
FileRepository represents a single file repository, to which content can be synced, added, or removed.
|
25
|
+
|
26
|
+
### Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
# load the gem
|
30
|
+
require 'pulp_file_client'
|
31
|
+
# setup authorization
|
32
|
+
PulpFileClient.configure do |config|
|
33
|
+
# Configure HTTP basic authorization: Basic
|
34
|
+
config.username = 'YOUR USERNAME'
|
35
|
+
config.password = 'YOUR PASSWORD'
|
36
|
+
end
|
37
|
+
|
38
|
+
api_instance = PulpFileClient::RepositoriesFileApi.new
|
39
|
+
data = PulpFileClient::FileFileRepository.new # FileFileRepository |
|
40
|
+
|
41
|
+
begin
|
42
|
+
#Create a file repository
|
43
|
+
result = api_instance.create(data)
|
44
|
+
p result
|
45
|
+
rescue PulpFileClient::ApiError => e
|
46
|
+
puts "Exception when calling RepositoriesFileApi->create: #{e}"
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
### Parameters
|
51
|
+
|
52
|
+
|
53
|
+
Name | Type | Description | Notes
|
54
|
+
------------- | ------------- | ------------- | -------------
|
55
|
+
**data** | [**FileFileRepository**](FileFileRepository.md)| |
|
56
|
+
|
57
|
+
### Return type
|
58
|
+
|
59
|
+
[**FileFileRepository**](FileFileRepository.md)
|
60
|
+
|
61
|
+
### Authorization
|
62
|
+
|
63
|
+
[Basic](../README.md#Basic)
|
64
|
+
|
65
|
+
### HTTP request headers
|
66
|
+
|
67
|
+
- **Content-Type**: application/json
|
68
|
+
- **Accept**: application/json
|
69
|
+
|
70
|
+
|
71
|
+
## delete
|
72
|
+
|
73
|
+
> AsyncOperationResponse delete(file_repository_href)
|
74
|
+
|
75
|
+
Delete a file repository
|
76
|
+
|
77
|
+
Trigger an asynchronous task to delete a repository.
|
78
|
+
|
79
|
+
### Example
|
80
|
+
|
81
|
+
```ruby
|
82
|
+
# load the gem
|
83
|
+
require 'pulp_file_client'
|
84
|
+
# setup authorization
|
85
|
+
PulpFileClient.configure do |config|
|
86
|
+
# Configure HTTP basic authorization: Basic
|
87
|
+
config.username = 'YOUR USERNAME'
|
88
|
+
config.password = 'YOUR PASSWORD'
|
89
|
+
end
|
90
|
+
|
91
|
+
api_instance = PulpFileClient::RepositoriesFileApi.new
|
92
|
+
file_repository_href = 'file_repository_href_example' # String | URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
|
93
|
+
|
94
|
+
begin
|
95
|
+
#Delete a file repository
|
96
|
+
result = api_instance.delete(file_repository_href)
|
97
|
+
p result
|
98
|
+
rescue PulpFileClient::ApiError => e
|
99
|
+
puts "Exception when calling RepositoriesFileApi->delete: #{e}"
|
100
|
+
end
|
101
|
+
```
|
102
|
+
|
103
|
+
### Parameters
|
104
|
+
|
105
|
+
|
106
|
+
Name | Type | Description | Notes
|
107
|
+
------------- | ------------- | ------------- | -------------
|
108
|
+
**file_repository_href** | **String**| URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/ |
|
109
|
+
|
110
|
+
### Return type
|
111
|
+
|
112
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
113
|
+
|
114
|
+
### Authorization
|
115
|
+
|
116
|
+
[Basic](../README.md#Basic)
|
117
|
+
|
118
|
+
### HTTP request headers
|
119
|
+
|
120
|
+
- **Content-Type**: Not defined
|
121
|
+
- **Accept**: application/json
|
122
|
+
|
123
|
+
|
124
|
+
## list
|
125
|
+
|
126
|
+
> InlineResponse2005 list(opts)
|
127
|
+
|
128
|
+
List file repositorys
|
129
|
+
|
130
|
+
FileRepository represents a single file repository, to which content can be synced, added, or removed.
|
131
|
+
|
132
|
+
### Example
|
133
|
+
|
134
|
+
```ruby
|
135
|
+
# load the gem
|
136
|
+
require 'pulp_file_client'
|
137
|
+
# setup authorization
|
138
|
+
PulpFileClient.configure do |config|
|
139
|
+
# Configure HTTP basic authorization: Basic
|
140
|
+
config.username = 'YOUR USERNAME'
|
141
|
+
config.password = 'YOUR PASSWORD'
|
142
|
+
end
|
143
|
+
|
144
|
+
api_instance = PulpFileClient::RepositoriesFileApi.new
|
145
|
+
opts = {
|
146
|
+
name: 'name_example', # String |
|
147
|
+
name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
|
148
|
+
limit: 56, # Integer | Number of results to return per page.
|
149
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
150
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
151
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
152
|
+
}
|
153
|
+
|
154
|
+
begin
|
155
|
+
#List file repositorys
|
156
|
+
result = api_instance.list(opts)
|
157
|
+
p result
|
158
|
+
rescue PulpFileClient::ApiError => e
|
159
|
+
puts "Exception when calling RepositoriesFileApi->list: #{e}"
|
160
|
+
end
|
161
|
+
```
|
162
|
+
|
163
|
+
### Parameters
|
164
|
+
|
165
|
+
|
166
|
+
Name | Type | Description | Notes
|
167
|
+
------------- | ------------- | ------------- | -------------
|
168
|
+
**name** | **String**| | [optional]
|
169
|
+
**name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional]
|
170
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
171
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
172
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
173
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
174
|
+
|
175
|
+
### Return type
|
176
|
+
|
177
|
+
[**InlineResponse2005**](InlineResponse2005.md)
|
178
|
+
|
179
|
+
### Authorization
|
180
|
+
|
181
|
+
[Basic](../README.md#Basic)
|
182
|
+
|
183
|
+
### HTTP request headers
|
184
|
+
|
185
|
+
- **Content-Type**: Not defined
|
186
|
+
- **Accept**: application/json
|
187
|
+
|
188
|
+
|
189
|
+
## modify
|
190
|
+
|
191
|
+
> AsyncOperationResponse modify(file_repository_href, data)
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
Trigger an asynchronous task to create a new repository version.
|
196
|
+
|
197
|
+
### Example
|
198
|
+
|
199
|
+
```ruby
|
200
|
+
# load the gem
|
201
|
+
require 'pulp_file_client'
|
202
|
+
# setup authorization
|
203
|
+
PulpFileClient.configure do |config|
|
204
|
+
# Configure HTTP basic authorization: Basic
|
205
|
+
config.username = 'YOUR USERNAME'
|
206
|
+
config.password = 'YOUR PASSWORD'
|
207
|
+
end
|
208
|
+
|
209
|
+
api_instance = PulpFileClient::RepositoriesFileApi.new
|
210
|
+
file_repository_href = 'file_repository_href_example' # String | URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
|
211
|
+
data = PulpFileClient::RepositoryAddRemoveContent.new # RepositoryAddRemoveContent |
|
212
|
+
|
213
|
+
begin
|
214
|
+
result = api_instance.modify(file_repository_href, data)
|
215
|
+
p result
|
216
|
+
rescue PulpFileClient::ApiError => e
|
217
|
+
puts "Exception when calling RepositoriesFileApi->modify: #{e}"
|
218
|
+
end
|
219
|
+
```
|
220
|
+
|
221
|
+
### Parameters
|
222
|
+
|
223
|
+
|
224
|
+
Name | Type | Description | Notes
|
225
|
+
------------- | ------------- | ------------- | -------------
|
226
|
+
**file_repository_href** | **String**| URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/ |
|
227
|
+
**data** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md)| |
|
228
|
+
|
229
|
+
### Return type
|
230
|
+
|
231
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
232
|
+
|
233
|
+
### Authorization
|
234
|
+
|
235
|
+
[Basic](../README.md#Basic)
|
236
|
+
|
237
|
+
### HTTP request headers
|
238
|
+
|
239
|
+
- **Content-Type**: application/json
|
240
|
+
- **Accept**: application/json
|
241
|
+
|
242
|
+
|
243
|
+
## partial_update
|
244
|
+
|
245
|
+
> FileFileRepository partial_update(file_repository_href, data)
|
246
|
+
|
247
|
+
Partially update a file repository
|
248
|
+
|
249
|
+
FileRepository represents a single file repository, to which content can be synced, added, or removed.
|
250
|
+
|
251
|
+
### Example
|
252
|
+
|
253
|
+
```ruby
|
254
|
+
# load the gem
|
255
|
+
require 'pulp_file_client'
|
256
|
+
# setup authorization
|
257
|
+
PulpFileClient.configure do |config|
|
258
|
+
# Configure HTTP basic authorization: Basic
|
259
|
+
config.username = 'YOUR USERNAME'
|
260
|
+
config.password = 'YOUR PASSWORD'
|
261
|
+
end
|
262
|
+
|
263
|
+
api_instance = PulpFileClient::RepositoriesFileApi.new
|
264
|
+
file_repository_href = 'file_repository_href_example' # String | URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
|
265
|
+
data = PulpFileClient::FileFileRepository.new # FileFileRepository |
|
266
|
+
|
267
|
+
begin
|
268
|
+
#Partially update a file repository
|
269
|
+
result = api_instance.partial_update(file_repository_href, data)
|
270
|
+
p result
|
271
|
+
rescue PulpFileClient::ApiError => e
|
272
|
+
puts "Exception when calling RepositoriesFileApi->partial_update: #{e}"
|
273
|
+
end
|
274
|
+
```
|
275
|
+
|
276
|
+
### Parameters
|
277
|
+
|
278
|
+
|
279
|
+
Name | Type | Description | Notes
|
280
|
+
------------- | ------------- | ------------- | -------------
|
281
|
+
**file_repository_href** | **String**| URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/ |
|
282
|
+
**data** | [**FileFileRepository**](FileFileRepository.md)| |
|
283
|
+
|
284
|
+
### Return type
|
285
|
+
|
286
|
+
[**FileFileRepository**](FileFileRepository.md)
|
287
|
+
|
288
|
+
### Authorization
|
289
|
+
|
290
|
+
[Basic](../README.md#Basic)
|
291
|
+
|
292
|
+
### HTTP request headers
|
293
|
+
|
294
|
+
- **Content-Type**: application/json
|
295
|
+
- **Accept**: application/json
|
296
|
+
|
297
|
+
|
298
|
+
## read
|
299
|
+
|
300
|
+
> FileFileRepository read(file_repository_href, opts)
|
301
|
+
|
302
|
+
Inspect a file repository
|
303
|
+
|
304
|
+
FileRepository represents a single file repository, to which content can be synced, added, or removed.
|
305
|
+
|
306
|
+
### Example
|
307
|
+
|
308
|
+
```ruby
|
309
|
+
# load the gem
|
310
|
+
require 'pulp_file_client'
|
311
|
+
# setup authorization
|
312
|
+
PulpFileClient.configure do |config|
|
313
|
+
# Configure HTTP basic authorization: Basic
|
314
|
+
config.username = 'YOUR USERNAME'
|
315
|
+
config.password = 'YOUR PASSWORD'
|
316
|
+
end
|
317
|
+
|
318
|
+
api_instance = PulpFileClient::RepositoriesFileApi.new
|
319
|
+
file_repository_href = 'file_repository_href_example' # String | URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
|
320
|
+
opts = {
|
321
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
322
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
323
|
+
}
|
324
|
+
|
325
|
+
begin
|
326
|
+
#Inspect a file repository
|
327
|
+
result = api_instance.read(file_repository_href, opts)
|
328
|
+
p result
|
329
|
+
rescue PulpFileClient::ApiError => e
|
330
|
+
puts "Exception when calling RepositoriesFileApi->read: #{e}"
|
331
|
+
end
|
332
|
+
```
|
333
|
+
|
334
|
+
### Parameters
|
335
|
+
|
336
|
+
|
337
|
+
Name | Type | Description | Notes
|
338
|
+
------------- | ------------- | ------------- | -------------
|
339
|
+
**file_repository_href** | **String**| URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/ |
|
340
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
341
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
342
|
+
|
343
|
+
### Return type
|
344
|
+
|
345
|
+
[**FileFileRepository**](FileFileRepository.md)
|
346
|
+
|
347
|
+
### Authorization
|
348
|
+
|
349
|
+
[Basic](../README.md#Basic)
|
350
|
+
|
351
|
+
### HTTP request headers
|
352
|
+
|
353
|
+
- **Content-Type**: Not defined
|
354
|
+
- **Accept**: application/json
|
355
|
+
|
356
|
+
|
357
|
+
## sync
|
358
|
+
|
359
|
+
> AsyncOperationResponse sync(file_repository_href, data)
|
360
|
+
|
361
|
+
|
362
|
+
|
363
|
+
Trigger an asynchronous task to sync file content.
|
364
|
+
|
365
|
+
### Example
|
366
|
+
|
367
|
+
```ruby
|
368
|
+
# load the gem
|
369
|
+
require 'pulp_file_client'
|
370
|
+
# setup authorization
|
371
|
+
PulpFileClient.configure do |config|
|
372
|
+
# Configure HTTP basic authorization: Basic
|
373
|
+
config.username = 'YOUR USERNAME'
|
374
|
+
config.password = 'YOUR PASSWORD'
|
375
|
+
end
|
376
|
+
|
377
|
+
api_instance = PulpFileClient::RepositoriesFileApi.new
|
378
|
+
file_repository_href = 'file_repository_href_example' # String | URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
|
379
|
+
data = PulpFileClient::RepositorySyncURL.new # RepositorySyncURL |
|
380
|
+
|
381
|
+
begin
|
382
|
+
result = api_instance.sync(file_repository_href, data)
|
383
|
+
p result
|
384
|
+
rescue PulpFileClient::ApiError => e
|
385
|
+
puts "Exception when calling RepositoriesFileApi->sync: #{e}"
|
386
|
+
end
|
387
|
+
```
|
388
|
+
|
389
|
+
### Parameters
|
390
|
+
|
391
|
+
|
392
|
+
Name | Type | Description | Notes
|
393
|
+
------------- | ------------- | ------------- | -------------
|
394
|
+
**file_repository_href** | **String**| URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/ |
|
395
|
+
**data** | [**RepositorySyncURL**](RepositorySyncURL.md)| |
|
396
|
+
|
397
|
+
### Return type
|
398
|
+
|
399
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.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
|
+
## update
|
412
|
+
|
413
|
+
> AsyncOperationResponse update(file_repository_href, data)
|
414
|
+
|
415
|
+
Update a file repository
|
416
|
+
|
417
|
+
Trigger an asynchronous task to update a repository.
|
418
|
+
|
419
|
+
### Example
|
420
|
+
|
421
|
+
```ruby
|
422
|
+
# load the gem
|
423
|
+
require 'pulp_file_client'
|
424
|
+
# setup authorization
|
425
|
+
PulpFileClient.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 = PulpFileClient::RepositoriesFileApi.new
|
432
|
+
file_repository_href = 'file_repository_href_example' # String | URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
|
433
|
+
data = PulpFileClient::FileFileRepository.new # FileFileRepository |
|
434
|
+
|
435
|
+
begin
|
436
|
+
#Update a file repository
|
437
|
+
result = api_instance.update(file_repository_href, data)
|
438
|
+
p result
|
439
|
+
rescue PulpFileClient::ApiError => e
|
440
|
+
puts "Exception when calling RepositoriesFileApi->update: #{e}"
|
441
|
+
end
|
442
|
+
```
|
443
|
+
|
444
|
+
### Parameters
|
445
|
+
|
446
|
+
|
447
|
+
Name | Type | Description | Notes
|
448
|
+
------------- | ------------- | ------------- | -------------
|
449
|
+
**file_repository_href** | **String**| URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/ |
|
450
|
+
**data** | [**FileFileRepository**](FileFileRepository.md)| |
|
451
|
+
|
452
|
+
### Return type
|
453
|
+
|
454
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
455
|
+
|
456
|
+
### Authorization
|
457
|
+
|
458
|
+
[Basic](../README.md#Basic)
|
459
|
+
|
460
|
+
### HTTP request headers
|
461
|
+
|
462
|
+
- **Content-Type**: application/json
|
463
|
+
- **Accept**: application/json
|
464
|
+
|
@@ -0,0 +1,214 @@
|
|
1
|
+
# PulpFileClient::RepositoriesFileVersionsApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**delete**](RepositoriesFileVersionsApi.md#delete) | **DELETE** {file_repository_version_href} | Delete a repository version
|
8
|
+
[**list**](RepositoriesFileVersionsApi.md#list) | **GET** {file_repository_href}versions/ | List repository versions
|
9
|
+
[**read**](RepositoriesFileVersionsApi.md#read) | **GET** {file_repository_version_href} | Inspect a repository version
|
10
|
+
|
11
|
+
|
12
|
+
|
13
|
+
## delete
|
14
|
+
|
15
|
+
> AsyncOperationResponse delete(file_repository_version_href)
|
16
|
+
|
17
|
+
Delete a repository version
|
18
|
+
|
19
|
+
Trigger an asynchronous task to delete a repositroy version.
|
20
|
+
|
21
|
+
### Example
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
# load the gem
|
25
|
+
require 'pulp_file_client'
|
26
|
+
# setup authorization
|
27
|
+
PulpFileClient.configure do |config|
|
28
|
+
# Configure HTTP basic authorization: Basic
|
29
|
+
config.username = 'YOUR USERNAME'
|
30
|
+
config.password = 'YOUR PASSWORD'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = PulpFileClient::RepositoriesFileVersionsApi.new
|
34
|
+
file_repository_version_href = 'file_repository_version_href_example' # String | URI of Repository Version. e.g.: /pulp/api/v3/repositories/file/file/1/versions/1/
|
35
|
+
|
36
|
+
begin
|
37
|
+
#Delete a repository version
|
38
|
+
result = api_instance.delete(file_repository_version_href)
|
39
|
+
p result
|
40
|
+
rescue PulpFileClient::ApiError => e
|
41
|
+
puts "Exception when calling RepositoriesFileVersionsApi->delete: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
### Parameters
|
46
|
+
|
47
|
+
|
48
|
+
Name | Type | Description | Notes
|
49
|
+
------------- | ------------- | ------------- | -------------
|
50
|
+
**file_repository_version_href** | **String**| URI of Repository Version. e.g.: /pulp/api/v3/repositories/file/file/1/versions/1/ |
|
51
|
+
|
52
|
+
### Return type
|
53
|
+
|
54
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
55
|
+
|
56
|
+
### Authorization
|
57
|
+
|
58
|
+
[Basic](../README.md#Basic)
|
59
|
+
|
60
|
+
### HTTP request headers
|
61
|
+
|
62
|
+
- **Content-Type**: Not defined
|
63
|
+
- **Accept**: application/json
|
64
|
+
|
65
|
+
|
66
|
+
## list
|
67
|
+
|
68
|
+
> InlineResponse2006 list(file_file_repository_href, opts)
|
69
|
+
|
70
|
+
List repository versions
|
71
|
+
|
72
|
+
FileRepositoryVersion represents a single file repository version.
|
73
|
+
|
74
|
+
### Example
|
75
|
+
|
76
|
+
```ruby
|
77
|
+
# load the gem
|
78
|
+
require 'pulp_file_client'
|
79
|
+
# setup authorization
|
80
|
+
PulpFileClient.configure do |config|
|
81
|
+
# Configure HTTP basic authorization: Basic
|
82
|
+
config.username = 'YOUR USERNAME'
|
83
|
+
config.password = 'YOUR PASSWORD'
|
84
|
+
end
|
85
|
+
|
86
|
+
api_instance = PulpFileClient::RepositoriesFileVersionsApi.new
|
87
|
+
file_file_repository_href = 'file_file_repository_href_example' # String | URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
|
88
|
+
opts = {
|
89
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
90
|
+
number: 3.4, # Float |
|
91
|
+
number__lt: 3.4, # Float | Filter results where number is less than value
|
92
|
+
number__lte: 3.4, # Float | Filter results where number is less than or equal to value
|
93
|
+
number__gt: 3.4, # Float | Filter results where number is greater than value
|
94
|
+
number__gte: 3.4, # Float | Filter results where number is greater than or equal to value
|
95
|
+
number__range: 3.4, # Float | Filter results where number is between two comma separated values
|
96
|
+
pulp_created__lt: 'pulp_created__lt_example', # String | Filter results where pulp_created is less than value
|
97
|
+
pulp_created__lte: 'pulp_created__lte_example', # String | Filter results where pulp_created is less than or equal to value
|
98
|
+
pulp_created__gt: 'pulp_created__gt_example', # String | Filter results where pulp_created is greater than value
|
99
|
+
pulp_created__gte: 'pulp_created__gte_example', # String | Filter results where pulp_created is greater than or equal to value
|
100
|
+
pulp_created__range: 'pulp_created__range_example', # String | Filter results where pulp_created is between two comma separated values
|
101
|
+
content: 'content_example', # String | Content Unit referenced by HREF
|
102
|
+
pulp_created: 'pulp_created_example', # String | ISO 8601 formatted dates are supported
|
103
|
+
limit: 56, # Integer | Number of results to return per page.
|
104
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
105
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
106
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
107
|
+
}
|
108
|
+
|
109
|
+
begin
|
110
|
+
#List repository versions
|
111
|
+
result = api_instance.list(file_file_repository_href, opts)
|
112
|
+
p result
|
113
|
+
rescue PulpFileClient::ApiError => e
|
114
|
+
puts "Exception when calling RepositoriesFileVersionsApi->list: #{e}"
|
115
|
+
end
|
116
|
+
```
|
117
|
+
|
118
|
+
### Parameters
|
119
|
+
|
120
|
+
|
121
|
+
Name | Type | Description | Notes
|
122
|
+
------------- | ------------- | ------------- | -------------
|
123
|
+
**file_file_repository_href** | **String**| URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/ |
|
124
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
125
|
+
**number** | **Float**| | [optional]
|
126
|
+
**number__lt** | **Float**| Filter results where number is less than value | [optional]
|
127
|
+
**number__lte** | **Float**| Filter results where number is less than or equal to value | [optional]
|
128
|
+
**number__gt** | **Float**| Filter results where number is greater than value | [optional]
|
129
|
+
**number__gte** | **Float**| Filter results where number is greater than or equal to value | [optional]
|
130
|
+
**number__range** | **Float**| Filter results where number is between two comma separated values | [optional]
|
131
|
+
**pulp_created__lt** | **String**| Filter results where pulp_created is less than value | [optional]
|
132
|
+
**pulp_created__lte** | **String**| Filter results where pulp_created is less than or equal to value | [optional]
|
133
|
+
**pulp_created__gt** | **String**| Filter results where pulp_created is greater than value | [optional]
|
134
|
+
**pulp_created__gte** | **String**| Filter results where pulp_created is greater than or equal to value | [optional]
|
135
|
+
**pulp_created__range** | **String**| Filter results where pulp_created is between two comma separated values | [optional]
|
136
|
+
**content** | **String**| Content Unit referenced by HREF | [optional]
|
137
|
+
**pulp_created** | **String**| ISO 8601 formatted dates are supported | [optional]
|
138
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
139
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
140
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
141
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
142
|
+
|
143
|
+
### Return type
|
144
|
+
|
145
|
+
[**InlineResponse2006**](InlineResponse2006.md)
|
146
|
+
|
147
|
+
### Authorization
|
148
|
+
|
149
|
+
[Basic](../README.md#Basic)
|
150
|
+
|
151
|
+
### HTTP request headers
|
152
|
+
|
153
|
+
- **Content-Type**: Not defined
|
154
|
+
- **Accept**: application/json
|
155
|
+
|
156
|
+
|
157
|
+
## read
|
158
|
+
|
159
|
+
> RepositoryVersion read(file_repository_version_href, opts)
|
160
|
+
|
161
|
+
Inspect a repository version
|
162
|
+
|
163
|
+
FileRepositoryVersion represents a single file repository version.
|
164
|
+
|
165
|
+
### Example
|
166
|
+
|
167
|
+
```ruby
|
168
|
+
# load the gem
|
169
|
+
require 'pulp_file_client'
|
170
|
+
# setup authorization
|
171
|
+
PulpFileClient.configure do |config|
|
172
|
+
# Configure HTTP basic authorization: Basic
|
173
|
+
config.username = 'YOUR USERNAME'
|
174
|
+
config.password = 'YOUR PASSWORD'
|
175
|
+
end
|
176
|
+
|
177
|
+
api_instance = PulpFileClient::RepositoriesFileVersionsApi.new
|
178
|
+
file_repository_version_href = 'file_repository_version_href_example' # String | URI of Repository Version. e.g.: /pulp/api/v3/repositories/file/file/1/versions/1/
|
179
|
+
opts = {
|
180
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
181
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
182
|
+
}
|
183
|
+
|
184
|
+
begin
|
185
|
+
#Inspect a repository version
|
186
|
+
result = api_instance.read(file_repository_version_href, opts)
|
187
|
+
p result
|
188
|
+
rescue PulpFileClient::ApiError => e
|
189
|
+
puts "Exception when calling RepositoriesFileVersionsApi->read: #{e}"
|
190
|
+
end
|
191
|
+
```
|
192
|
+
|
193
|
+
### Parameters
|
194
|
+
|
195
|
+
|
196
|
+
Name | Type | Description | Notes
|
197
|
+
------------- | ------------- | ------------- | -------------
|
198
|
+
**file_repository_version_href** | **String**| URI of Repository Version. e.g.: /pulp/api/v3/repositories/file/file/1/versions/1/ |
|
199
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
200
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
201
|
+
|
202
|
+
### Return type
|
203
|
+
|
204
|
+
[**RepositoryVersion**](RepositoryVersion.md)
|
205
|
+
|
206
|
+
### Authorization
|
207
|
+
|
208
|
+
[Basic](../README.md#Basic)
|
209
|
+
|
210
|
+
### HTTP request headers
|
211
|
+
|
212
|
+
- **Content-Type**: Not defined
|
213
|
+
- **Accept**: application/json
|
214
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# PulpFileClient::RepositoryAddRemoveContent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**add_content_units** | **Array<String>** | A list of content units to add to a new repository version. This content is added after remove_content_units are removed. | [optional]
|
8
|
+
**remove_content_units** | **Array<String>** | A list of content units to remove from the latest repository version. You may also specify '*' as an entry to remove all content. This content is removed before add_content_units are added. | [optional]
|
9
|
+
**base_version** | **String** | A repository version whose content will be used as the initial set of content for the new repository version | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'PulpFileClient'
|
15
|
+
|
16
|
+
instance = PulpFileClient::RepositoryAddRemoveContent.new(add_content_units: null,
|
17
|
+
remove_content_units: null,
|
18
|
+
base_version: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|