pulp_file_client 1.10.5 → 1.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +35 -12
  3. data/docs/AcsFileApi.md +235 -8
  4. data/docs/ContentFilesApi.md +5 -3
  5. data/docs/DistributionsFileApi.md +230 -2
  6. data/docs/FileFileContent.md +3 -1
  7. data/docs/FileFileRemote.md +3 -3
  8. data/docs/FileFileRemoteResponse.md +1 -1
  9. data/docs/MyPermissionsResponse.md +17 -0
  10. data/docs/NestedRole.md +21 -0
  11. data/docs/NestedRoleResponse.md +21 -0
  12. data/docs/ObjectRolesResponse.md +17 -0
  13. data/docs/PatchedfileFileRemote.md +3 -3
  14. data/docs/PublicationsFileApi.md +232 -2
  15. data/docs/RemotesFileApi.md +230 -2
  16. data/docs/Repair.md +17 -0
  17. data/docs/RepositoriesFileApi.md +233 -4
  18. data/docs/RepositoriesFileVersionsApi.md +6 -6
  19. data/lib/pulp_file_client/api/acs_file_api.rb +281 -15
  20. data/lib/pulp_file_client/api/content_files_api.rb +14 -3
  21. data/lib/pulp_file_client/api/distributions_file_api.rb +275 -3
  22. data/lib/pulp_file_client/api/publications_file_api.rb +278 -3
  23. data/lib/pulp_file_client/api/remotes_file_api.rb +275 -3
  24. data/lib/pulp_file_client/api/repositories_file_api.rb +277 -3
  25. data/lib/pulp_file_client/api/repositories_file_versions_api.rb +16 -12
  26. data/lib/pulp_file_client/api_client.rb +1 -1
  27. data/lib/pulp_file_client/models/file_file_alternate_content_source.rb +19 -0
  28. data/lib/pulp_file_client/models/file_file_content.rb +33 -4
  29. data/lib/pulp_file_client/models/file_file_distribution.rb +38 -0
  30. data/lib/pulp_file_client/models/file_file_publication.rb +15 -0
  31. data/lib/pulp_file_client/models/file_file_remote.rb +161 -3
  32. data/lib/pulp_file_client/models/file_file_remote_response.rb +1 -1
  33. data/lib/pulp_file_client/models/file_file_repository.rb +49 -0
  34. data/lib/pulp_file_client/models/{repository_version.rb → my_permissions_response.rb} +17 -12
  35. data/lib/pulp_file_client/models/{content_summary.rb → nested_role.rb} +28 -40
  36. data/lib/pulp_file_client/models/nested_role_response.rb +234 -0
  37. data/lib/pulp_file_client/models/object_roles_response.rb +213 -0
  38. data/lib/pulp_file_client/models/patchedfile_file_alternate_content_source.rb +15 -0
  39. data/lib/pulp_file_client/models/patchedfile_file_distribution.rb +30 -0
  40. data/lib/pulp_file_client/models/patchedfile_file_remote.rb +153 -3
  41. data/lib/pulp_file_client/models/patchedfile_file_repository.rb +45 -0
  42. data/lib/pulp_file_client/models/repair.rb +209 -0
  43. data/lib/pulp_file_client/version.rb +1 -1
  44. data/lib/pulp_file_client.rb +5 -2
  45. data/pulp_file_client.gemspec +1 -1
  46. data/spec/api/acs_file_api_spec.rb +52 -2
  47. data/spec/api/content_files_api_spec.rb +2 -1
  48. data/spec/api/distributions_file_api_spec.rb +51 -1
  49. data/spec/api/publications_file_api_spec.rb +52 -1
  50. data/spec/api/remotes_file_api_spec.rb +51 -1
  51. data/spec/api/repositories_file_api_spec.rb +52 -1
  52. data/spec/api/repositories_file_versions_api_spec.rb +2 -2
  53. data/spec/models/file_file_content_spec.rb +6 -0
  54. data/spec/models/my_permissions_response_spec.rb +41 -0
  55. data/spec/models/nested_role_response_spec.rb +53 -0
  56. data/spec/models/{content_summary_spec.rb → nested_role_spec.rb} +9 -9
  57. data/spec/models/object_roles_response_spec.rb +41 -0
  58. data/spec/models/{repository_version_spec.rb → repair_spec.rb} +7 -7
  59. metadata +48 -36
  60. data/docs/ContentSummary.md +0 -21
  61. data/docs/RepositoryVersion.md +0 -17
@@ -4,15 +4,73 @@ All URIs are relative to *https://pulp*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**add_role**](DistributionsFileApi.md#add_role) | **POST** {file_file_distribution_href}add_role/ |
7
8
  [**create**](DistributionsFileApi.md#create) | **POST** /pulp/api/v3/distributions/file/file/ | Create a file distribution
8
9
  [**delete**](DistributionsFileApi.md#delete) | **DELETE** {file_file_distribution_href} | Delete a file distribution
9
10
  [**list**](DistributionsFileApi.md#list) | **GET** /pulp/api/v3/distributions/file/file/ | List file distributions
11
+ [**list_roles**](DistributionsFileApi.md#list_roles) | **GET** {file_file_distribution_href}list_roles/ |
12
+ [**my_permissions**](DistributionsFileApi.md#my_permissions) | **GET** {file_file_distribution_href}my_permissions/ |
10
13
  [**partial_update**](DistributionsFileApi.md#partial_update) | **PATCH** {file_file_distribution_href} | Update a file distribution
11
14
  [**read**](DistributionsFileApi.md#read) | **GET** {file_file_distribution_href} | Inspect a file distribution
15
+ [**remove_role**](DistributionsFileApi.md#remove_role) | **POST** {file_file_distribution_href}remove_role/ |
12
16
  [**update**](DistributionsFileApi.md#update) | **PUT** {file_file_distribution_href} | Update a file distribution
13
17
 
14
18
 
15
19
 
20
+ ## add_role
21
+
22
+ > NestedRoleResponse add_role(file_file_distribution_href, nested_role)
23
+
24
+
25
+
26
+ Add a role for this object to users/groups.
27
+
28
+ ### Example
29
+
30
+ ```ruby
31
+ # load the gem
32
+ require 'pulp_file_client'
33
+ # setup authorization
34
+ PulpFileClient.configure do |config|
35
+ # Configure HTTP basic authorization: basicAuth
36
+ config.username = 'YOUR USERNAME'
37
+ config.password = 'YOUR PASSWORD'
38
+ end
39
+
40
+ api_instance = PulpFileClient::DistributionsFileApi.new
41
+ file_file_distribution_href = 'file_file_distribution_href_example' # String |
42
+ nested_role = PulpFileClient::NestedRole.new # NestedRole |
43
+
44
+ begin
45
+ result = api_instance.add_role(file_file_distribution_href, nested_role)
46
+ p result
47
+ rescue PulpFileClient::ApiError => e
48
+ puts "Exception when calling DistributionsFileApi->add_role: #{e}"
49
+ end
50
+ ```
51
+
52
+ ### Parameters
53
+
54
+
55
+ Name | Type | Description | Notes
56
+ ------------- | ------------- | ------------- | -------------
57
+ **file_file_distribution_href** | **String**| |
58
+ **nested_role** | [**NestedRole**](NestedRole.md)| |
59
+
60
+ ### Return type
61
+
62
+ [**NestedRoleResponse**](NestedRoleResponse.md)
63
+
64
+ ### Authorization
65
+
66
+ [basicAuth](../README.md#basicAuth)
67
+
68
+ ### HTTP request headers
69
+
70
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
71
+ - **Accept**: application/json
72
+
73
+
16
74
  ## create
17
75
 
18
76
  > AsyncOperationResponse create(file_file_distribution)
@@ -152,7 +210,7 @@ opts = {
152
210
  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
153
211
  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
154
212
  offset: 56, # Integer | The initial index from which to return the results.
155
- ordering: 'ordering_example', # String | Which field to use when ordering the results.
213
+ ordering: ['ordering_example'], # Array<String> | Ordering
156
214
  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
157
215
  fields: 'fields_example', # String | A list of fields to include in the response.
158
216
  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
@@ -183,7 +241,7 @@ Name | Type | Description | Notes
183
241
  **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
184
242
  **name__startswith** | **String**| Filter results where name starts with value | [optional]
185
243
  **offset** | **Integer**| The initial index from which to return the results. | [optional]
186
- **ordering** | **String**| Which field to use when ordering the results. | [optional]
244
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional]
187
245
  **pulp_label_select** | **String**| Filter labels by search string | [optional]
188
246
  **fields** | **String**| A list of fields to include in the response. | [optional]
189
247
  **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
@@ -202,6 +260,122 @@ Name | Type | Description | Notes
202
260
  - **Accept**: application/json
203
261
 
204
262
 
263
+ ## list_roles
264
+
265
+ > ObjectRolesResponse list_roles(file_file_distribution_href, opts)
266
+
267
+
268
+
269
+ List roles assigned to this object.
270
+
271
+ ### Example
272
+
273
+ ```ruby
274
+ # load the gem
275
+ require 'pulp_file_client'
276
+ # setup authorization
277
+ PulpFileClient.configure do |config|
278
+ # Configure HTTP basic authorization: basicAuth
279
+ config.username = 'YOUR USERNAME'
280
+ config.password = 'YOUR PASSWORD'
281
+ end
282
+
283
+ api_instance = PulpFileClient::DistributionsFileApi.new
284
+ file_file_distribution_href = 'file_file_distribution_href_example' # String |
285
+ opts = {
286
+ fields: 'fields_example', # String | A list of fields to include in the response.
287
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
288
+ }
289
+
290
+ begin
291
+ result = api_instance.list_roles(file_file_distribution_href, opts)
292
+ p result
293
+ rescue PulpFileClient::ApiError => e
294
+ puts "Exception when calling DistributionsFileApi->list_roles: #{e}"
295
+ end
296
+ ```
297
+
298
+ ### Parameters
299
+
300
+
301
+ Name | Type | Description | Notes
302
+ ------------- | ------------- | ------------- | -------------
303
+ **file_file_distribution_href** | **String**| |
304
+ **fields** | **String**| A list of fields to include in the response. | [optional]
305
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
306
+
307
+ ### Return type
308
+
309
+ [**ObjectRolesResponse**](ObjectRolesResponse.md)
310
+
311
+ ### Authorization
312
+
313
+ [basicAuth](../README.md#basicAuth)
314
+
315
+ ### HTTP request headers
316
+
317
+ - **Content-Type**: Not defined
318
+ - **Accept**: application/json
319
+
320
+
321
+ ## my_permissions
322
+
323
+ > MyPermissionsResponse my_permissions(file_file_distribution_href, opts)
324
+
325
+
326
+
327
+ List permissions available to the current user on this object.
328
+
329
+ ### Example
330
+
331
+ ```ruby
332
+ # load the gem
333
+ require 'pulp_file_client'
334
+ # setup authorization
335
+ PulpFileClient.configure do |config|
336
+ # Configure HTTP basic authorization: basicAuth
337
+ config.username = 'YOUR USERNAME'
338
+ config.password = 'YOUR PASSWORD'
339
+ end
340
+
341
+ api_instance = PulpFileClient::DistributionsFileApi.new
342
+ file_file_distribution_href = 'file_file_distribution_href_example' # String |
343
+ opts = {
344
+ fields: 'fields_example', # String | A list of fields to include in the response.
345
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
346
+ }
347
+
348
+ begin
349
+ result = api_instance.my_permissions(file_file_distribution_href, opts)
350
+ p result
351
+ rescue PulpFileClient::ApiError => e
352
+ puts "Exception when calling DistributionsFileApi->my_permissions: #{e}"
353
+ end
354
+ ```
355
+
356
+ ### Parameters
357
+
358
+
359
+ Name | Type | Description | Notes
360
+ ------------- | ------------- | ------------- | -------------
361
+ **file_file_distribution_href** | **String**| |
362
+ **fields** | **String**| A list of fields to include in the response. | [optional]
363
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
364
+
365
+ ### Return type
366
+
367
+ [**MyPermissionsResponse**](MyPermissionsResponse.md)
368
+
369
+ ### Authorization
370
+
371
+ [basicAuth](../README.md#basicAuth)
372
+
373
+ ### HTTP request headers
374
+
375
+ - **Content-Type**: Not defined
376
+ - **Accept**: application/json
377
+
378
+
205
379
  ## partial_update
206
380
 
207
381
  > AsyncOperationResponse partial_update(file_file_distribution_href, patchedfile_file_distribution)
@@ -316,6 +490,60 @@ Name | Type | Description | Notes
316
490
  - **Accept**: application/json
317
491
 
318
492
 
493
+ ## remove_role
494
+
495
+ > NestedRoleResponse remove_role(file_file_distribution_href, nested_role)
496
+
497
+
498
+
499
+ Remove a role for this object from users/groups.
500
+
501
+ ### Example
502
+
503
+ ```ruby
504
+ # load the gem
505
+ require 'pulp_file_client'
506
+ # setup authorization
507
+ PulpFileClient.configure do |config|
508
+ # Configure HTTP basic authorization: basicAuth
509
+ config.username = 'YOUR USERNAME'
510
+ config.password = 'YOUR PASSWORD'
511
+ end
512
+
513
+ api_instance = PulpFileClient::DistributionsFileApi.new
514
+ file_file_distribution_href = 'file_file_distribution_href_example' # String |
515
+ nested_role = PulpFileClient::NestedRole.new # NestedRole |
516
+
517
+ begin
518
+ result = api_instance.remove_role(file_file_distribution_href, nested_role)
519
+ p result
520
+ rescue PulpFileClient::ApiError => e
521
+ puts "Exception when calling DistributionsFileApi->remove_role: #{e}"
522
+ end
523
+ ```
524
+
525
+ ### Parameters
526
+
527
+
528
+ Name | Type | Description | Notes
529
+ ------------- | ------------- | ------------- | -------------
530
+ **file_file_distribution_href** | **String**| |
531
+ **nested_role** | [**NestedRole**](NestedRole.md)| |
532
+
533
+ ### Return type
534
+
535
+ [**NestedRoleResponse**](NestedRoleResponse.md)
536
+
537
+ ### Authorization
538
+
539
+ [basicAuth](../README.md#basicAuth)
540
+
541
+ ### HTTP request headers
542
+
543
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
544
+ - **Accept**: application/json
545
+
546
+
319
547
  ## update
320
548
 
321
549
  > AsyncOperationResponse update(file_file_distribution_href, file_file_distribution)
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
8
8
  **relative_path** | **String** | Path where the artifact is located relative to distributions base_path |
9
9
  **file** | **File** | An uploaded file that may be turned into the artifact of the content unit. | [optional]
10
10
  **repository** | **String** | A URI of a repository the new content unit should be associated with. | [optional]
11
+ **upload** | **String** | An uncommitted upload that may be turned into the artifact of the content unit. | [optional]
11
12
 
12
13
  ## Code Sample
13
14
 
@@ -17,7 +18,8 @@ require 'PulpFileClient'
17
18
  instance = PulpFileClient::FileFileContent.new(artifact: null,
18
19
  relative_path: null,
19
20
  file: null,
20
- repository: null)
21
+ repository: null,
22
+ upload: null)
21
23
  ```
22
24
 
23
25
 
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
12
12
  **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional]
13
13
  **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional]
14
14
  **proxy_username** | **String** | The username to authenticte to the proxy. | [optional]
15
- **proxy_password** | **String** | The password to authenticte to the proxy. | [optional]
15
+ **proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional]
16
16
  **username** | **String** | The username to be used for authentication when syncing. | [optional]
17
- **password** | **String** | The password to be used for authentication when syncing. | [optional]
17
+ **password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional]
18
18
  **pulp_labels** | [**Object**](.md) | | [optional]
19
19
  **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
20
20
  **max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional]
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
24
24
  **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
25
25
  **sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
26
26
  **headers** | **Array&lt;Object&gt;** | Headers for aiohttp.Clientsession | [optional]
27
- **rate_limit** | **Integer** | Limits total download rate in requests per second | [optional]
27
+ **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional]
28
28
 
29
29
  ## Code Sample
30
30
 
@@ -22,7 +22,7 @@ Name | Type | Description | Notes
22
22
  **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
23
23
  **sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
24
24
  **headers** | **Array&lt;Object&gt;** | Headers for aiohttp.Clientsession | [optional]
25
- **rate_limit** | **Integer** | Limits total download rate in requests per second | [optional]
25
+ **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional]
26
26
 
27
27
  ## Code Sample
28
28
 
@@ -0,0 +1,17 @@
1
+ # PulpFileClient::MyPermissionsResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **permissions** | **Array&lt;String&gt;** | |
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'PulpFileClient'
13
+
14
+ instance = PulpFileClient::MyPermissionsResponse.new(permissions: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,21 @@
1
+ # PulpFileClient::NestedRole
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **users** | **Array&lt;String&gt;** | | [optional]
8
+ **groups** | **Array&lt;String&gt;** | | [optional]
9
+ **role** | **String** | |
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'PulpFileClient'
15
+
16
+ instance = PulpFileClient::NestedRole.new(users: null,
17
+ groups: null,
18
+ role: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,21 @@
1
+ # PulpFileClient::NestedRoleResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **users** | **Array&lt;String&gt;** | | [optional]
8
+ **groups** | **Array&lt;String&gt;** | | [optional]
9
+ **role** | **String** | |
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'PulpFileClient'
15
+
16
+ instance = PulpFileClient::NestedRoleResponse.new(users: null,
17
+ groups: null,
18
+ role: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,17 @@
1
+ # PulpFileClient::ObjectRolesResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **roles** | [**Array&lt;NestedRoleResponse&gt;**](NestedRoleResponse.md) | |
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'PulpFileClient'
13
+
14
+ instance = PulpFileClient::ObjectRolesResponse.new(roles: null)
15
+ ```
16
+
17
+
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
12
12
  **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional]
13
13
  **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional]
14
14
  **proxy_username** | **String** | The username to authenticte to the proxy. | [optional]
15
- **proxy_password** | **String** | The password to authenticte to the proxy. | [optional]
15
+ **proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional]
16
16
  **username** | **String** | The username to be used for authentication when syncing. | [optional]
17
- **password** | **String** | The password to be used for authentication when syncing. | [optional]
17
+ **password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional]
18
18
  **pulp_labels** | [**Object**](.md) | | [optional]
19
19
  **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
20
20
  **max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional]
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
24
24
  **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
25
25
  **sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
26
26
  **headers** | **Array&lt;Object&gt;** | Headers for aiohttp.Clientsession | [optional]
27
- **rate_limit** | **Integer** | Limits total download rate in requests per second | [optional]
27
+ **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional]
28
28
 
29
29
  ## Code Sample
30
30