pulpcore_client 3.0.0rc2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (82) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/Gemfile.lock +79 -0
  4. data/README.md +151 -0
  5. data/Rakefile +10 -0
  6. data/docs/Artifact.md +37 -0
  7. data/docs/ArtifactsApi.md +253 -0
  8. data/docs/AsyncOperationResponse.md +17 -0
  9. data/docs/InlineResponse200.md +23 -0
  10. data/docs/InlineResponse2001.md +23 -0
  11. data/docs/InlineResponse2002.md +23 -0
  12. data/docs/InlineResponse2003.md +23 -0
  13. data/docs/InlineResponse2004.md +23 -0
  14. data/docs/InlineResponse2005.md +23 -0
  15. data/docs/OrphansApi.md +58 -0
  16. data/docs/ProgressReport.md +27 -0
  17. data/docs/RepositoriesApi.md +584 -0
  18. data/docs/Repository.md +27 -0
  19. data/docs/RepositoryVersion.md +25 -0
  20. data/docs/RepositoryVersionCreate.md +21 -0
  21. data/docs/StatusApi.md +57 -0
  22. data/docs/Task.md +41 -0
  23. data/docs/TasksApi.md +263 -0
  24. data/docs/Upload.md +25 -0
  25. data/docs/UploadsApi.md +395 -0
  26. data/docs/Worker.md +27 -0
  27. data/docs/WorkersApi.md +136 -0
  28. data/git_push.sh +55 -0
  29. data/lib/pulpcore_client/api/artifacts_api.rb +306 -0
  30. data/lib/pulpcore_client/api/orphans_api.rb +78 -0
  31. data/lib/pulpcore_client/api/repositories_api.rb +710 -0
  32. data/lib/pulpcore_client/api/status_api.rb +76 -0
  33. data/lib/pulpcore_client/api/tasks_api.rb +330 -0
  34. data/lib/pulpcore_client/api/uploads_api.rb +493 -0
  35. data/lib/pulpcore_client/api/workers_api.rb +172 -0
  36. data/lib/pulpcore_client/api_client.rb +387 -0
  37. data/lib/pulpcore_client/api_error.rb +57 -0
  38. data/lib/pulpcore_client/configuration.rb +251 -0
  39. data/lib/pulpcore_client/models/artifact.rb +296 -0
  40. data/lib/pulpcore_client/models/async_operation_response.rb +202 -0
  41. data/lib/pulpcore_client/models/inline_response200.rb +235 -0
  42. data/lib/pulpcore_client/models/inline_response2001.rb +235 -0
  43. data/lib/pulpcore_client/models/inline_response2002.rb +235 -0
  44. data/lib/pulpcore_client/models/inline_response2003.rb +235 -0
  45. data/lib/pulpcore_client/models/inline_response2004.rb +235 -0
  46. data/lib/pulpcore_client/models/inline_response2005.rb +235 -0
  47. data/lib/pulpcore_client/models/progress_report.rb +277 -0
  48. data/lib/pulpcore_client/models/repository.rb +268 -0
  49. data/lib/pulpcore_client/models/repository_version.rb +235 -0
  50. data/lib/pulpcore_client/models/repository_version_create.rb +231 -0
  51. data/lib/pulpcore_client/models/task.rb +360 -0
  52. data/lib/pulpcore_client/models/upload.rb +257 -0
  53. data/lib/pulpcore_client/models/worker.rb +261 -0
  54. data/lib/pulpcore_client/version.rb +15 -0
  55. data/lib/pulpcore_client.rb +61 -0
  56. data/pulpcore_client.gemspec +45 -0
  57. data/spec/api/artifacts_api_spec.rb +96 -0
  58. data/spec/api/orphans_api_spec.rb +46 -0
  59. data/spec/api/repositories_api_spec.rb +171 -0
  60. data/spec/api/status_api_spec.rb +46 -0
  61. data/spec/api/tasks_api_spec.rb +102 -0
  62. data/spec/api/uploads_api_spec.rb +123 -0
  63. data/spec/api/workers_api_spec.rb +68 -0
  64. data/spec/api_client_spec.rb +226 -0
  65. data/spec/configuration_spec.rb +42 -0
  66. data/spec/models/artifact_spec.rb +101 -0
  67. data/spec/models/async_operation_response_spec.rb +41 -0
  68. data/spec/models/inline_response2001_spec.rb +59 -0
  69. data/spec/models/inline_response2002_spec.rb +59 -0
  70. data/spec/models/inline_response2003_spec.rb +59 -0
  71. data/spec/models/inline_response2004_spec.rb +59 -0
  72. data/spec/models/inline_response2005_spec.rb +59 -0
  73. data/spec/models/inline_response200_spec.rb +59 -0
  74. data/spec/models/progress_report_spec.rb +71 -0
  75. data/spec/models/repository_spec.rb +71 -0
  76. data/spec/models/repository_version_create_spec.rb +53 -0
  77. data/spec/models/repository_version_spec.rb +65 -0
  78. data/spec/models/task_spec.rb +113 -0
  79. data/spec/models/upload_spec.rb +65 -0
  80. data/spec/models/worker_spec.rb +71 -0
  81. data/spec/spec_helper.rb +111 -0
  82. metadata +329 -0
@@ -0,0 +1,27 @@
1
+ # PulpcoreClient::Repository
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **_href** | **String** | | [optional]
8
+ **_created** | **DateTime** | Timestamp of creation. | [optional]
9
+ **_versions_href** | **String** | | [optional]
10
+ **_latest_version_href** | **String** | | [optional]
11
+ **name** | **String** | A unique name for this repository. |
12
+ **description** | **String** | An optional description. | [optional]
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'PulpcoreClient'
18
+
19
+ instance = PulpcoreClient::Repository.new(_href: null,
20
+ _created: null,
21
+ _versions_href: null,
22
+ _latest_version_href: null,
23
+ name: null,
24
+ description: null)
25
+ ```
26
+
27
+
@@ -0,0 +1,25 @@
1
+ # PulpcoreClient::RepositoryVersion
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **_href** | **String** | | [optional]
8
+ **_created** | **DateTime** | Timestamp of creation. | [optional]
9
+ **number** | **Integer** | | [optional]
10
+ **base_version** | **String** | A repository version whose content was used as the initial set of content for this repository version | [optional]
11
+ **content_summary** | **String** | Various count summaries of the content in the version and the HREF to view them. | [optional]
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'PulpcoreClient'
17
+
18
+ instance = PulpcoreClient::RepositoryVersion.new(_href: null,
19
+ _created: null,
20
+ number: null,
21
+ base_version: null,
22
+ content_summary: null)
23
+ ```
24
+
25
+
@@ -0,0 +1,21 @@
1
+ # PulpcoreClient::RepositoryVersionCreate
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **add_content_units** | **Array<String>** | A list of content units to add to a new repository version |
8
+ **remove_content_units** | **Array<String>** | A list of content units to remove from the latest repository version |
9
+ **base_version** | **String** | A repository version whose content will be used as the initial set of content for the new repository version | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'PulpcoreClient'
15
+
16
+ instance = PulpcoreClient::RepositoryVersionCreate.new(add_content_units: null,
17
+ remove_content_units: null,
18
+ base_version: null)
19
+ ```
20
+
21
+
data/docs/StatusApi.md ADDED
@@ -0,0 +1,57 @@
1
+ # PulpcoreClient::StatusApi
2
+
3
+ All URIs are relative to *http://localhost:24817*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**status_list**](StatusApi.md#status_list) | **GET** /pulp/api/v3/status/ | Inspect status of Pulp
8
+
9
+
10
+
11
+ ## status_list
12
+
13
+ > status_list
14
+
15
+ Inspect status of Pulp
16
+
17
+ Returns app information including the version of pulpcore and loaded pulp plugins, known workers, database connection status, and messaging connection status
18
+
19
+ ### Example
20
+
21
+ ```ruby
22
+ # load the gem
23
+ require 'pulpcore_client'
24
+ # setup authorization
25
+ PulpcoreClient.configure do |config|
26
+ # Configure HTTP basic authorization: Basic
27
+ config.username = 'YOUR USERNAME'
28
+ config.password = 'YOUR PASSWORD'
29
+ end
30
+
31
+ api_instance = PulpcoreClient::StatusApi.new
32
+
33
+ begin
34
+ #Inspect status of Pulp
35
+ api_instance.status_list
36
+ rescue PulpcoreClient::ApiError => e
37
+ puts "Exception when calling StatusApi->status_list: #{e}"
38
+ end
39
+ ```
40
+
41
+ ### Parameters
42
+
43
+ This endpoint does not need any parameter.
44
+
45
+ ### Return type
46
+
47
+ nil (empty response body)
48
+
49
+ ### Authorization
50
+
51
+ [Basic](../README.md#Basic)
52
+
53
+ ### HTTP request headers
54
+
55
+ - **Content-Type**: Not defined
56
+ - **Accept**: Not defined
57
+
data/docs/Task.md ADDED
@@ -0,0 +1,41 @@
1
+ # PulpcoreClient::Task
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **_href** | **String** | | [optional]
8
+ **_created** | **DateTime** | Timestamp of creation. | [optional]
9
+ **state** | **String** | The current state of the task. The possible values include: 'waiting', 'skipped', 'running', 'completed', 'failed' and 'canceled'. | [optional]
10
+ **name** | **String** | The name of task. |
11
+ **started_at** | **DateTime** | Timestamp of the when this task started execution. | [optional]
12
+ **finished_at** | **DateTime** | Timestamp of the when this task stopped execution. | [optional]
13
+ **non_fatal_errors** | **String** | A JSON Object of non-fatal errors encountered during the execution of this task. | [optional]
14
+ **error** | **String** | A JSON Object of a fatal error encountered during the execution of this task. | [optional]
15
+ **worker** | **String** | The worker associated with this task. This field is empty if a worker is not yet assigned. | [optional]
16
+ **parent** | **String** | The parent task that spawned this task. | [optional]
17
+ **spawned_tasks** | **Array<String>** | Any tasks spawned by this task. | [optional]
18
+ **progress_reports** | [**Array<ProgressReport>**](ProgressReport.md) | | [optional]
19
+ **created_resources** | **Array<String>** | Resources created by this task. | [optional]
20
+
21
+ ## Code Sample
22
+
23
+ ```ruby
24
+ require 'PulpcoreClient'
25
+
26
+ instance = PulpcoreClient::Task.new(_href: null,
27
+ _created: null,
28
+ state: null,
29
+ name: null,
30
+ started_at: null,
31
+ finished_at: null,
32
+ non_fatal_errors: null,
33
+ error: null,
34
+ worker: null,
35
+ parent: null,
36
+ spawned_tasks: null,
37
+ progress_reports: null,
38
+ created_resources: null)
39
+ ```
40
+
41
+
data/docs/TasksApi.md ADDED
@@ -0,0 +1,263 @@
1
+ # PulpcoreClient::TasksApi
2
+
3
+ All URIs are relative to *http://localhost:24817*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**tasks_cancel**](TasksApi.md#tasks_cancel) | **POST** {task_href}cancel/ | Cancel a task
8
+ [**tasks_delete**](TasksApi.md#tasks_delete) | **DELETE** {task_href} | Delete a task
9
+ [**tasks_list**](TasksApi.md#tasks_list) | **GET** /pulp/api/v3/tasks/ | List tasks
10
+ [**tasks_read**](TasksApi.md#tasks_read) | **GET** {task_href} | Inspect a task
11
+
12
+
13
+
14
+ ## tasks_cancel
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
70
+
71
+ > tasks_delete(task_href)
72
+
73
+ Delete a task
74
+
75
+ ### Example
76
+
77
+ ```ruby
78
+ # load the gem
79
+ require 'pulpcore_client'
80
+ # setup authorization
81
+ PulpcoreClient.configure do |config|
82
+ # Configure HTTP basic authorization: Basic
83
+ config.username = 'YOUR USERNAME'
84
+ config.password = 'YOUR PASSWORD'
85
+ end
86
+
87
+ api_instance = PulpcoreClient::TasksApi.new
88
+ task_href = 'task_href_example' # String | URI of Task. e.g.: /pulp/api/v3/tasks/1/
89
+
90
+ begin
91
+ #Delete a task
92
+ api_instance.tasks_delete(task_href)
93
+ rescue PulpcoreClient::ApiError => e
94
+ puts "Exception when calling TasksApi->tasks_delete: #{e}"
95
+ end
96
+ ```
97
+
98
+ ### Parameters
99
+
100
+
101
+ Name | Type | Description | Notes
102
+ ------------- | ------------- | ------------- | -------------
103
+ **task_href** | **String**| URI of Task. e.g.: /pulp/api/v3/tasks/1/ |
104
+
105
+ ### Return type
106
+
107
+ nil (empty response body)
108
+
109
+ ### Authorization
110
+
111
+ [Basic](../README.md#Basic)
112
+
113
+ ### HTTP request headers
114
+
115
+ - **Content-Type**: Not defined
116
+ - **Accept**: Not defined
117
+
118
+
119
+ ## tasks_list
120
+
121
+ > InlineResponse2003 tasks_list(opts)
122
+
123
+ List tasks
124
+
125
+ ### Example
126
+
127
+ ```ruby
128
+ # load the gem
129
+ require 'pulpcore_client'
130
+ # setup authorization
131
+ PulpcoreClient.configure do |config|
132
+ # Configure HTTP basic authorization: Basic
133
+ config.username = 'YOUR USERNAME'
134
+ config.password = 'YOUR PASSWORD'
135
+ end
136
+
137
+ api_instance = PulpcoreClient::TasksApi.new
138
+ opts = {
139
+ ordering: 'ordering_example', # String | Which field to use when ordering the results.
140
+ state: 'state_example', # String |
141
+ state__in: 'state__in_example', # String | Filter results where state is in a comma-separated list of values
142
+ worker: 'worker_example', # String | Foreign Key referenced by HREF
143
+ worker__in: 'worker__in_example', # String | Filter results where worker is in a comma-separated list of values
144
+ name__contains: 'name__contains_example', # String | Filter results where name contains value
145
+ started_at__lt: 'started_at__lt_example', # String | Filter results where started_at is less than value
146
+ started_at__lte: 'started_at__lte_example', # String | Filter results where started_at is less than or equal to value
147
+ started_at__gt: 'started_at__gt_example', # String | Filter results where started_at is greater than value
148
+ started_at__gte: 'started_at__gte_example', # String | Filter results where started_at is greater than or equal to value
149
+ started_at__range: 'started_at__range_example', # String | Filter results where started_at is between two comma separated values
150
+ finished_at__lt: 'finished_at__lt_example', # String | Filter results where finished_at is less than value
151
+ finished_at__lte: 'finished_at__lte_example', # String | Filter results where finished_at is less than or equal to value
152
+ finished_at__gt: 'finished_at__gt_example', # String | Filter results where finished_at is greater than value
153
+ finished_at__gte: 'finished_at__gte_example', # String | Filter results where finished_at is greater than or equal to value
154
+ finished_at__range: 'finished_at__range_example', # String | Filter results where finished_at is between two comma separated values
155
+ parent: 'parent_example', # String | Foreign Key referenced by HREF
156
+ name: 'name_example', # String |
157
+ started_at: 'started_at_example', # String | ISO 8601 formatted dates are supported
158
+ finished_at: 'finished_at_example', # String | ISO 8601 formatted dates are supported
159
+ page: 56, # Integer | A page number within the paginated result set.
160
+ page_size: 56 # Integer | Number of results to return per page.
161
+ }
162
+
163
+ begin
164
+ #List tasks
165
+ result = api_instance.tasks_list(opts)
166
+ p result
167
+ rescue PulpcoreClient::ApiError => e
168
+ puts "Exception when calling TasksApi->tasks_list: #{e}"
169
+ end
170
+ ```
171
+
172
+ ### Parameters
173
+
174
+
175
+ Name | Type | Description | Notes
176
+ ------------- | ------------- | ------------- | -------------
177
+ **ordering** | **String**| Which field to use when ordering the results. | [optional]
178
+ **state** | **String**| | [optional]
179
+ **state__in** | **String**| Filter results where state is in a comma-separated list of values | [optional]
180
+ **worker** | **String**| Foreign Key referenced by HREF | [optional]
181
+ **worker__in** | **String**| Filter results where worker is in a comma-separated list of values | [optional]
182
+ **name__contains** | **String**| Filter results where name contains value | [optional]
183
+ **started_at__lt** | **String**| Filter results where started_at is less than value | [optional]
184
+ **started_at__lte** | **String**| Filter results where started_at is less than or equal to value | [optional]
185
+ **started_at__gt** | **String**| Filter results where started_at is greater than value | [optional]
186
+ **started_at__gte** | **String**| Filter results where started_at is greater than or equal to value | [optional]
187
+ **started_at__range** | **String**| Filter results where started_at is between two comma separated values | [optional]
188
+ **finished_at__lt** | **String**| Filter results where finished_at is less than value | [optional]
189
+ **finished_at__lte** | **String**| Filter results where finished_at is less than or equal to value | [optional]
190
+ **finished_at__gt** | **String**| Filter results where finished_at is greater than value | [optional]
191
+ **finished_at__gte** | **String**| Filter results where finished_at is greater than or equal to value | [optional]
192
+ **finished_at__range** | **String**| Filter results where finished_at is between two comma separated values | [optional]
193
+ **parent** | **String**| Foreign Key referenced by HREF | [optional]
194
+ **name** | **String**| | [optional]
195
+ **started_at** | **String**| ISO 8601 formatted dates are supported | [optional]
196
+ **finished_at** | **String**| ISO 8601 formatted dates are supported | [optional]
197
+ **page** | **Integer**| A page number within the paginated result set. | [optional]
198
+ **page_size** | **Integer**| Number of results to return per page. | [optional]
199
+
200
+ ### Return type
201
+
202
+ [**InlineResponse2003**](InlineResponse2003.md)
203
+
204
+ ### Authorization
205
+
206
+ [Basic](../README.md#Basic)
207
+
208
+ ### HTTP request headers
209
+
210
+ - **Content-Type**: Not defined
211
+ - **Accept**: application/json
212
+
213
+
214
+ ## tasks_read
215
+
216
+ > Task tasks_read(task_href)
217
+
218
+ Inspect a task
219
+
220
+ ### Example
221
+
222
+ ```ruby
223
+ # load the gem
224
+ require 'pulpcore_client'
225
+ # setup authorization
226
+ PulpcoreClient.configure do |config|
227
+ # Configure HTTP basic authorization: Basic
228
+ config.username = 'YOUR USERNAME'
229
+ config.password = 'YOUR PASSWORD'
230
+ end
231
+
232
+ api_instance = PulpcoreClient::TasksApi.new
233
+ task_href = 'task_href_example' # String | URI of Task. e.g.: /pulp/api/v3/tasks/1/
234
+
235
+ begin
236
+ #Inspect a task
237
+ result = api_instance.tasks_read(task_href)
238
+ p result
239
+ rescue PulpcoreClient::ApiError => e
240
+ puts "Exception when calling TasksApi->tasks_read: #{e}"
241
+ end
242
+ ```
243
+
244
+ ### Parameters
245
+
246
+
247
+ Name | Type | Description | Notes
248
+ ------------- | ------------- | ------------- | -------------
249
+ **task_href** | **String**| URI of Task. e.g.: /pulp/api/v3/tasks/1/ |
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**: Not defined
262
+ - **Accept**: application/json
263
+
data/docs/Upload.md ADDED
@@ -0,0 +1,25 @@
1
+ # PulpcoreClient::Upload
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **_href** | **String** | | [optional]
8
+ **offset** | **Integer** | | [optional]
9
+ **expires_at** | **String** | | [optional]
10
+ **file** | **String** | Uploaded file. | [optional]
11
+ **md5** | **String** | | [optional]
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'PulpcoreClient'
17
+
18
+ instance = PulpcoreClient::Upload.new(_href: null,
19
+ offset: null,
20
+ expires_at: null,
21
+ file: null,
22
+ md5: null)
23
+ ```
24
+
25
+