pulpcore_client 3.0.0rc2 → 3.0.0rc3
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/Gemfile.lock +1 -1
- data/README.md +43 -37
- data/docs/ArtifactsApi.md +20 -20
- data/docs/ContentAppStatus.md +19 -0
- data/docs/DatabaseConnection.md +17 -0
- data/docs/OrphansApi.md +5 -5
- data/docs/ProgressReport.md +1 -3
- data/docs/RedisConnection.md +17 -0
- data/docs/RepositoriesApi.md +30 -278
- data/docs/RepositoriesVersionsApi.md +256 -0
- data/docs/RepositoryVersionCreate.md +2 -2
- data/docs/Status.md +27 -0
- data/docs/StatusApi.md +8 -7
- data/docs/TaskCancel.md +17 -0
- data/docs/TasksApi.md +71 -71
- data/docs/Upload.md +6 -8
- data/docs/UploadCommit.md +17 -0
- data/docs/UploadsApi.md +66 -106
- data/docs/Version.md +19 -0
- data/docs/WorkersApi.md +10 -10
- data/lib/pulpcore_client/api/artifacts_api.rb +47 -23
- data/lib/pulpcore_client/api/orphans_api.rb +6 -6
- data/lib/pulpcore_client/api/repositories_api.rb +38 -338
- data/lib/pulpcore_client/api/repositories_versions_api.rb +322 -0
- data/lib/pulpcore_client/api/status_api.rb +12 -10
- data/lib/pulpcore_client/api/tasks_api.rb +88 -88
- data/lib/pulpcore_client/api/uploads_api.rb +105 -154
- data/lib/pulpcore_client/api/workers_api.rb +12 -12
- data/lib/pulpcore_client/api_client.rb +1 -1
- data/lib/pulpcore_client/api_error.rb +1 -1
- data/lib/pulpcore_client/configuration.rb +1 -1
- data/lib/pulpcore_client/models/artifact.rb +91 -1
- data/lib/pulpcore_client/models/async_operation_response.rb +1 -1
- data/lib/pulpcore_client/models/content_app_status.rb +223 -0
- data/lib/pulpcore_client/models/database_connection.rb +203 -0
- data/lib/pulpcore_client/models/inline_response200.rb +1 -1
- data/lib/pulpcore_client/models/inline_response2001.rb +1 -1
- data/lib/pulpcore_client/models/inline_response2002.rb +1 -1
- data/lib/pulpcore_client/models/inline_response2003.rb +1 -1
- data/lib/pulpcore_client/models/inline_response2004.rb +1 -1
- data/lib/pulpcore_client/models/inline_response2005.rb +1 -1
- data/lib/pulpcore_client/models/progress_report.rb +20 -15
- data/lib/pulpcore_client/models/redis_connection.rb +203 -0
- data/lib/pulpcore_client/models/repository.rb +16 -1
- data/lib/pulpcore_client/models/repository_version.rb +1 -1
- data/lib/pulpcore_client/models/repository_version_create.rb +3 -13
- data/lib/pulpcore_client/models/status.rb +283 -0
- data/lib/pulpcore_client/models/task.rb +1 -1
- data/lib/pulpcore_client/models/task_cancel.rb +221 -0
- data/lib/pulpcore_client/models/upload.rb +26 -52
- data/lib/pulpcore_client/models/upload_commit.rb +221 -0
- data/lib/pulpcore_client/models/version.rb +256 -0
- data/lib/pulpcore_client/models/worker.rb +2 -1
- data/lib/pulpcore_client/version.rb +2 -2
- data/lib/pulpcore_client.rb +9 -1
- data/pulpcore_client.gemspec +1 -1
- data/spec/api/artifacts_api_spec.rb +9 -9
- data/spec/api/orphans_api_spec.rb +3 -3
- data/spec/api/repositories_api_spec.rb +13 -76
- data/spec/api/repositories_versions_api_spec.rb +98 -0
- data/spec/api/status_api_spec.rb +4 -4
- data/spec/api/tasks_api_spec.rb +20 -20
- data/spec/api/uploads_api_spec.rb +32 -37
- data/spec/api/workers_api_spec.rb +5 -5
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/artifact_spec.rb +1 -1
- data/spec/models/async_operation_response_spec.rb +1 -1
- data/spec/models/content_app_status_spec.rb +47 -0
- data/spec/models/database_connection_spec.rb +41 -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 +1 -1
- data/spec/models/inline_response2005_spec.rb +1 -1
- data/spec/models/inline_response200_spec.rb +1 -1
- data/spec/models/progress_report_spec.rb +1 -7
- data/spec/models/redis_connection_spec.rb +41 -0
- data/spec/models/repository_spec.rb +1 -1
- data/spec/models/repository_version_create_spec.rb +1 -1
- data/spec/models/repository_version_spec.rb +1 -1
- data/spec/models/status_spec.rb +71 -0
- data/spec/models/task_cancel_spec.rb +41 -0
- data/spec/models/task_spec.rb +1 -1
- data/spec/models/upload_commit_spec.rb +41 -0
- data/spec/models/upload_spec.rb +4 -10
- data/spec/models/version_spec.rb +47 -0
- data/spec/models/worker_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +34 -2
data/docs/Status.md
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# PulpcoreClient::Status
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**versions** | [**Array<Version>**](Version.md) | Version information of Pulp components |
|
|
8
|
+
**online_workers** | [**Array<Worker>**](Worker.md) | List of online workers known to the application. An online worker is actively heartbeating and can respond to new work |
|
|
9
|
+
**missing_workers** | [**Array<Worker>**](Worker.md) | List of missing workers known to the application. A missing worker is a worker that was online, but has now stopped heartbeating and has potentially died |
|
|
10
|
+
**online_content_apps** | [**Array<ContentAppStatus>**](ContentAppStatus.md) | List of online content apps known to the application. An online worker is actively heartbeating |
|
|
11
|
+
**database_connection** | [**DatabaseConnection**](DatabaseConnection.md) | |
|
|
12
|
+
**redis_connection** | [**RedisConnection**](RedisConnection.md) | |
|
|
13
|
+
|
|
14
|
+
## Code Sample
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'PulpcoreClient'
|
|
18
|
+
|
|
19
|
+
instance = PulpcoreClient::Status.new(versions: null,
|
|
20
|
+
online_workers: null,
|
|
21
|
+
missing_workers: null,
|
|
22
|
+
online_content_apps: null,
|
|
23
|
+
database_connection: null,
|
|
24
|
+
redis_connection: null)
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
|
data/docs/StatusApi.md
CHANGED
|
@@ -4,13 +4,13 @@ All URIs are relative to *http://localhost:24817*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**
|
|
7
|
+
[**status_read**](StatusApi.md#status_read) | **GET** /pulp/api/v3/status/ | Inspect status of Pulp
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## status_read
|
|
12
12
|
|
|
13
|
-
>
|
|
13
|
+
> Status status_read
|
|
14
14
|
|
|
15
15
|
Inspect status of Pulp
|
|
16
16
|
|
|
@@ -32,9 +32,10 @@ api_instance = PulpcoreClient::StatusApi.new
|
|
|
32
32
|
|
|
33
33
|
begin
|
|
34
34
|
#Inspect status of Pulp
|
|
35
|
-
api_instance.
|
|
35
|
+
result = api_instance.status_read
|
|
36
|
+
p result
|
|
36
37
|
rescue PulpcoreClient::ApiError => e
|
|
37
|
-
puts "Exception when calling StatusApi->
|
|
38
|
+
puts "Exception when calling StatusApi->status_read: #{e}"
|
|
38
39
|
end
|
|
39
40
|
```
|
|
40
41
|
|
|
@@ -44,7 +45,7 @@ This endpoint does not need any parameter.
|
|
|
44
45
|
|
|
45
46
|
### Return type
|
|
46
47
|
|
|
47
|
-
|
|
48
|
+
[**Status**](Status.md)
|
|
48
49
|
|
|
49
50
|
### Authorization
|
|
50
51
|
|
|
@@ -53,5 +54,5 @@ nil (empty response body)
|
|
|
53
54
|
### HTTP request headers
|
|
54
55
|
|
|
55
56
|
- **Content-Type**: Not defined
|
|
56
|
-
- **Accept**:
|
|
57
|
+
- **Accept**: application/json
|
|
57
58
|
|
data/docs/TaskCancel.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# PulpcoreClient::TaskCancel
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**state** | **String** | The desired state of the task. Only 'canceled' is accepted. |
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'PulpcoreClient'
|
|
13
|
+
|
|
14
|
+
instance = PulpcoreClient::TaskCancel.new(state: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/TasksApi.md
CHANGED
|
@@ -4,71 +4,16 @@ All URIs are relative to *http://localhost:24817*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**
|
|
8
|
-
[**
|
|
9
|
-
[**
|
|
10
|
-
[**
|
|
7
|
+
[**delete**](TasksApi.md#delete) | **DELETE** {task_href} | Delete a task
|
|
8
|
+
[**list**](TasksApi.md#list) | **GET** /pulp/api/v3/tasks/ | List tasks
|
|
9
|
+
[**read**](TasksApi.md#read) | **GET** {task_href} | Inspect a task
|
|
10
|
+
[**tasks_cancel**](TasksApi.md#tasks_cancel) | **PATCH** {task_href} | Cancel a task
|
|
11
11
|
|
|
12
12
|
|
|
13
13
|
|
|
14
|
-
##
|
|
15
|
-
|
|
16
|
-
> Task tasks_cancel(task_href, data)
|
|
17
|
-
|
|
18
|
-
Cancel a task
|
|
19
|
-
|
|
20
|
-
This operation cancels a task.
|
|
21
|
-
|
|
22
|
-
### Example
|
|
23
|
-
|
|
24
|
-
```ruby
|
|
25
|
-
# load the gem
|
|
26
|
-
require 'pulpcore_client'
|
|
27
|
-
# setup authorization
|
|
28
|
-
PulpcoreClient.configure do |config|
|
|
29
|
-
# Configure HTTP basic authorization: Basic
|
|
30
|
-
config.username = 'YOUR USERNAME'
|
|
31
|
-
config.password = 'YOUR PASSWORD'
|
|
32
|
-
end
|
|
33
|
-
|
|
34
|
-
api_instance = PulpcoreClient::TasksApi.new
|
|
35
|
-
task_href = 'task_href_example' # String | URI of Task. e.g.: /pulp/api/v3/tasks/1/
|
|
36
|
-
data = PulpcoreClient::Task.new # Task |
|
|
37
|
-
|
|
38
|
-
begin
|
|
39
|
-
#Cancel a task
|
|
40
|
-
result = api_instance.tasks_cancel(task_href, data)
|
|
41
|
-
p result
|
|
42
|
-
rescue PulpcoreClient::ApiError => e
|
|
43
|
-
puts "Exception when calling TasksApi->tasks_cancel: #{e}"
|
|
44
|
-
end
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
### Parameters
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
Name | Type | Description | Notes
|
|
51
|
-
------------- | ------------- | ------------- | -------------
|
|
52
|
-
**task_href** | **String**| URI of Task. e.g.: /pulp/api/v3/tasks/1/ |
|
|
53
|
-
**data** | [**Task**](Task.md)| |
|
|
54
|
-
|
|
55
|
-
### Return type
|
|
56
|
-
|
|
57
|
-
[**Task**](Task.md)
|
|
58
|
-
|
|
59
|
-
### Authorization
|
|
60
|
-
|
|
61
|
-
[Basic](../README.md#Basic)
|
|
62
|
-
|
|
63
|
-
### HTTP request headers
|
|
64
|
-
|
|
65
|
-
- **Content-Type**: application/json
|
|
66
|
-
- **Accept**: application/json
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
## tasks_delete
|
|
14
|
+
## delete
|
|
70
15
|
|
|
71
|
-
>
|
|
16
|
+
> delete(task_href)
|
|
72
17
|
|
|
73
18
|
Delete a task
|
|
74
19
|
|
|
@@ -89,9 +34,9 @@ task_href = 'task_href_example' # String | URI of Task. e.g.: /pulp/api/v3/tasks
|
|
|
89
34
|
|
|
90
35
|
begin
|
|
91
36
|
#Delete a task
|
|
92
|
-
api_instance.
|
|
37
|
+
api_instance.delete(task_href)
|
|
93
38
|
rescue PulpcoreClient::ApiError => e
|
|
94
|
-
puts "Exception when calling TasksApi->
|
|
39
|
+
puts "Exception when calling TasksApi->delete: #{e}"
|
|
95
40
|
end
|
|
96
41
|
```
|
|
97
42
|
|
|
@@ -116,9 +61,9 @@ nil (empty response body)
|
|
|
116
61
|
- **Accept**: Not defined
|
|
117
62
|
|
|
118
63
|
|
|
119
|
-
##
|
|
64
|
+
## list
|
|
120
65
|
|
|
121
|
-
> InlineResponse2003
|
|
66
|
+
> InlineResponse2003 list(opts)
|
|
122
67
|
|
|
123
68
|
List tasks
|
|
124
69
|
|
|
@@ -162,10 +107,10 @@ opts = {
|
|
|
162
107
|
|
|
163
108
|
begin
|
|
164
109
|
#List tasks
|
|
165
|
-
result = api_instance.
|
|
110
|
+
result = api_instance.list(opts)
|
|
166
111
|
p result
|
|
167
112
|
rescue PulpcoreClient::ApiError => e
|
|
168
|
-
puts "Exception when calling TasksApi->
|
|
113
|
+
puts "Exception when calling TasksApi->list: #{e}"
|
|
169
114
|
end
|
|
170
115
|
```
|
|
171
116
|
|
|
@@ -211,9 +156,9 @@ Name | Type | Description | Notes
|
|
|
211
156
|
- **Accept**: application/json
|
|
212
157
|
|
|
213
158
|
|
|
214
|
-
##
|
|
159
|
+
## read
|
|
215
160
|
|
|
216
|
-
> Task
|
|
161
|
+
> Task read(task_href)
|
|
217
162
|
|
|
218
163
|
Inspect a task
|
|
219
164
|
|
|
@@ -234,10 +179,10 @@ task_href = 'task_href_example' # String | URI of Task. e.g.: /pulp/api/v3/tasks
|
|
|
234
179
|
|
|
235
180
|
begin
|
|
236
181
|
#Inspect a task
|
|
237
|
-
result = api_instance.
|
|
182
|
+
result = api_instance.read(task_href)
|
|
238
183
|
p result
|
|
239
184
|
rescue PulpcoreClient::ApiError => e
|
|
240
|
-
puts "Exception when calling TasksApi->
|
|
185
|
+
puts "Exception when calling TasksApi->read: #{e}"
|
|
241
186
|
end
|
|
242
187
|
```
|
|
243
188
|
|
|
@@ -261,3 +206,58 @@ Name | Type | Description | Notes
|
|
|
261
206
|
- **Content-Type**: Not defined
|
|
262
207
|
- **Accept**: application/json
|
|
263
208
|
|
|
209
|
+
|
|
210
|
+
## tasks_cancel
|
|
211
|
+
|
|
212
|
+
> Task tasks_cancel(task_href, data)
|
|
213
|
+
|
|
214
|
+
Cancel a task
|
|
215
|
+
|
|
216
|
+
This operation cancels a task.
|
|
217
|
+
|
|
218
|
+
### Example
|
|
219
|
+
|
|
220
|
+
```ruby
|
|
221
|
+
# load the gem
|
|
222
|
+
require 'pulpcore_client'
|
|
223
|
+
# setup authorization
|
|
224
|
+
PulpcoreClient.configure do |config|
|
|
225
|
+
# Configure HTTP basic authorization: Basic
|
|
226
|
+
config.username = 'YOUR USERNAME'
|
|
227
|
+
config.password = 'YOUR PASSWORD'
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
api_instance = PulpcoreClient::TasksApi.new
|
|
231
|
+
task_href = 'task_href_example' # String | URI of Task. e.g.: /pulp/api/v3/tasks/1/
|
|
232
|
+
data = PulpcoreClient::TaskCancel.new # TaskCancel |
|
|
233
|
+
|
|
234
|
+
begin
|
|
235
|
+
#Cancel a task
|
|
236
|
+
result = api_instance.tasks_cancel(task_href, data)
|
|
237
|
+
p result
|
|
238
|
+
rescue PulpcoreClient::ApiError => e
|
|
239
|
+
puts "Exception when calling TasksApi->tasks_cancel: #{e}"
|
|
240
|
+
end
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
### Parameters
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
Name | Type | Description | Notes
|
|
247
|
+
------------- | ------------- | ------------- | -------------
|
|
248
|
+
**task_href** | **String**| URI of Task. e.g.: /pulp/api/v3/tasks/1/ |
|
|
249
|
+
**data** | [**TaskCancel**](TaskCancel.md)| |
|
|
250
|
+
|
|
251
|
+
### Return type
|
|
252
|
+
|
|
253
|
+
[**Task**](Task.md)
|
|
254
|
+
|
|
255
|
+
### Authorization
|
|
256
|
+
|
|
257
|
+
[Basic](../README.md#Basic)
|
|
258
|
+
|
|
259
|
+
### HTTP request headers
|
|
260
|
+
|
|
261
|
+
- **Content-Type**: application/json
|
|
262
|
+
- **Accept**: application/json
|
|
263
|
+
|
data/docs/Upload.md
CHANGED
|
@@ -5,10 +5,9 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**_href** | **String** | | [optional]
|
|
8
|
-
**
|
|
9
|
-
**
|
|
10
|
-
**
|
|
11
|
-
**md5** | **String** | | [optional]
|
|
8
|
+
**_created** | **DateTime** | Timestamp of creation. | [optional]
|
|
9
|
+
**size** | **Integer** | The size of the upload in bytes. |
|
|
10
|
+
**completed** | **DateTime** | Timestamp when upload is committed. | [optional]
|
|
12
11
|
|
|
13
12
|
## Code Sample
|
|
14
13
|
|
|
@@ -16,10 +15,9 @@ Name | Type | Description | Notes
|
|
|
16
15
|
require 'PulpcoreClient'
|
|
17
16
|
|
|
18
17
|
instance = PulpcoreClient::Upload.new(_href: null,
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
md5: null)
|
|
18
|
+
_created: null,
|
|
19
|
+
size: null,
|
|
20
|
+
completed: null)
|
|
23
21
|
```
|
|
24
22
|
|
|
25
23
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# PulpcoreClient::UploadCommit
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**sha256** | **String** | The expected sha256 checksum for the file. |
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'PulpcoreClient'
|
|
13
|
+
|
|
14
|
+
instance = PulpcoreClient::UploadCommit.new(sha256: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/UploadsApi.md
CHANGED
|
@@ -4,23 +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
|
-
[**uploads_update**](UploadsApi.md#uploads_update) | **PUT** {upload_href} | Continue an Upload
|
|
7
|
+
[**commit**](UploadsApi.md#commit) | **PUT** {upload_href}commit/ | Finish an Upload
|
|
8
|
+
[**create**](UploadsApi.md#create) | **POST** /pulp/api/v3/uploads/ | Create an upload
|
|
9
|
+
[**delete**](UploadsApi.md#delete) | **DELETE** {upload_href} | Delete an upload
|
|
10
|
+
[**list**](UploadsApi.md#list) | **GET** /pulp/api/v3/uploads/ | List uploads
|
|
11
|
+
[**read**](UploadsApi.md#read) | **GET** {upload_href} | Inspect an upload
|
|
12
|
+
[**update**](UploadsApi.md#update) | **PUT** {upload_href} | Upload a file chunk
|
|
14
13
|
|
|
15
14
|
|
|
16
15
|
|
|
17
|
-
##
|
|
16
|
+
## commit
|
|
18
17
|
|
|
19
|
-
> Upload
|
|
18
|
+
> Upload commit(upload_href, data)
|
|
20
19
|
|
|
21
|
-
|
|
20
|
+
Finish an Upload
|
|
22
21
|
|
|
23
|
-
|
|
22
|
+
Commit the upload and mark it as completed.
|
|
24
23
|
|
|
25
24
|
### Example
|
|
26
25
|
|
|
@@ -35,14 +34,15 @@ PulpcoreClient.configure do |config|
|
|
|
35
34
|
end
|
|
36
35
|
|
|
37
36
|
api_instance = PulpcoreClient::UploadsApi.new
|
|
38
|
-
|
|
37
|
+
upload_href = 'upload_href_example' # String | URI of Upload. e.g.: /pulp/api/v3/uploads/1/
|
|
38
|
+
data = PulpcoreClient::UploadCommit.new # UploadCommit |
|
|
39
39
|
|
|
40
40
|
begin
|
|
41
|
-
#
|
|
42
|
-
result = api_instance.
|
|
41
|
+
#Finish an Upload
|
|
42
|
+
result = api_instance.commit(upload_href, data)
|
|
43
43
|
p result
|
|
44
44
|
rescue PulpcoreClient::ApiError => e
|
|
45
|
-
puts "Exception when calling UploadsApi->
|
|
45
|
+
puts "Exception when calling UploadsApi->commit: #{e}"
|
|
46
46
|
end
|
|
47
47
|
```
|
|
48
48
|
|
|
@@ -51,7 +51,8 @@ end
|
|
|
51
51
|
|
|
52
52
|
Name | Type | Description | Notes
|
|
53
53
|
------------- | ------------- | ------------- | -------------
|
|
54
|
-
**
|
|
54
|
+
**upload_href** | **String**| URI of Upload. e.g.: /pulp/api/v3/uploads/1/ |
|
|
55
|
+
**data** | [**UploadCommit**](UploadCommit.md)| |
|
|
55
56
|
|
|
56
57
|
### Return type
|
|
57
58
|
|
|
@@ -63,17 +64,17 @@ Name | Type | Description | Notes
|
|
|
63
64
|
|
|
64
65
|
### HTTP request headers
|
|
65
66
|
|
|
66
|
-
- **Content-Type**:
|
|
67
|
+
- **Content-Type**: application/json
|
|
67
68
|
- **Accept**: application/json
|
|
68
69
|
|
|
69
70
|
|
|
70
|
-
##
|
|
71
|
+
## create
|
|
71
72
|
|
|
72
|
-
> Upload
|
|
73
|
+
> Upload create(data)
|
|
73
74
|
|
|
74
|
-
Create an
|
|
75
|
+
Create an upload
|
|
75
76
|
|
|
76
|
-
|
|
77
|
+
View for chunked uploads.
|
|
77
78
|
|
|
78
79
|
### Example
|
|
79
80
|
|
|
@@ -88,15 +89,14 @@ PulpcoreClient.configure do |config|
|
|
|
88
89
|
end
|
|
89
90
|
|
|
90
91
|
api_instance = PulpcoreClient::UploadsApi.new
|
|
91
|
-
|
|
92
|
-
md5 = 'md5_example' # String | The expected MD5 checksum of the file.
|
|
92
|
+
data = PulpcoreClient::Upload.new # Upload |
|
|
93
93
|
|
|
94
94
|
begin
|
|
95
|
-
#Create an
|
|
96
|
-
result = api_instance.
|
|
95
|
+
#Create an upload
|
|
96
|
+
result = api_instance.create(data)
|
|
97
97
|
p result
|
|
98
98
|
rescue PulpcoreClient::ApiError => e
|
|
99
|
-
puts "Exception when calling UploadsApi->
|
|
99
|
+
puts "Exception when calling UploadsApi->create: #{e}"
|
|
100
100
|
end
|
|
101
101
|
```
|
|
102
102
|
|
|
@@ -105,8 +105,7 @@ end
|
|
|
105
105
|
|
|
106
106
|
Name | Type | Description | Notes
|
|
107
107
|
------------- | ------------- | ------------- | -------------
|
|
108
|
-
**
|
|
109
|
-
**md5** | **String**| The expected MD5 checksum of the file. |
|
|
108
|
+
**data** | [**Upload**](Upload.md)| |
|
|
110
109
|
|
|
111
110
|
### Return type
|
|
112
111
|
|
|
@@ -118,13 +117,13 @@ Name | Type | Description | Notes
|
|
|
118
117
|
|
|
119
118
|
### HTTP request headers
|
|
120
119
|
|
|
121
|
-
- **Content-Type**:
|
|
120
|
+
- **Content-Type**: application/json
|
|
122
121
|
- **Accept**: application/json
|
|
123
122
|
|
|
124
123
|
|
|
125
|
-
##
|
|
124
|
+
## delete
|
|
126
125
|
|
|
127
|
-
>
|
|
126
|
+
> delete(upload_href)
|
|
128
127
|
|
|
129
128
|
Delete an upload
|
|
130
129
|
|
|
@@ -147,9 +146,9 @@ upload_href = 'upload_href_example' # String | URI of Upload. e.g.: /pulp/api/v3
|
|
|
147
146
|
|
|
148
147
|
begin
|
|
149
148
|
#Delete an upload
|
|
150
|
-
api_instance.
|
|
149
|
+
api_instance.delete(upload_href)
|
|
151
150
|
rescue PulpcoreClient::ApiError => e
|
|
152
|
-
puts "Exception when calling UploadsApi->
|
|
151
|
+
puts "Exception when calling UploadsApi->delete: #{e}"
|
|
153
152
|
end
|
|
154
153
|
```
|
|
155
154
|
|
|
@@ -174,68 +173,13 @@ nil (empty response body)
|
|
|
174
173
|
- **Accept**: Not defined
|
|
175
174
|
|
|
176
175
|
|
|
177
|
-
##
|
|
178
|
-
|
|
179
|
-
> Upload uploads_finish(upload_href, md5)
|
|
180
|
-
|
|
181
|
-
Finish an Upload
|
|
182
|
-
|
|
183
|
-
Mark the Upload as \"complete\". The md5 checksum is used to validate the integrity of the upload.
|
|
184
|
-
|
|
185
|
-
### Example
|
|
186
|
-
|
|
187
|
-
```ruby
|
|
188
|
-
# load the gem
|
|
189
|
-
require 'pulpcore_client'
|
|
190
|
-
# setup authorization
|
|
191
|
-
PulpcoreClient.configure do |config|
|
|
192
|
-
# Configure HTTP basic authorization: Basic
|
|
193
|
-
config.username = 'YOUR USERNAME'
|
|
194
|
-
config.password = 'YOUR PASSWORD'
|
|
195
|
-
end
|
|
196
|
-
|
|
197
|
-
api_instance = PulpcoreClient::UploadsApi.new
|
|
198
|
-
upload_href = 'upload_href_example' # String | URI of Upload. e.g.: /pulp/api/v3/uploads/1/
|
|
199
|
-
md5 = 'md5_example' # String | The expected MD5 checksum of the file.
|
|
200
|
-
|
|
201
|
-
begin
|
|
202
|
-
#Finish an Upload
|
|
203
|
-
result = api_instance.uploads_finish(upload_href, md5)
|
|
204
|
-
p result
|
|
205
|
-
rescue PulpcoreClient::ApiError => e
|
|
206
|
-
puts "Exception when calling UploadsApi->uploads_finish: #{e}"
|
|
207
|
-
end
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
### Parameters
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
Name | Type | Description | Notes
|
|
214
|
-
------------- | ------------- | ------------- | -------------
|
|
215
|
-
**upload_href** | **String**| URI of Upload. e.g.: /pulp/api/v3/uploads/1/ |
|
|
216
|
-
**md5** | **String**| The expected MD5 checksum of the file. |
|
|
217
|
-
|
|
218
|
-
### Return type
|
|
219
|
-
|
|
220
|
-
[**Upload**](Upload.md)
|
|
221
|
-
|
|
222
|
-
### Authorization
|
|
223
|
-
|
|
224
|
-
[Basic](../README.md#Basic)
|
|
225
|
-
|
|
226
|
-
### HTTP request headers
|
|
227
|
-
|
|
228
|
-
- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
|
|
229
|
-
- **Accept**: application/json
|
|
176
|
+
## list
|
|
230
177
|
|
|
231
|
-
|
|
232
|
-
## uploads_list
|
|
233
|
-
|
|
234
|
-
> InlineResponse2004 uploads_list(opts)
|
|
178
|
+
> InlineResponse2004 list(opts)
|
|
235
179
|
|
|
236
180
|
List uploads
|
|
237
181
|
|
|
238
|
-
|
|
182
|
+
View for chunked uploads.
|
|
239
183
|
|
|
240
184
|
### Example
|
|
241
185
|
|
|
@@ -251,16 +195,23 @@ end
|
|
|
251
195
|
|
|
252
196
|
api_instance = PulpcoreClient::UploadsApi.new
|
|
253
197
|
opts = {
|
|
198
|
+
completed__lt: 'completed__lt_example', # String | Filter results where completed is less than value
|
|
199
|
+
completed__lte: 'completed__lte_example', # String | Filter results where completed is less than or equal to value
|
|
200
|
+
completed__gt: 'completed__gt_example', # String | Filter results where completed is greater than value
|
|
201
|
+
completed__gte: 'completed__gte_example', # String | Filter results where completed is greater than or equal to value
|
|
202
|
+
completed__range: 'completed__range_example', # String | Filter results where completed is between two comma separated values
|
|
203
|
+
completed__isnull: 'completed__isnull_example', # String | Filter results where completed has a null value
|
|
204
|
+
completed: 'completed_example', # String | ISO 8601 formatted dates are supported
|
|
254
205
|
page: 56, # Integer | A page number within the paginated result set.
|
|
255
206
|
page_size: 56 # Integer | Number of results to return per page.
|
|
256
207
|
}
|
|
257
208
|
|
|
258
209
|
begin
|
|
259
210
|
#List uploads
|
|
260
|
-
result = api_instance.
|
|
211
|
+
result = api_instance.list(opts)
|
|
261
212
|
p result
|
|
262
213
|
rescue PulpcoreClient::ApiError => e
|
|
263
|
-
puts "Exception when calling UploadsApi->
|
|
214
|
+
puts "Exception when calling UploadsApi->list: #{e}"
|
|
264
215
|
end
|
|
265
216
|
```
|
|
266
217
|
|
|
@@ -269,6 +220,13 @@ end
|
|
|
269
220
|
|
|
270
221
|
Name | Type | Description | Notes
|
|
271
222
|
------------- | ------------- | ------------- | -------------
|
|
223
|
+
**completed__lt** | **String**| Filter results where completed is less than value | [optional]
|
|
224
|
+
**completed__lte** | **String**| Filter results where completed is less than or equal to value | [optional]
|
|
225
|
+
**completed__gt** | **String**| Filter results where completed is greater than value | [optional]
|
|
226
|
+
**completed__gte** | **String**| Filter results where completed is greater than or equal to value | [optional]
|
|
227
|
+
**completed__range** | **String**| Filter results where completed is between two comma separated values | [optional]
|
|
228
|
+
**completed__isnull** | **String**| Filter results where completed has a null value | [optional]
|
|
229
|
+
**completed** | **String**| ISO 8601 formatted dates are supported | [optional]
|
|
272
230
|
**page** | **Integer**| A page number within the paginated result set. | [optional]
|
|
273
231
|
**page_size** | **Integer**| Number of results to return per page. | [optional]
|
|
274
232
|
|
|
@@ -286,9 +244,9 @@ Name | Type | Description | Notes
|
|
|
286
244
|
- **Accept**: application/json
|
|
287
245
|
|
|
288
246
|
|
|
289
|
-
##
|
|
247
|
+
## read
|
|
290
248
|
|
|
291
|
-
> Upload
|
|
249
|
+
> Upload read(upload_href)
|
|
292
250
|
|
|
293
251
|
Inspect an upload
|
|
294
252
|
|
|
@@ -311,10 +269,10 @@ upload_href = 'upload_href_example' # String | URI of Upload. e.g.: /pulp/api/v3
|
|
|
311
269
|
|
|
312
270
|
begin
|
|
313
271
|
#Inspect an upload
|
|
314
|
-
result = api_instance.
|
|
272
|
+
result = api_instance.read(upload_href)
|
|
315
273
|
p result
|
|
316
274
|
rescue PulpcoreClient::ApiError => e
|
|
317
|
-
puts "Exception when calling UploadsApi->
|
|
275
|
+
puts "Exception when calling UploadsApi->read: #{e}"
|
|
318
276
|
end
|
|
319
277
|
```
|
|
320
278
|
|
|
@@ -339,13 +297,13 @@ Name | Type | Description | Notes
|
|
|
339
297
|
- **Accept**: application/json
|
|
340
298
|
|
|
341
299
|
|
|
342
|
-
##
|
|
300
|
+
## update
|
|
343
301
|
|
|
344
|
-
> Upload
|
|
302
|
+
> Upload update(upload_href, content_range, file)
|
|
345
303
|
|
|
346
|
-
|
|
304
|
+
Upload a file chunk
|
|
347
305
|
|
|
348
|
-
|
|
306
|
+
Upload a chunk for an upload.
|
|
349
307
|
|
|
350
308
|
### Example
|
|
351
309
|
|
|
@@ -361,14 +319,15 @@ end
|
|
|
361
319
|
|
|
362
320
|
api_instance = PulpcoreClient::UploadsApi.new
|
|
363
321
|
upload_href = 'upload_href_example' # String | URI of Upload. e.g.: /pulp/api/v3/uploads/1/
|
|
364
|
-
|
|
322
|
+
content_range = 'content_range_example' # String | The Content-Range header specifies the location of the file chunk within the file.
|
|
323
|
+
file = File.new('/path/to/file') # File | A chunk of the uploaded file.
|
|
365
324
|
|
|
366
325
|
begin
|
|
367
|
-
#
|
|
368
|
-
result = api_instance.
|
|
326
|
+
#Upload a file chunk
|
|
327
|
+
result = api_instance.update(upload_href, content_range, file)
|
|
369
328
|
p result
|
|
370
329
|
rescue PulpcoreClient::ApiError => e
|
|
371
|
-
puts "Exception when calling UploadsApi->
|
|
330
|
+
puts "Exception when calling UploadsApi->update: #{e}"
|
|
372
331
|
end
|
|
373
332
|
```
|
|
374
333
|
|
|
@@ -378,7 +337,8 @@ end
|
|
|
378
337
|
Name | Type | Description | Notes
|
|
379
338
|
------------- | ------------- | ------------- | -------------
|
|
380
339
|
**upload_href** | **String**| URI of Upload. e.g.: /pulp/api/v3/uploads/1/ |
|
|
381
|
-
**
|
|
340
|
+
**content_range** | **String**| The Content-Range header specifies the location of the file chunk within the file. |
|
|
341
|
+
**file** | **File**| A chunk of the uploaded file. |
|
|
382
342
|
|
|
383
343
|
### Return type
|
|
384
344
|
|
data/docs/Version.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# PulpcoreClient::Version
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**component** | **String** | Name of a versioned component of Pulp |
|
|
8
|
+
**version** | **String** | Version of the component (e.g. 3.0.0) |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'PulpcoreClient'
|
|
14
|
+
|
|
15
|
+
instance = PulpcoreClient::Version.new(component: null,
|
|
16
|
+
version: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|