pulpcore_client 3.22.28 → 3.22.29
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.
- checksums.yaml +4 -4
- data/README.md +144 -142
- data/docs/AccessPoliciesApi.md +26 -26
- data/docs/ArtifactDistributionResponse.md +8 -8
- data/docs/ArtifactsApi.md +21 -21
- data/docs/ContentApi.md +6 -6
- data/docs/ContentguardsApi.md +6 -6
- data/docs/ContentguardsContentRedirectApi.md +51 -51
- data/docs/ContentguardsRbacApi.md +51 -51
- data/docs/DistributionsApi.md +6 -6
- data/docs/DistributionsArtifactsApi.md +11 -11
- data/docs/DocsApiJsonApi.md +61 -0
- data/docs/DocsApiYamlApi.md +61 -0
- data/docs/ExportersFilesystemApi.md +31 -31
- data/docs/ExportersFilesystemExportsApi.md +21 -21
- data/docs/ExportersPulpApi.md +31 -31
- data/docs/ExportersPulpExportsApi.md +21 -21
- data/docs/GroupsApi.md +51 -51
- data/docs/GroupsRolesApi.md +21 -21
- data/docs/GroupsUsersApi.md +16 -16
- data/docs/ImportersPulpApi.md +31 -31
- data/docs/ImportersPulpImportCheckApi.md +1 -1
- data/docs/ImportersPulpImportsApi.md +21 -21
- data/docs/OrphansApi.md +6 -6
- data/docs/OrphansCleanupApi.md +6 -6
- data/docs/PublicationsApi.md +6 -6
- data/docs/RemoteResponseHiddenFields.md +2 -2
- data/docs/RemotesApi.md +6 -6
- data/docs/RepairApi.md +6 -6
- data/docs/RepositoriesApi.md +6 -6
- data/docs/RepositoriesReclaimSpaceApi.md +6 -6
- data/docs/RepositoryVersionsApi.md +6 -6
- data/docs/RolesApi.md +31 -31
- data/docs/SigningServicesApi.md +11 -11
- data/docs/StatusApi.md +1 -1
- data/docs/TaskGroupsApi.md +11 -11
- data/docs/TaskSchedulesApi.md +31 -31
- data/docs/TasksApi.md +96 -96
- data/docs/UploadsApi.md +51 -51
- data/docs/UsersApi.md +31 -31
- data/docs/UsersRolesApi.md +21 -21
- data/docs/WorkersApi.md +11 -11
- data/lib/pulpcore_client/api/access_policies_api.rb +31 -31
- data/lib/pulpcore_client/api/artifacts_api.rb +29 -29
- data/lib/pulpcore_client/api/content_api.rb +5 -5
- data/lib/pulpcore_client/api/contentguards_api.rb +5 -5
- data/lib/pulpcore_client/api/contentguards_content_redirect_api.rb +63 -63
- data/lib/pulpcore_client/api/contentguards_rbac_api.rb +63 -63
- data/lib/pulpcore_client/api/distributions_api.rb +5 -5
- data/lib/pulpcore_client/api/distributions_artifacts_api.rb +11 -11
- data/lib/pulpcore_client/api/docs_api_json_api.rb +89 -0
- data/lib/pulpcore_client/api/docs_api_yaml_api.rb +89 -0
- data/lib/pulpcore_client/api/exporters_filesystem_api.rb +37 -37
- data/lib/pulpcore_client/api/exporters_filesystem_exports_api.rb +25 -25
- data/lib/pulpcore_client/api/exporters_pulp_api.rb +37 -37
- data/lib/pulpcore_client/api/exporters_pulp_exports_api.rb +25 -25
- data/lib/pulpcore_client/api/groups_api.rb +63 -63
- data/lib/pulpcore_client/api/groups_roles_api.rb +25 -25
- data/lib/pulpcore_client/api/groups_users_api.rb +19 -19
- data/lib/pulpcore_client/api/importers_pulp_api.rb +37 -37
- data/lib/pulpcore_client/api/importers_pulp_imports_api.rb +25 -25
- data/lib/pulpcore_client/api/orphans_api.rb +5 -5
- data/lib/pulpcore_client/api/orphans_cleanup_api.rb +6 -6
- data/lib/pulpcore_client/api/publications_api.rb +5 -5
- data/lib/pulpcore_client/api/remotes_api.rb +5 -5
- data/lib/pulpcore_client/api/repair_api.rb +6 -6
- data/lib/pulpcore_client/api/repositories_api.rb +5 -5
- data/lib/pulpcore_client/api/repositories_reclaim_space_api.rb +6 -6
- data/lib/pulpcore_client/api/repository_versions_api.rb +5 -5
- data/lib/pulpcore_client/api/roles_api.rb +37 -37
- data/lib/pulpcore_client/api/signing_services_api.rb +11 -11
- data/lib/pulpcore_client/api/task_groups_api.rb +11 -11
- data/lib/pulpcore_client/api/task_schedules_api.rb +37 -37
- data/lib/pulpcore_client/api/tasks_api.rb +119 -119
- data/lib/pulpcore_client/api/uploads_api.rb +65 -65
- data/lib/pulpcore_client/api/users_api.rb +37 -37
- data/lib/pulpcore_client/api/users_roles_api.rb +25 -25
- data/lib/pulpcore_client/api/workers_api.rb +11 -11
- data/lib/pulpcore_client/configuration.rb +3 -3
- data/lib/pulpcore_client/models/artifact_distribution_response.rb +37 -37
- data/lib/pulpcore_client/models/remote_response.rb +20 -20
- data/lib/pulpcore_client/models/remote_response_hidden_fields.rb +10 -0
- data/lib/pulpcore_client/version.rb +1 -1
- data/lib/pulpcore_client.rb +2 -0
- data/spec/api/access_policies_api_spec.rb +10 -10
- data/spec/api/artifacts_api_spec.rb +8 -8
- data/spec/api/content_api_spec.rb +2 -2
- data/spec/api/contentguards_api_spec.rb +2 -2
- data/spec/api/contentguards_content_redirect_api_spec.rb +20 -20
- data/spec/api/contentguards_rbac_api_spec.rb +20 -20
- data/spec/api/distributions_api_spec.rb +2 -2
- data/spec/api/distributions_artifacts_api_spec.rb +4 -4
- data/spec/api/docs_api_json_api_spec.rb +48 -0
- data/spec/api/docs_api_yaml_api_spec.rb +48 -0
- data/spec/api/exporters_filesystem_api_spec.rb +12 -12
- data/spec/api/exporters_filesystem_exports_api_spec.rb +8 -8
- data/spec/api/exporters_pulp_api_spec.rb +12 -12
- data/spec/api/exporters_pulp_exports_api_spec.rb +8 -8
- data/spec/api/groups_api_spec.rb +20 -20
- data/spec/api/groups_roles_api_spec.rb +8 -8
- data/spec/api/groups_users_api_spec.rb +6 -6
- data/spec/api/importers_pulp_api_spec.rb +12 -12
- data/spec/api/importers_pulp_imports_api_spec.rb +8 -8
- data/spec/api/orphans_api_spec.rb +2 -2
- data/spec/api/orphans_cleanup_api_spec.rb +2 -2
- data/spec/api/publications_api_spec.rb +2 -2
- data/spec/api/remotes_api_spec.rb +2 -2
- data/spec/api/repair_api_spec.rb +2 -2
- data/spec/api/repositories_api_spec.rb +2 -2
- data/spec/api/repositories_reclaim_space_api_spec.rb +2 -2
- data/spec/api/repository_versions_api_spec.rb +2 -2
- data/spec/api/roles_api_spec.rb +12 -12
- data/spec/api/signing_services_api_spec.rb +4 -4
- data/spec/api/task_groups_api_spec.rb +4 -4
- data/spec/api/task_schedules_api_spec.rb +12 -12
- data/spec/api/tasks_api_spec.rb +29 -29
- data/spec/api/uploads_api_spec.rb +20 -20
- data/spec/api/users_api_spec.rb +12 -12
- data/spec/api/users_roles_api_spec.rb +8 -8
- data/spec/api/workers_api_spec.rb +4 -4
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/artifact_distribution_response_spec.rb +5 -5
- metadata +152 -144
data/docs/TasksApi.md
CHANGED
|
@@ -1,24 +1,24 @@
|
|
|
1
1
|
# PulpcoreClient::TasksApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *
|
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**
|
|
8
|
-
[**delete**](TasksApi.md#delete) | **DELETE** {task_href} | Delete a task
|
|
9
|
-
[**list**](TasksApi.md#list) | **GET** /pulp/api/v3/tasks/ | List tasks
|
|
10
|
-
[**list_roles**](TasksApi.md#list_roles) | **GET** {task_href}list_roles/ |
|
|
11
|
-
[**my_permissions**](TasksApi.md#my_permissions) | **GET** {task_href}my_permissions/ |
|
|
12
|
-
[**purge**](TasksApi.md#purge) | **POST** /pulp/api/v3/tasks/purge/ | Purge Completed Tasks
|
|
13
|
-
[**read**](TasksApi.md#read) | **GET** {task_href} | Inspect a task
|
|
14
|
-
[**remove_role**](TasksApi.md#remove_role) | **POST** {task_href}remove_role/ |
|
|
7
|
+
[**tasks_add_role**](TasksApi.md#tasks_add_role) | **POST** {task_href}add_role/ |
|
|
15
8
|
[**tasks_cancel**](TasksApi.md#tasks_cancel) | **PATCH** {task_href} | Cancel a task
|
|
9
|
+
[**tasks_delete**](TasksApi.md#tasks_delete) | **DELETE** {task_href} | Delete a task
|
|
10
|
+
[**tasks_list**](TasksApi.md#tasks_list) | **GET** /pulp/api/v3/tasks/ | List tasks
|
|
11
|
+
[**tasks_list_roles**](TasksApi.md#tasks_list_roles) | **GET** {task_href}list_roles/ |
|
|
12
|
+
[**tasks_my_permissions**](TasksApi.md#tasks_my_permissions) | **GET** {task_href}my_permissions/ |
|
|
13
|
+
[**tasks_purge**](TasksApi.md#tasks_purge) | **POST** /pulp/api/v3/tasks/purge/ | Purge Completed Tasks
|
|
14
|
+
[**tasks_read**](TasksApi.md#tasks_read) | **GET** {task_href} | Inspect a task
|
|
15
|
+
[**tasks_remove_role**](TasksApi.md#tasks_remove_role) | **POST** {task_href}remove_role/ |
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## tasks_add_role
|
|
20
20
|
|
|
21
|
-
> NestedRoleResponse
|
|
21
|
+
> NestedRoleResponse tasks_add_role(task_href, nested_role)
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
|
|
@@ -41,10 +41,10 @@ task_href = 'task_href_example' # String |
|
|
|
41
41
|
nested_role = PulpcoreClient::NestedRole.new # NestedRole |
|
|
42
42
|
|
|
43
43
|
begin
|
|
44
|
-
result = api_instance.
|
|
44
|
+
result = api_instance.tasks_add_role(task_href, nested_role)
|
|
45
45
|
p result
|
|
46
46
|
rescue PulpcoreClient::ApiError => e
|
|
47
|
-
puts "Exception when calling TasksApi->
|
|
47
|
+
puts "Exception when calling TasksApi->tasks_add_role: #{e}"
|
|
48
48
|
end
|
|
49
49
|
```
|
|
50
50
|
|
|
@@ -70,9 +70,64 @@ Name | Type | Description | Notes
|
|
|
70
70
|
- **Accept**: application/json
|
|
71
71
|
|
|
72
72
|
|
|
73
|
-
##
|
|
73
|
+
## tasks_cancel
|
|
74
|
+
|
|
75
|
+
> TaskResponse tasks_cancel(task_href, patched_task_cancel)
|
|
76
|
+
|
|
77
|
+
Cancel a task
|
|
78
|
+
|
|
79
|
+
This operation cancels a task.
|
|
80
|
+
|
|
81
|
+
### Example
|
|
82
|
+
|
|
83
|
+
```ruby
|
|
84
|
+
# load the gem
|
|
85
|
+
require 'pulpcore_client'
|
|
86
|
+
# setup authorization
|
|
87
|
+
PulpcoreClient.configure do |config|
|
|
88
|
+
# Configure HTTP basic authorization: basicAuth
|
|
89
|
+
config.username = 'YOUR USERNAME'
|
|
90
|
+
config.password = 'YOUR PASSWORD'
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
api_instance = PulpcoreClient::TasksApi.new
|
|
94
|
+
task_href = 'task_href_example' # String |
|
|
95
|
+
patched_task_cancel = PulpcoreClient::PatchedTaskCancel.new # PatchedTaskCancel |
|
|
96
|
+
|
|
97
|
+
begin
|
|
98
|
+
#Cancel a task
|
|
99
|
+
result = api_instance.tasks_cancel(task_href, patched_task_cancel)
|
|
100
|
+
p result
|
|
101
|
+
rescue PulpcoreClient::ApiError => e
|
|
102
|
+
puts "Exception when calling TasksApi->tasks_cancel: #{e}"
|
|
103
|
+
end
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Parameters
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
Name | Type | Description | Notes
|
|
110
|
+
------------- | ------------- | ------------- | -------------
|
|
111
|
+
**task_href** | **String**| |
|
|
112
|
+
**patched_task_cancel** | [**PatchedTaskCancel**](PatchedTaskCancel.md)| |
|
|
113
|
+
|
|
114
|
+
### Return type
|
|
115
|
+
|
|
116
|
+
[**TaskResponse**](TaskResponse.md)
|
|
117
|
+
|
|
118
|
+
### Authorization
|
|
119
|
+
|
|
120
|
+
[basicAuth](../README.md#basicAuth)
|
|
121
|
+
|
|
122
|
+
### HTTP request headers
|
|
123
|
+
|
|
124
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
125
|
+
- **Accept**: application/json
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
## tasks_delete
|
|
74
129
|
|
|
75
|
-
>
|
|
130
|
+
> tasks_delete(task_href)
|
|
76
131
|
|
|
77
132
|
Delete a task
|
|
78
133
|
|
|
@@ -95,9 +150,9 @@ task_href = 'task_href_example' # String |
|
|
|
95
150
|
|
|
96
151
|
begin
|
|
97
152
|
#Delete a task
|
|
98
|
-
api_instance.
|
|
153
|
+
api_instance.tasks_delete(task_href)
|
|
99
154
|
rescue PulpcoreClient::ApiError => e
|
|
100
|
-
puts "Exception when calling TasksApi->
|
|
155
|
+
puts "Exception when calling TasksApi->tasks_delete: #{e}"
|
|
101
156
|
end
|
|
102
157
|
```
|
|
103
158
|
|
|
@@ -122,9 +177,9 @@ nil (empty response body)
|
|
|
122
177
|
- **Accept**: Not defined
|
|
123
178
|
|
|
124
179
|
|
|
125
|
-
##
|
|
180
|
+
## tasks_list
|
|
126
181
|
|
|
127
|
-
> PaginatedTaskResponseList
|
|
182
|
+
> PaginatedTaskResponseList tasks_list(opts)
|
|
128
183
|
|
|
129
184
|
List tasks
|
|
130
185
|
|
|
@@ -185,10 +240,10 @@ opts = {
|
|
|
185
240
|
|
|
186
241
|
begin
|
|
187
242
|
#List tasks
|
|
188
|
-
result = api_instance.
|
|
243
|
+
result = api_instance.tasks_list(opts)
|
|
189
244
|
p result
|
|
190
245
|
rescue PulpcoreClient::ApiError => e
|
|
191
|
-
puts "Exception when calling TasksApi->
|
|
246
|
+
puts "Exception when calling TasksApi->tasks_list: #{e}"
|
|
192
247
|
end
|
|
193
248
|
```
|
|
194
249
|
|
|
@@ -249,9 +304,9 @@ Name | Type | Description | Notes
|
|
|
249
304
|
- **Accept**: application/json
|
|
250
305
|
|
|
251
306
|
|
|
252
|
-
##
|
|
307
|
+
## tasks_list_roles
|
|
253
308
|
|
|
254
|
-
> ObjectRolesResponse
|
|
309
|
+
> ObjectRolesResponse tasks_list_roles(task_href, opts)
|
|
255
310
|
|
|
256
311
|
|
|
257
312
|
|
|
@@ -277,10 +332,10 @@ opts = {
|
|
|
277
332
|
}
|
|
278
333
|
|
|
279
334
|
begin
|
|
280
|
-
result = api_instance.
|
|
335
|
+
result = api_instance.tasks_list_roles(task_href, opts)
|
|
281
336
|
p result
|
|
282
337
|
rescue PulpcoreClient::ApiError => e
|
|
283
|
-
puts "Exception when calling TasksApi->
|
|
338
|
+
puts "Exception when calling TasksApi->tasks_list_roles: #{e}"
|
|
284
339
|
end
|
|
285
340
|
```
|
|
286
341
|
|
|
@@ -307,9 +362,9 @@ Name | Type | Description | Notes
|
|
|
307
362
|
- **Accept**: application/json
|
|
308
363
|
|
|
309
364
|
|
|
310
|
-
##
|
|
365
|
+
## tasks_my_permissions
|
|
311
366
|
|
|
312
|
-
> MyPermissionsResponse
|
|
367
|
+
> MyPermissionsResponse tasks_my_permissions(task_href, opts)
|
|
313
368
|
|
|
314
369
|
|
|
315
370
|
|
|
@@ -335,10 +390,10 @@ opts = {
|
|
|
335
390
|
}
|
|
336
391
|
|
|
337
392
|
begin
|
|
338
|
-
result = api_instance.
|
|
393
|
+
result = api_instance.tasks_my_permissions(task_href, opts)
|
|
339
394
|
p result
|
|
340
395
|
rescue PulpcoreClient::ApiError => e
|
|
341
|
-
puts "Exception when calling TasksApi->
|
|
396
|
+
puts "Exception when calling TasksApi->tasks_my_permissions: #{e}"
|
|
342
397
|
end
|
|
343
398
|
```
|
|
344
399
|
|
|
@@ -365,9 +420,9 @@ Name | Type | Description | Notes
|
|
|
365
420
|
- **Accept**: application/json
|
|
366
421
|
|
|
367
422
|
|
|
368
|
-
##
|
|
423
|
+
## tasks_purge
|
|
369
424
|
|
|
370
|
-
> AsyncOperationResponse
|
|
425
|
+
> AsyncOperationResponse tasks_purge(purge)
|
|
371
426
|
|
|
372
427
|
Purge Completed Tasks
|
|
373
428
|
|
|
@@ -390,10 +445,10 @@ purge = PulpcoreClient::Purge.new # Purge |
|
|
|
390
445
|
|
|
391
446
|
begin
|
|
392
447
|
#Purge Completed Tasks
|
|
393
|
-
result = api_instance.
|
|
448
|
+
result = api_instance.tasks_purge(purge)
|
|
394
449
|
p result
|
|
395
450
|
rescue PulpcoreClient::ApiError => e
|
|
396
|
-
puts "Exception when calling TasksApi->
|
|
451
|
+
puts "Exception when calling TasksApi->tasks_purge: #{e}"
|
|
397
452
|
end
|
|
398
453
|
```
|
|
399
454
|
|
|
@@ -418,9 +473,9 @@ Name | Type | Description | Notes
|
|
|
418
473
|
- **Accept**: application/json
|
|
419
474
|
|
|
420
475
|
|
|
421
|
-
##
|
|
476
|
+
## tasks_read
|
|
422
477
|
|
|
423
|
-
> TaskResponse
|
|
478
|
+
> TaskResponse tasks_read(task_href, opts)
|
|
424
479
|
|
|
425
480
|
Inspect a task
|
|
426
481
|
|
|
@@ -447,10 +502,10 @@ opts = {
|
|
|
447
502
|
|
|
448
503
|
begin
|
|
449
504
|
#Inspect a task
|
|
450
|
-
result = api_instance.
|
|
505
|
+
result = api_instance.tasks_read(task_href, opts)
|
|
451
506
|
p result
|
|
452
507
|
rescue PulpcoreClient::ApiError => e
|
|
453
|
-
puts "Exception when calling TasksApi->
|
|
508
|
+
puts "Exception when calling TasksApi->tasks_read: #{e}"
|
|
454
509
|
end
|
|
455
510
|
```
|
|
456
511
|
|
|
@@ -477,9 +532,9 @@ Name | Type | Description | Notes
|
|
|
477
532
|
- **Accept**: application/json
|
|
478
533
|
|
|
479
534
|
|
|
480
|
-
##
|
|
535
|
+
## tasks_remove_role
|
|
481
536
|
|
|
482
|
-
> NestedRoleResponse
|
|
537
|
+
> NestedRoleResponse tasks_remove_role(task_href, nested_role)
|
|
483
538
|
|
|
484
539
|
|
|
485
540
|
|
|
@@ -502,10 +557,10 @@ task_href = 'task_href_example' # String |
|
|
|
502
557
|
nested_role = PulpcoreClient::NestedRole.new # NestedRole |
|
|
503
558
|
|
|
504
559
|
begin
|
|
505
|
-
result = api_instance.
|
|
560
|
+
result = api_instance.tasks_remove_role(task_href, nested_role)
|
|
506
561
|
p result
|
|
507
562
|
rescue PulpcoreClient::ApiError => e
|
|
508
|
-
puts "Exception when calling TasksApi->
|
|
563
|
+
puts "Exception when calling TasksApi->tasks_remove_role: #{e}"
|
|
509
564
|
end
|
|
510
565
|
```
|
|
511
566
|
|
|
@@ -530,58 +585,3 @@ Name | Type | Description | Notes
|
|
|
530
585
|
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
531
586
|
- **Accept**: application/json
|
|
532
587
|
|
|
533
|
-
|
|
534
|
-
## tasks_cancel
|
|
535
|
-
|
|
536
|
-
> TaskResponse tasks_cancel(task_href, patched_task_cancel)
|
|
537
|
-
|
|
538
|
-
Cancel a task
|
|
539
|
-
|
|
540
|
-
This operation cancels a task.
|
|
541
|
-
|
|
542
|
-
### Example
|
|
543
|
-
|
|
544
|
-
```ruby
|
|
545
|
-
# load the gem
|
|
546
|
-
require 'pulpcore_client'
|
|
547
|
-
# setup authorization
|
|
548
|
-
PulpcoreClient.configure do |config|
|
|
549
|
-
# Configure HTTP basic authorization: basicAuth
|
|
550
|
-
config.username = 'YOUR USERNAME'
|
|
551
|
-
config.password = 'YOUR PASSWORD'
|
|
552
|
-
end
|
|
553
|
-
|
|
554
|
-
api_instance = PulpcoreClient::TasksApi.new
|
|
555
|
-
task_href = 'task_href_example' # String |
|
|
556
|
-
patched_task_cancel = PulpcoreClient::PatchedTaskCancel.new # PatchedTaskCancel |
|
|
557
|
-
|
|
558
|
-
begin
|
|
559
|
-
#Cancel a task
|
|
560
|
-
result = api_instance.tasks_cancel(task_href, patched_task_cancel)
|
|
561
|
-
p result
|
|
562
|
-
rescue PulpcoreClient::ApiError => e
|
|
563
|
-
puts "Exception when calling TasksApi->tasks_cancel: #{e}"
|
|
564
|
-
end
|
|
565
|
-
```
|
|
566
|
-
|
|
567
|
-
### Parameters
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
Name | Type | Description | Notes
|
|
571
|
-
------------- | ------------- | ------------- | -------------
|
|
572
|
-
**task_href** | **String**| |
|
|
573
|
-
**patched_task_cancel** | [**PatchedTaskCancel**](PatchedTaskCancel.md)| |
|
|
574
|
-
|
|
575
|
-
### Return type
|
|
576
|
-
|
|
577
|
-
[**TaskResponse**](TaskResponse.md)
|
|
578
|
-
|
|
579
|
-
### Authorization
|
|
580
|
-
|
|
581
|
-
[basicAuth](../README.md#basicAuth)
|
|
582
|
-
|
|
583
|
-
### HTTP request headers
|
|
584
|
-
|
|
585
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
586
|
-
- **Accept**: application/json
|
|
587
|
-
|
data/docs/UploadsApi.md
CHANGED
|
@@ -1,25 +1,25 @@
|
|
|
1
1
|
# PulpcoreClient::UploadsApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *
|
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**
|
|
8
|
-
[**
|
|
9
|
-
[**
|
|
10
|
-
[**
|
|
11
|
-
[**
|
|
12
|
-
[**
|
|
13
|
-
[**
|
|
14
|
-
[**
|
|
15
|
-
[**
|
|
16
|
-
[**
|
|
7
|
+
[**uploads_add_role**](UploadsApi.md#uploads_add_role) | **POST** {upload_href}add_role/ |
|
|
8
|
+
[**uploads_commit**](UploadsApi.md#uploads_commit) | **POST** {upload_href}commit/ | Finish an Upload
|
|
9
|
+
[**uploads_create**](UploadsApi.md#uploads_create) | **POST** /pulp/api/v3/uploads/ | Create an upload
|
|
10
|
+
[**uploads_delete**](UploadsApi.md#uploads_delete) | **DELETE** {upload_href} | Delete an upload
|
|
11
|
+
[**uploads_list**](UploadsApi.md#uploads_list) | **GET** /pulp/api/v3/uploads/ | List uploads
|
|
12
|
+
[**uploads_list_roles**](UploadsApi.md#uploads_list_roles) | **GET** {upload_href}list_roles/ |
|
|
13
|
+
[**uploads_my_permissions**](UploadsApi.md#uploads_my_permissions) | **GET** {upload_href}my_permissions/ |
|
|
14
|
+
[**uploads_read**](UploadsApi.md#uploads_read) | **GET** {upload_href} | Inspect an upload
|
|
15
|
+
[**uploads_remove_role**](UploadsApi.md#uploads_remove_role) | **POST** {upload_href}remove_role/ |
|
|
16
|
+
[**uploads_update**](UploadsApi.md#uploads_update) | **PUT** {upload_href} | Upload a file chunk
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## uploads_add_role
|
|
21
21
|
|
|
22
|
-
> NestedRoleResponse
|
|
22
|
+
> NestedRoleResponse uploads_add_role(upload_href, upload)
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
@@ -42,10 +42,10 @@ upload_href = 'upload_href_example' # String |
|
|
|
42
42
|
upload = PulpcoreClient::Upload.new # Upload |
|
|
43
43
|
|
|
44
44
|
begin
|
|
45
|
-
result = api_instance.
|
|
45
|
+
result = api_instance.uploads_add_role(upload_href, upload)
|
|
46
46
|
p result
|
|
47
47
|
rescue PulpcoreClient::ApiError => e
|
|
48
|
-
puts "Exception when calling UploadsApi->
|
|
48
|
+
puts "Exception when calling UploadsApi->uploads_add_role: #{e}"
|
|
49
49
|
end
|
|
50
50
|
```
|
|
51
51
|
|
|
@@ -71,9 +71,9 @@ Name | Type | Description | Notes
|
|
|
71
71
|
- **Accept**: application/json
|
|
72
72
|
|
|
73
73
|
|
|
74
|
-
##
|
|
74
|
+
## uploads_commit
|
|
75
75
|
|
|
76
|
-
> AsyncOperationResponse
|
|
76
|
+
> AsyncOperationResponse uploads_commit(upload_href, upload_commit)
|
|
77
77
|
|
|
78
78
|
Finish an Upload
|
|
79
79
|
|
|
@@ -97,10 +97,10 @@ upload_commit = PulpcoreClient::UploadCommit.new # UploadCommit |
|
|
|
97
97
|
|
|
98
98
|
begin
|
|
99
99
|
#Finish an Upload
|
|
100
|
-
result = api_instance.
|
|
100
|
+
result = api_instance.uploads_commit(upload_href, upload_commit)
|
|
101
101
|
p result
|
|
102
102
|
rescue PulpcoreClient::ApiError => e
|
|
103
|
-
puts "Exception when calling UploadsApi->
|
|
103
|
+
puts "Exception when calling UploadsApi->uploads_commit: #{e}"
|
|
104
104
|
end
|
|
105
105
|
```
|
|
106
106
|
|
|
@@ -126,9 +126,9 @@ Name | Type | Description | Notes
|
|
|
126
126
|
- **Accept**: application/json
|
|
127
127
|
|
|
128
128
|
|
|
129
|
-
##
|
|
129
|
+
## uploads_create
|
|
130
130
|
|
|
131
|
-
> UploadResponse
|
|
131
|
+
> UploadResponse uploads_create(upload)
|
|
132
132
|
|
|
133
133
|
Create an upload
|
|
134
134
|
|
|
@@ -151,10 +151,10 @@ upload = PulpcoreClient::Upload.new # Upload |
|
|
|
151
151
|
|
|
152
152
|
begin
|
|
153
153
|
#Create an upload
|
|
154
|
-
result = api_instance.
|
|
154
|
+
result = api_instance.uploads_create(upload)
|
|
155
155
|
p result
|
|
156
156
|
rescue PulpcoreClient::ApiError => e
|
|
157
|
-
puts "Exception when calling UploadsApi->
|
|
157
|
+
puts "Exception when calling UploadsApi->uploads_create: #{e}"
|
|
158
158
|
end
|
|
159
159
|
```
|
|
160
160
|
|
|
@@ -179,9 +179,9 @@ Name | Type | Description | Notes
|
|
|
179
179
|
- **Accept**: application/json
|
|
180
180
|
|
|
181
181
|
|
|
182
|
-
##
|
|
182
|
+
## uploads_delete
|
|
183
183
|
|
|
184
|
-
>
|
|
184
|
+
> uploads_delete(upload_href)
|
|
185
185
|
|
|
186
186
|
Delete an upload
|
|
187
187
|
|
|
@@ -204,9 +204,9 @@ upload_href = 'upload_href_example' # String |
|
|
|
204
204
|
|
|
205
205
|
begin
|
|
206
206
|
#Delete an upload
|
|
207
|
-
api_instance.
|
|
207
|
+
api_instance.uploads_delete(upload_href)
|
|
208
208
|
rescue PulpcoreClient::ApiError => e
|
|
209
|
-
puts "Exception when calling UploadsApi->
|
|
209
|
+
puts "Exception when calling UploadsApi->uploads_delete: #{e}"
|
|
210
210
|
end
|
|
211
211
|
```
|
|
212
212
|
|
|
@@ -231,9 +231,9 @@ nil (empty response body)
|
|
|
231
231
|
- **Accept**: Not defined
|
|
232
232
|
|
|
233
233
|
|
|
234
|
-
##
|
|
234
|
+
## uploads_list
|
|
235
235
|
|
|
236
|
-
> PaginatedUploadResponseList
|
|
236
|
+
> PaginatedUploadResponseList uploads_list(opts)
|
|
237
237
|
|
|
238
238
|
List uploads
|
|
239
239
|
|
|
@@ -266,10 +266,10 @@ opts = {
|
|
|
266
266
|
|
|
267
267
|
begin
|
|
268
268
|
#List uploads
|
|
269
|
-
result = api_instance.
|
|
269
|
+
result = api_instance.uploads_list(opts)
|
|
270
270
|
p result
|
|
271
271
|
rescue PulpcoreClient::ApiError => e
|
|
272
|
-
puts "Exception when calling UploadsApi->
|
|
272
|
+
puts "Exception when calling UploadsApi->uploads_list: #{e}"
|
|
273
273
|
end
|
|
274
274
|
```
|
|
275
275
|
|
|
@@ -302,9 +302,9 @@ Name | Type | Description | Notes
|
|
|
302
302
|
- **Accept**: application/json
|
|
303
303
|
|
|
304
304
|
|
|
305
|
-
##
|
|
305
|
+
## uploads_list_roles
|
|
306
306
|
|
|
307
|
-
> ObjectRolesResponse
|
|
307
|
+
> ObjectRolesResponse uploads_list_roles(upload_href, opts)
|
|
308
308
|
|
|
309
309
|
|
|
310
310
|
|
|
@@ -330,10 +330,10 @@ opts = {
|
|
|
330
330
|
}
|
|
331
331
|
|
|
332
332
|
begin
|
|
333
|
-
result = api_instance.
|
|
333
|
+
result = api_instance.uploads_list_roles(upload_href, opts)
|
|
334
334
|
p result
|
|
335
335
|
rescue PulpcoreClient::ApiError => e
|
|
336
|
-
puts "Exception when calling UploadsApi->
|
|
336
|
+
puts "Exception when calling UploadsApi->uploads_list_roles: #{e}"
|
|
337
337
|
end
|
|
338
338
|
```
|
|
339
339
|
|
|
@@ -360,9 +360,9 @@ Name | Type | Description | Notes
|
|
|
360
360
|
- **Accept**: application/json
|
|
361
361
|
|
|
362
362
|
|
|
363
|
-
##
|
|
363
|
+
## uploads_my_permissions
|
|
364
364
|
|
|
365
|
-
> MyPermissionsResponse
|
|
365
|
+
> MyPermissionsResponse uploads_my_permissions(upload_href, opts)
|
|
366
366
|
|
|
367
367
|
|
|
368
368
|
|
|
@@ -388,10 +388,10 @@ opts = {
|
|
|
388
388
|
}
|
|
389
389
|
|
|
390
390
|
begin
|
|
391
|
-
result = api_instance.
|
|
391
|
+
result = api_instance.uploads_my_permissions(upload_href, opts)
|
|
392
392
|
p result
|
|
393
393
|
rescue PulpcoreClient::ApiError => e
|
|
394
|
-
puts "Exception when calling UploadsApi->
|
|
394
|
+
puts "Exception when calling UploadsApi->uploads_my_permissions: #{e}"
|
|
395
395
|
end
|
|
396
396
|
```
|
|
397
397
|
|
|
@@ -418,9 +418,9 @@ Name | Type | Description | Notes
|
|
|
418
418
|
- **Accept**: application/json
|
|
419
419
|
|
|
420
420
|
|
|
421
|
-
##
|
|
421
|
+
## uploads_read
|
|
422
422
|
|
|
423
|
-
> UploadDetailResponse
|
|
423
|
+
> UploadDetailResponse uploads_read(upload_href, opts)
|
|
424
424
|
|
|
425
425
|
Inspect an upload
|
|
426
426
|
|
|
@@ -447,10 +447,10 @@ opts = {
|
|
|
447
447
|
|
|
448
448
|
begin
|
|
449
449
|
#Inspect an upload
|
|
450
|
-
result = api_instance.
|
|
450
|
+
result = api_instance.uploads_read(upload_href, opts)
|
|
451
451
|
p result
|
|
452
452
|
rescue PulpcoreClient::ApiError => e
|
|
453
|
-
puts "Exception when calling UploadsApi->
|
|
453
|
+
puts "Exception when calling UploadsApi->uploads_read: #{e}"
|
|
454
454
|
end
|
|
455
455
|
```
|
|
456
456
|
|
|
@@ -477,9 +477,9 @@ Name | Type | Description | Notes
|
|
|
477
477
|
- **Accept**: application/json
|
|
478
478
|
|
|
479
479
|
|
|
480
|
-
##
|
|
480
|
+
## uploads_remove_role
|
|
481
481
|
|
|
482
|
-
> NestedRoleResponse
|
|
482
|
+
> NestedRoleResponse uploads_remove_role(upload_href, upload)
|
|
483
483
|
|
|
484
484
|
|
|
485
485
|
|
|
@@ -502,10 +502,10 @@ upload_href = 'upload_href_example' # String |
|
|
|
502
502
|
upload = PulpcoreClient::Upload.new # Upload |
|
|
503
503
|
|
|
504
504
|
begin
|
|
505
|
-
result = api_instance.
|
|
505
|
+
result = api_instance.uploads_remove_role(upload_href, upload)
|
|
506
506
|
p result
|
|
507
507
|
rescue PulpcoreClient::ApiError => e
|
|
508
|
-
puts "Exception when calling UploadsApi->
|
|
508
|
+
puts "Exception when calling UploadsApi->uploads_remove_role: #{e}"
|
|
509
509
|
end
|
|
510
510
|
```
|
|
511
511
|
|
|
@@ -531,9 +531,9 @@ Name | Type | Description | Notes
|
|
|
531
531
|
- **Accept**: application/json
|
|
532
532
|
|
|
533
533
|
|
|
534
|
-
##
|
|
534
|
+
## uploads_update
|
|
535
535
|
|
|
536
|
-
> UploadResponse
|
|
536
|
+
> UploadResponse uploads_update(content_range, upload_href, file, opts)
|
|
537
537
|
|
|
538
538
|
Upload a file chunk
|
|
539
539
|
|
|
@@ -561,10 +561,10 @@ opts = {
|
|
|
561
561
|
|
|
562
562
|
begin
|
|
563
563
|
#Upload a file chunk
|
|
564
|
-
result = api_instance.
|
|
564
|
+
result = api_instance.uploads_update(content_range, upload_href, file, opts)
|
|
565
565
|
p result
|
|
566
566
|
rescue PulpcoreClient::ApiError => e
|
|
567
|
-
puts "Exception when calling UploadsApi->
|
|
567
|
+
puts "Exception when calling UploadsApi->uploads_update: #{e}"
|
|
568
568
|
end
|
|
569
569
|
```
|
|
570
570
|
|