pulpcore_client 3.28.30 → 3.28.32
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 +154 -156
- data/docs/AccessPoliciesApi.md +25 -25
- data/docs/ArtifactDistributionResponse.md +9 -9
- data/docs/ArtifactsApi.md +20 -20
- data/docs/ContentApi.md +5 -5
- data/docs/ContentguardsApi.md +5 -5
- data/docs/ContentguardsContentRedirectApi.md +50 -50
- data/docs/ContentguardsRbacApi.md +50 -50
- data/docs/DistributionsApi.md +5 -5
- data/docs/DistributionsArtifactsApi.md +10 -10
- data/docs/DomainsApi.md +30 -30
- data/docs/ExportersFilesystemApi.md +30 -30
- data/docs/ExportersFilesystemExportsApi.md +20 -20
- data/docs/ExportersPulpApi.md +30 -30
- data/docs/ExportersPulpExportsApi.md +20 -20
- data/docs/GroupsApi.md +50 -50
- data/docs/GroupsRolesApi.md +20 -20
- data/docs/GroupsUsersApi.md +15 -15
- data/docs/ImportersPulpApi.md +30 -30
- data/docs/ImportersPulpImportsApi.md +20 -20
- data/docs/OrphansApi.md +5 -5
- data/docs/OrphansCleanupApi.md +5 -5
- data/docs/PublicationsApi.md +5 -5
- data/docs/RemotesApi.md +5 -5
- data/docs/RepairApi.md +5 -5
- data/docs/RepositoriesApi.md +5 -5
- data/docs/RepositoriesReclaimSpaceApi.md +5 -5
- data/docs/RepositoryVersionsApi.md +5 -5
- data/docs/RolesApi.md +30 -30
- data/docs/SigningServicesApi.md +10 -10
- data/docs/TaskGroupsApi.md +10 -10
- data/docs/TaskSchedulesApi.md +30 -30
- data/docs/TasksApi.md +95 -95
- data/docs/UploadsApi.md +50 -50
- data/docs/UpstreamPulpsApi.md +35 -35
- data/docs/UsersApi.md +30 -30
- data/docs/UsersRolesApi.md +20 -20
- data/docs/WorkersApi.md +10 -10
- 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/domains_api.rb +37 -37
- 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/upstream_pulps_api.rb +43 -43
- 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/models/artifact_distribution_response.rb +39 -39
- data/lib/pulpcore_client/version.rb +1 -1
- data/lib/pulpcore_client.rb +0 -2
- 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/domains_api_spec.rb +12 -12
- 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/upstream_pulps_api_spec.rb +14 -14
- 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/models/artifact_distribution_response_spec.rb +6 -6
- metadata +140 -148
- data/docs/DocsApiJsonApi.md +0 -61
- data/docs/DocsApiYamlApi.md +0 -61
- data/lib/pulpcore_client/api/docs_api_json_api.rb +0 -89
- data/lib/pulpcore_client/api/docs_api_yaml_api.rb +0 -89
- data/spec/api/docs_api_json_api_spec.rb +0 -48
- data/spec/api/docs_api_yaml_api_spec.rb +0 -48
data/docs/TasksApi.md
CHANGED
|
@@ -4,21 +4,21 @@ All URIs are relative to *http://localhost:24817*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**
|
|
7
|
+
[**add_role**](TasksApi.md#add_role) | **POST** {task_href}add_role/ |
|
|
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/ |
|
|
8
15
|
[**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
|
+
## add_role
|
|
20
20
|
|
|
21
|
-
> NestedRoleResponse
|
|
21
|
+
> NestedRoleResponse 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.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->add_role: #{e}"
|
|
48
48
|
end
|
|
49
49
|
```
|
|
50
50
|
|
|
@@ -70,64 +70,9 @@ Name | Type | Description | Notes
|
|
|
70
70
|
- **Accept**: application/json
|
|
71
71
|
|
|
72
72
|
|
|
73
|
-
##
|
|
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
|
|
73
|
+
## delete
|
|
129
74
|
|
|
130
|
-
>
|
|
75
|
+
> delete(task_href)
|
|
131
76
|
|
|
132
77
|
Delete a task
|
|
133
78
|
|
|
@@ -150,9 +95,9 @@ task_href = 'task_href_example' # String |
|
|
|
150
95
|
|
|
151
96
|
begin
|
|
152
97
|
#Delete a task
|
|
153
|
-
api_instance.
|
|
98
|
+
api_instance.delete(task_href)
|
|
154
99
|
rescue PulpcoreClient::ApiError => e
|
|
155
|
-
puts "Exception when calling TasksApi->
|
|
100
|
+
puts "Exception when calling TasksApi->delete: #{e}"
|
|
156
101
|
end
|
|
157
102
|
```
|
|
158
103
|
|
|
@@ -177,9 +122,9 @@ nil (empty response body)
|
|
|
177
122
|
- **Accept**: Not defined
|
|
178
123
|
|
|
179
124
|
|
|
180
|
-
##
|
|
125
|
+
## list
|
|
181
126
|
|
|
182
|
-
> PaginatedTaskResponseList
|
|
127
|
+
> PaginatedTaskResponseList list(opts)
|
|
183
128
|
|
|
184
129
|
List tasks
|
|
185
130
|
|
|
@@ -242,10 +187,10 @@ opts = {
|
|
|
242
187
|
|
|
243
188
|
begin
|
|
244
189
|
#List tasks
|
|
245
|
-
result = api_instance.
|
|
190
|
+
result = api_instance.list(opts)
|
|
246
191
|
p result
|
|
247
192
|
rescue PulpcoreClient::ApiError => e
|
|
248
|
-
puts "Exception when calling TasksApi->
|
|
193
|
+
puts "Exception when calling TasksApi->list: #{e}"
|
|
249
194
|
end
|
|
250
195
|
```
|
|
251
196
|
|
|
@@ -308,9 +253,9 @@ Name | Type | Description | Notes
|
|
|
308
253
|
- **Accept**: application/json
|
|
309
254
|
|
|
310
255
|
|
|
311
|
-
##
|
|
256
|
+
## list_roles
|
|
312
257
|
|
|
313
|
-
> ObjectRolesResponse
|
|
258
|
+
> ObjectRolesResponse list_roles(task_href, opts)
|
|
314
259
|
|
|
315
260
|
|
|
316
261
|
|
|
@@ -336,10 +281,10 @@ opts = {
|
|
|
336
281
|
}
|
|
337
282
|
|
|
338
283
|
begin
|
|
339
|
-
result = api_instance.
|
|
284
|
+
result = api_instance.list_roles(task_href, opts)
|
|
340
285
|
p result
|
|
341
286
|
rescue PulpcoreClient::ApiError => e
|
|
342
|
-
puts "Exception when calling TasksApi->
|
|
287
|
+
puts "Exception when calling TasksApi->list_roles: #{e}"
|
|
343
288
|
end
|
|
344
289
|
```
|
|
345
290
|
|
|
@@ -366,9 +311,9 @@ Name | Type | Description | Notes
|
|
|
366
311
|
- **Accept**: application/json
|
|
367
312
|
|
|
368
313
|
|
|
369
|
-
##
|
|
314
|
+
## my_permissions
|
|
370
315
|
|
|
371
|
-
> MyPermissionsResponse
|
|
316
|
+
> MyPermissionsResponse my_permissions(task_href, opts)
|
|
372
317
|
|
|
373
318
|
|
|
374
319
|
|
|
@@ -394,10 +339,10 @@ opts = {
|
|
|
394
339
|
}
|
|
395
340
|
|
|
396
341
|
begin
|
|
397
|
-
result = api_instance.
|
|
342
|
+
result = api_instance.my_permissions(task_href, opts)
|
|
398
343
|
p result
|
|
399
344
|
rescue PulpcoreClient::ApiError => e
|
|
400
|
-
puts "Exception when calling TasksApi->
|
|
345
|
+
puts "Exception when calling TasksApi->my_permissions: #{e}"
|
|
401
346
|
end
|
|
402
347
|
```
|
|
403
348
|
|
|
@@ -424,9 +369,9 @@ Name | Type | Description | Notes
|
|
|
424
369
|
- **Accept**: application/json
|
|
425
370
|
|
|
426
371
|
|
|
427
|
-
##
|
|
372
|
+
## purge
|
|
428
373
|
|
|
429
|
-
> AsyncOperationResponse
|
|
374
|
+
> AsyncOperationResponse purge(purge)
|
|
430
375
|
|
|
431
376
|
Purge Completed Tasks
|
|
432
377
|
|
|
@@ -449,10 +394,10 @@ purge = PulpcoreClient::Purge.new # Purge |
|
|
|
449
394
|
|
|
450
395
|
begin
|
|
451
396
|
#Purge Completed Tasks
|
|
452
|
-
result = api_instance.
|
|
397
|
+
result = api_instance.purge(purge)
|
|
453
398
|
p result
|
|
454
399
|
rescue PulpcoreClient::ApiError => e
|
|
455
|
-
puts "Exception when calling TasksApi->
|
|
400
|
+
puts "Exception when calling TasksApi->purge: #{e}"
|
|
456
401
|
end
|
|
457
402
|
```
|
|
458
403
|
|
|
@@ -477,9 +422,9 @@ Name | Type | Description | Notes
|
|
|
477
422
|
- **Accept**: application/json
|
|
478
423
|
|
|
479
424
|
|
|
480
|
-
##
|
|
425
|
+
## read
|
|
481
426
|
|
|
482
|
-
> TaskResponse
|
|
427
|
+
> TaskResponse read(task_href, opts)
|
|
483
428
|
|
|
484
429
|
Inspect a task
|
|
485
430
|
|
|
@@ -506,10 +451,10 @@ opts = {
|
|
|
506
451
|
|
|
507
452
|
begin
|
|
508
453
|
#Inspect a task
|
|
509
|
-
result = api_instance.
|
|
454
|
+
result = api_instance.read(task_href, opts)
|
|
510
455
|
p result
|
|
511
456
|
rescue PulpcoreClient::ApiError => e
|
|
512
|
-
puts "Exception when calling TasksApi->
|
|
457
|
+
puts "Exception when calling TasksApi->read: #{e}"
|
|
513
458
|
end
|
|
514
459
|
```
|
|
515
460
|
|
|
@@ -536,9 +481,9 @@ Name | Type | Description | Notes
|
|
|
536
481
|
- **Accept**: application/json
|
|
537
482
|
|
|
538
483
|
|
|
539
|
-
##
|
|
484
|
+
## remove_role
|
|
540
485
|
|
|
541
|
-
> NestedRoleResponse
|
|
486
|
+
> NestedRoleResponse remove_role(task_href, nested_role)
|
|
542
487
|
|
|
543
488
|
|
|
544
489
|
|
|
@@ -561,10 +506,10 @@ task_href = 'task_href_example' # String |
|
|
|
561
506
|
nested_role = PulpcoreClient::NestedRole.new # NestedRole |
|
|
562
507
|
|
|
563
508
|
begin
|
|
564
|
-
result = api_instance.
|
|
509
|
+
result = api_instance.remove_role(task_href, nested_role)
|
|
565
510
|
p result
|
|
566
511
|
rescue PulpcoreClient::ApiError => e
|
|
567
|
-
puts "Exception when calling TasksApi->
|
|
512
|
+
puts "Exception when calling TasksApi->remove_role: #{e}"
|
|
568
513
|
end
|
|
569
514
|
```
|
|
570
515
|
|
|
@@ -589,3 +534,58 @@ Name | Type | Description | Notes
|
|
|
589
534
|
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
590
535
|
- **Accept**: application/json
|
|
591
536
|
|
|
537
|
+
|
|
538
|
+
## tasks_cancel
|
|
539
|
+
|
|
540
|
+
> TaskResponse tasks_cancel(task_href, patched_task_cancel)
|
|
541
|
+
|
|
542
|
+
Cancel a task
|
|
543
|
+
|
|
544
|
+
This operation cancels a task.
|
|
545
|
+
|
|
546
|
+
### Example
|
|
547
|
+
|
|
548
|
+
```ruby
|
|
549
|
+
# load the gem
|
|
550
|
+
require 'pulpcore_client'
|
|
551
|
+
# setup authorization
|
|
552
|
+
PulpcoreClient.configure do |config|
|
|
553
|
+
# Configure HTTP basic authorization: basicAuth
|
|
554
|
+
config.username = 'YOUR USERNAME'
|
|
555
|
+
config.password = 'YOUR PASSWORD'
|
|
556
|
+
end
|
|
557
|
+
|
|
558
|
+
api_instance = PulpcoreClient::TasksApi.new
|
|
559
|
+
task_href = 'task_href_example' # String |
|
|
560
|
+
patched_task_cancel = PulpcoreClient::PatchedTaskCancel.new # PatchedTaskCancel |
|
|
561
|
+
|
|
562
|
+
begin
|
|
563
|
+
#Cancel a task
|
|
564
|
+
result = api_instance.tasks_cancel(task_href, patched_task_cancel)
|
|
565
|
+
p result
|
|
566
|
+
rescue PulpcoreClient::ApiError => e
|
|
567
|
+
puts "Exception when calling TasksApi->tasks_cancel: #{e}"
|
|
568
|
+
end
|
|
569
|
+
```
|
|
570
|
+
|
|
571
|
+
### Parameters
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
Name | Type | Description | Notes
|
|
575
|
+
------------- | ------------- | ------------- | -------------
|
|
576
|
+
**task_href** | **String**| |
|
|
577
|
+
**patched_task_cancel** | [**PatchedTaskCancel**](PatchedTaskCancel.md)| |
|
|
578
|
+
|
|
579
|
+
### Return type
|
|
580
|
+
|
|
581
|
+
[**TaskResponse**](TaskResponse.md)
|
|
582
|
+
|
|
583
|
+
### Authorization
|
|
584
|
+
|
|
585
|
+
[basicAuth](../README.md#basicAuth)
|
|
586
|
+
|
|
587
|
+
### HTTP request headers
|
|
588
|
+
|
|
589
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
590
|
+
- **Accept**: application/json
|
|
591
|
+
|
data/docs/UploadsApi.md
CHANGED
|
@@ -4,22 +4,22 @@ 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
|
+
[**add_role**](UploadsApi.md#add_role) | **POST** {upload_href}add_role/ |
|
|
8
|
+
[**commit**](UploadsApi.md#commit) | **POST** {upload_href}commit/ | Finish an Upload
|
|
9
|
+
[**create**](UploadsApi.md#create) | **POST** /pulp/api/v3/uploads/ | Create an upload
|
|
10
|
+
[**delete**](UploadsApi.md#delete) | **DELETE** {upload_href} | Delete an upload
|
|
11
|
+
[**list**](UploadsApi.md#list) | **GET** /pulp/api/v3/uploads/ | List uploads
|
|
12
|
+
[**list_roles**](UploadsApi.md#list_roles) | **GET** {upload_href}list_roles/ |
|
|
13
|
+
[**my_permissions**](UploadsApi.md#my_permissions) | **GET** {upload_href}my_permissions/ |
|
|
14
|
+
[**read**](UploadsApi.md#read) | **GET** {upload_href} | Inspect an upload
|
|
15
|
+
[**remove_role**](UploadsApi.md#remove_role) | **POST** {upload_href}remove_role/ |
|
|
16
|
+
[**update**](UploadsApi.md#update) | **PUT** {upload_href} | Upload a file chunk
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## add_role
|
|
21
21
|
|
|
22
|
-
> NestedRoleResponse
|
|
22
|
+
> NestedRoleResponse 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.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->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
|
+
## commit
|
|
75
75
|
|
|
76
|
-
> AsyncOperationResponse
|
|
76
|
+
> AsyncOperationResponse 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.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->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
|
+
## create
|
|
130
130
|
|
|
131
|
-
> UploadResponse
|
|
131
|
+
> UploadResponse 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.create(upload)
|
|
155
155
|
p result
|
|
156
156
|
rescue PulpcoreClient::ApiError => e
|
|
157
|
-
puts "Exception when calling UploadsApi->
|
|
157
|
+
puts "Exception when calling UploadsApi->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
|
+
## delete
|
|
183
183
|
|
|
184
|
-
>
|
|
184
|
+
> 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.delete(upload_href)
|
|
208
208
|
rescue PulpcoreClient::ApiError => e
|
|
209
|
-
puts "Exception when calling UploadsApi->
|
|
209
|
+
puts "Exception when calling UploadsApi->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
|
+
## list
|
|
235
235
|
|
|
236
|
-
> PaginatedUploadResponseList
|
|
236
|
+
> PaginatedUploadResponseList list(opts)
|
|
237
237
|
|
|
238
238
|
List uploads
|
|
239
239
|
|
|
@@ -268,10 +268,10 @@ opts = {
|
|
|
268
268
|
|
|
269
269
|
begin
|
|
270
270
|
#List uploads
|
|
271
|
-
result = api_instance.
|
|
271
|
+
result = api_instance.list(opts)
|
|
272
272
|
p result
|
|
273
273
|
rescue PulpcoreClient::ApiError => e
|
|
274
|
-
puts "Exception when calling UploadsApi->
|
|
274
|
+
puts "Exception when calling UploadsApi->list: #{e}"
|
|
275
275
|
end
|
|
276
276
|
```
|
|
277
277
|
|
|
@@ -306,9 +306,9 @@ Name | Type | Description | Notes
|
|
|
306
306
|
- **Accept**: application/json
|
|
307
307
|
|
|
308
308
|
|
|
309
|
-
##
|
|
309
|
+
## list_roles
|
|
310
310
|
|
|
311
|
-
> ObjectRolesResponse
|
|
311
|
+
> ObjectRolesResponse list_roles(upload_href, opts)
|
|
312
312
|
|
|
313
313
|
|
|
314
314
|
|
|
@@ -334,10 +334,10 @@ opts = {
|
|
|
334
334
|
}
|
|
335
335
|
|
|
336
336
|
begin
|
|
337
|
-
result = api_instance.
|
|
337
|
+
result = api_instance.list_roles(upload_href, opts)
|
|
338
338
|
p result
|
|
339
339
|
rescue PulpcoreClient::ApiError => e
|
|
340
|
-
puts "Exception when calling UploadsApi->
|
|
340
|
+
puts "Exception when calling UploadsApi->list_roles: #{e}"
|
|
341
341
|
end
|
|
342
342
|
```
|
|
343
343
|
|
|
@@ -364,9 +364,9 @@ Name | Type | Description | Notes
|
|
|
364
364
|
- **Accept**: application/json
|
|
365
365
|
|
|
366
366
|
|
|
367
|
-
##
|
|
367
|
+
## my_permissions
|
|
368
368
|
|
|
369
|
-
> MyPermissionsResponse
|
|
369
|
+
> MyPermissionsResponse my_permissions(upload_href, opts)
|
|
370
370
|
|
|
371
371
|
|
|
372
372
|
|
|
@@ -392,10 +392,10 @@ opts = {
|
|
|
392
392
|
}
|
|
393
393
|
|
|
394
394
|
begin
|
|
395
|
-
result = api_instance.
|
|
395
|
+
result = api_instance.my_permissions(upload_href, opts)
|
|
396
396
|
p result
|
|
397
397
|
rescue PulpcoreClient::ApiError => e
|
|
398
|
-
puts "Exception when calling UploadsApi->
|
|
398
|
+
puts "Exception when calling UploadsApi->my_permissions: #{e}"
|
|
399
399
|
end
|
|
400
400
|
```
|
|
401
401
|
|
|
@@ -422,9 +422,9 @@ Name | Type | Description | Notes
|
|
|
422
422
|
- **Accept**: application/json
|
|
423
423
|
|
|
424
424
|
|
|
425
|
-
##
|
|
425
|
+
## read
|
|
426
426
|
|
|
427
|
-
> UploadDetailResponse
|
|
427
|
+
> UploadDetailResponse read(upload_href, opts)
|
|
428
428
|
|
|
429
429
|
Inspect an upload
|
|
430
430
|
|
|
@@ -451,10 +451,10 @@ opts = {
|
|
|
451
451
|
|
|
452
452
|
begin
|
|
453
453
|
#Inspect an upload
|
|
454
|
-
result = api_instance.
|
|
454
|
+
result = api_instance.read(upload_href, opts)
|
|
455
455
|
p result
|
|
456
456
|
rescue PulpcoreClient::ApiError => e
|
|
457
|
-
puts "Exception when calling UploadsApi->
|
|
457
|
+
puts "Exception when calling UploadsApi->read: #{e}"
|
|
458
458
|
end
|
|
459
459
|
```
|
|
460
460
|
|
|
@@ -481,9 +481,9 @@ Name | Type | Description | Notes
|
|
|
481
481
|
- **Accept**: application/json
|
|
482
482
|
|
|
483
483
|
|
|
484
|
-
##
|
|
484
|
+
## remove_role
|
|
485
485
|
|
|
486
|
-
> NestedRoleResponse
|
|
486
|
+
> NestedRoleResponse remove_role(upload_href, upload)
|
|
487
487
|
|
|
488
488
|
|
|
489
489
|
|
|
@@ -506,10 +506,10 @@ upload_href = 'upload_href_example' # String |
|
|
|
506
506
|
upload = PulpcoreClient::Upload.new # Upload |
|
|
507
507
|
|
|
508
508
|
begin
|
|
509
|
-
result = api_instance.
|
|
509
|
+
result = api_instance.remove_role(upload_href, upload)
|
|
510
510
|
p result
|
|
511
511
|
rescue PulpcoreClient::ApiError => e
|
|
512
|
-
puts "Exception when calling UploadsApi->
|
|
512
|
+
puts "Exception when calling UploadsApi->remove_role: #{e}"
|
|
513
513
|
end
|
|
514
514
|
```
|
|
515
515
|
|
|
@@ -535,9 +535,9 @@ Name | Type | Description | Notes
|
|
|
535
535
|
- **Accept**: application/json
|
|
536
536
|
|
|
537
537
|
|
|
538
|
-
##
|
|
538
|
+
## update
|
|
539
539
|
|
|
540
|
-
> UploadResponse
|
|
540
|
+
> UploadResponse update(content_range, upload_href, file, opts)
|
|
541
541
|
|
|
542
542
|
Upload a file chunk
|
|
543
543
|
|
|
@@ -565,10 +565,10 @@ opts = {
|
|
|
565
565
|
|
|
566
566
|
begin
|
|
567
567
|
#Upload a file chunk
|
|
568
|
-
result = api_instance.
|
|
568
|
+
result = api_instance.update(content_range, upload_href, file, opts)
|
|
569
569
|
p result
|
|
570
570
|
rescue PulpcoreClient::ApiError => e
|
|
571
|
-
puts "Exception when calling UploadsApi->
|
|
571
|
+
puts "Exception when calling UploadsApi->update: #{e}"
|
|
572
572
|
end
|
|
573
573
|
```
|
|
574
574
|
|