pulp_python_client 3.11.8 → 3.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +31 -12
- data/docs/ContentPackagesApi.md +13 -19
- data/docs/DistributionsPypiApi.md +245 -41
- data/docs/MyPermissionsResponse.md +17 -0
- data/docs/NestedRole.md +21 -0
- data/docs/NestedRoleResponse.md +21 -0
- data/docs/ObjectRolesResponse.md +17 -0
- data/docs/PackageMetadataResponse.md +3 -3
- data/docs/PublicationsPypiApi.md +237 -17
- data/docs/PypiApi.md +8 -4
- data/docs/PypiLegacyApi.md +1 -3
- data/docs/PypiMetadataApi.md +8 -4
- data/docs/PypiSimpleApi.md +1 -7
- data/docs/PythonPythonPackageContent.md +6 -6
- data/docs/PythonPythonPackageContentResponse.md +6 -6
- data/docs/RemotesPythonApi.md +245 -43
- data/docs/RepositoriesPythonApi.md +249 -53
- data/docs/RepositoriesPythonVersionsApi.md +5 -17
- data/lib/pulp_python_client/api/content_packages_api.rb +12 -21
- data/lib/pulp_python_client/api/distributions_pypi_api.rb +276 -24
- data/lib/pulp_python_client/api/publications_pypi_api.rb +276 -12
- data/lib/pulp_python_client/api/pypi_api.rb +1 -4
- data/lib/pulp_python_client/api/pypi_legacy_api.rb +0 -3
- data/lib/pulp_python_client/api/pypi_metadata_api.rb +1 -4
- data/lib/pulp_python_client/api/pypi_simple_api.rb +0 -9
- data/lib/pulp_python_client/api/remotes_python_api.rb +276 -27
- data/lib/pulp_python_client/api/repositories_python_api.rb +276 -30
- data/lib/pulp_python_client/api/repositories_python_versions_api.rb +0 -12
- data/lib/pulp_python_client/configuration.rb +2 -2
- data/lib/pulp_python_client/models/my_permissions_response.rb +213 -0
- data/lib/pulp_python_client/models/nested_role.rb +253 -0
- data/lib/pulp_python_client/models/nested_role_response.rb +234 -0
- data/lib/pulp_python_client/models/object_roles_response.rb +213 -0
- data/lib/pulp_python_client/models/package_metadata_response.rb +3 -3
- data/lib/pulp_python_client/models/package_upload_task_response.rb +2 -10
- data/lib/pulp_python_client/models/python_python_package_content.rb +6 -6
- data/lib/pulp_python_client/models/python_python_package_content_response.rb +6 -6
- data/lib/pulp_python_client/version.rb +1 -1
- data/lib/pulp_python_client.rb +4 -0
- data/spec/api/content_packages_api_spec.rb +6 -9
- data/spec/api/distributions_pypi_api_spec.rb +54 -8
- data/spec/api/publications_pypi_api_spec.rb +54 -4
- data/spec/api/pypi_api_spec.rb +0 -1
- data/spec/api/pypi_legacy_api_spec.rb +0 -1
- data/spec/api/pypi_metadata_api_spec.rb +0 -1
- data/spec/api/pypi_simple_api_spec.rb +0 -3
- data/spec/api/remotes_python_api_spec.rb +54 -9
- data/spec/api/repositories_python_api_spec.rb +54 -10
- data/spec/api/repositories_python_versions_api_spec.rb +0 -4
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/my_permissions_response_spec.rb +41 -0
- data/spec/models/nested_role_response_spec.rb +53 -0
- data/spec/models/nested_role_spec.rb +53 -0
- data/spec/models/object_roles_response_spec.rb +41 -0
- metadata +68 -52
data/docs/PublicationsPypiApi.md
CHANGED
|
@@ -1,19 +1,78 @@
|
|
|
1
1
|
# PulpPythonClient::PublicationsPypiApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *http://
|
|
3
|
+
All URIs are relative to *http://pulp*
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
+
[**add_role**](PublicationsPypiApi.md#add_role) | **POST** {python_python_publication_href}add_role/ | Add a role
|
|
7
8
|
[**create**](PublicationsPypiApi.md#create) | **POST** /pulp/api/v3/publications/python/pypi/ | Create a python publication
|
|
8
9
|
[**delete**](PublicationsPypiApi.md#delete) | **DELETE** {python_python_publication_href} | Delete a python publication
|
|
9
10
|
[**list**](PublicationsPypiApi.md#list) | **GET** /pulp/api/v3/publications/python/pypi/ | List python publications
|
|
11
|
+
[**list_roles**](PublicationsPypiApi.md#list_roles) | **GET** {python_python_publication_href}list_roles/ | List roles
|
|
12
|
+
[**my_permissions**](PublicationsPypiApi.md#my_permissions) | **GET** {python_python_publication_href}my_permissions/ | List user permissions
|
|
10
13
|
[**read**](PublicationsPypiApi.md#read) | **GET** {python_python_publication_href} | Inspect a python publication
|
|
14
|
+
[**remove_role**](PublicationsPypiApi.md#remove_role) | **POST** {python_python_publication_href}remove_role/ | Remove a role
|
|
11
15
|
|
|
12
16
|
|
|
13
17
|
|
|
18
|
+
## add_role
|
|
19
|
+
|
|
20
|
+
> NestedRoleResponse add_role(python_python_publication_href, nested_role)
|
|
21
|
+
|
|
22
|
+
Add a role
|
|
23
|
+
|
|
24
|
+
Add a role for this object to users/groups.
|
|
25
|
+
|
|
26
|
+
### Example
|
|
27
|
+
|
|
28
|
+
```ruby
|
|
29
|
+
# load the gem
|
|
30
|
+
require 'pulp_python_client'
|
|
31
|
+
# setup authorization
|
|
32
|
+
PulpPythonClient.configure do |config|
|
|
33
|
+
# Configure HTTP basic authorization: basicAuth
|
|
34
|
+
config.username = 'YOUR USERNAME'
|
|
35
|
+
config.password = 'YOUR PASSWORD'
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
api_instance = PulpPythonClient::PublicationsPypiApi.new
|
|
39
|
+
python_python_publication_href = 'python_python_publication_href_example' # String |
|
|
40
|
+
nested_role = PulpPythonClient::NestedRole.new # NestedRole |
|
|
41
|
+
|
|
42
|
+
begin
|
|
43
|
+
#Add a role
|
|
44
|
+
result = api_instance.add_role(python_python_publication_href, nested_role)
|
|
45
|
+
p result
|
|
46
|
+
rescue PulpPythonClient::ApiError => e
|
|
47
|
+
puts "Exception when calling PublicationsPypiApi->add_role: #{e}"
|
|
48
|
+
end
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Parameters
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
Name | Type | Description | Notes
|
|
55
|
+
------------- | ------------- | ------------- | -------------
|
|
56
|
+
**python_python_publication_href** | **String**| |
|
|
57
|
+
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
|
58
|
+
|
|
59
|
+
### Return type
|
|
60
|
+
|
|
61
|
+
[**NestedRoleResponse**](NestedRoleResponse.md)
|
|
62
|
+
|
|
63
|
+
### Authorization
|
|
64
|
+
|
|
65
|
+
[basicAuth](../README.md#basicAuth)
|
|
66
|
+
|
|
67
|
+
### HTTP request headers
|
|
68
|
+
|
|
69
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
70
|
+
- **Accept**: application/json
|
|
71
|
+
|
|
72
|
+
|
|
14
73
|
## create
|
|
15
74
|
|
|
16
|
-
> AsyncOperationResponse create(python_python_publication
|
|
75
|
+
> AsyncOperationResponse create(python_python_publication)
|
|
17
76
|
|
|
18
77
|
Create a python publication
|
|
19
78
|
|
|
@@ -33,13 +92,10 @@ end
|
|
|
33
92
|
|
|
34
93
|
api_instance = PulpPythonClient::PublicationsPypiApi.new
|
|
35
94
|
python_python_publication = PulpPythonClient::PythonPythonPublication.new # PythonPythonPublication |
|
|
36
|
-
opts = {
|
|
37
|
-
x_task_diagnostics: ['x_task_diagnostics_example'] # Array<String> | List of profilers to use on tasks.
|
|
38
|
-
}
|
|
39
95
|
|
|
40
96
|
begin
|
|
41
97
|
#Create a python publication
|
|
42
|
-
result = api_instance.create(python_python_publication
|
|
98
|
+
result = api_instance.create(python_python_publication)
|
|
43
99
|
p result
|
|
44
100
|
rescue PulpPythonClient::ApiError => e
|
|
45
101
|
puts "Exception when calling PublicationsPypiApi->create: #{e}"
|
|
@@ -52,7 +108,6 @@ end
|
|
|
52
108
|
Name | Type | Description | Notes
|
|
53
109
|
------------- | ------------- | ------------- | -------------
|
|
54
110
|
**python_python_publication** | [**PythonPythonPublication**](PythonPythonPublication.md)| |
|
|
55
|
-
**x_task_diagnostics** | [**Array<String>**](String.md)| List of profilers to use on tasks. | [optional]
|
|
56
111
|
|
|
57
112
|
### Return type
|
|
58
113
|
|
|
@@ -70,7 +125,7 @@ Name | Type | Description | Notes
|
|
|
70
125
|
|
|
71
126
|
## delete
|
|
72
127
|
|
|
73
|
-
> delete(python_python_publication_href
|
|
128
|
+
> delete(python_python_publication_href)
|
|
74
129
|
|
|
75
130
|
Delete a python publication
|
|
76
131
|
|
|
@@ -90,13 +145,10 @@ end
|
|
|
90
145
|
|
|
91
146
|
api_instance = PulpPythonClient::PublicationsPypiApi.new
|
|
92
147
|
python_python_publication_href = 'python_python_publication_href_example' # String |
|
|
93
|
-
opts = {
|
|
94
|
-
x_task_diagnostics: ['x_task_diagnostics_example'] # Array<String> | List of profilers to use on tasks.
|
|
95
|
-
}
|
|
96
148
|
|
|
97
149
|
begin
|
|
98
150
|
#Delete a python publication
|
|
99
|
-
api_instance.delete(python_python_publication_href
|
|
151
|
+
api_instance.delete(python_python_publication_href)
|
|
100
152
|
rescue PulpPythonClient::ApiError => e
|
|
101
153
|
puts "Exception when calling PublicationsPypiApi->delete: #{e}"
|
|
102
154
|
end
|
|
@@ -108,7 +160,6 @@ end
|
|
|
108
160
|
Name | Type | Description | Notes
|
|
109
161
|
------------- | ------------- | ------------- | -------------
|
|
110
162
|
**python_python_publication_href** | **String**| |
|
|
111
|
-
**x_task_diagnostics** | [**Array<String>**](String.md)| List of profilers to use on tasks. | [optional]
|
|
112
163
|
|
|
113
164
|
### Return type
|
|
114
165
|
|
|
@@ -146,7 +197,6 @@ end
|
|
|
146
197
|
|
|
147
198
|
api_instance = PulpPythonClient::PublicationsPypiApi.new
|
|
148
199
|
opts = {
|
|
149
|
-
x_task_diagnostics: ['x_task_diagnostics_example'], # Array<String> | List of profilers to use on tasks.
|
|
150
200
|
content: 'content_example', # String | Content Unit referenced by HREF
|
|
151
201
|
content__in: 'content__in_example', # String | Content Unit referenced by HREF
|
|
152
202
|
limit: 56, # Integer | Number of results to return per page.
|
|
@@ -181,7 +231,6 @@ end
|
|
|
181
231
|
|
|
182
232
|
Name | Type | Description | Notes
|
|
183
233
|
------------- | ------------- | ------------- | -------------
|
|
184
|
-
**x_task_diagnostics** | [**Array<String>**](String.md)| List of profilers to use on tasks. | [optional]
|
|
185
234
|
**content** | **String**| Content Unit referenced by HREF | [optional]
|
|
186
235
|
**content__in** | **String**| Content Unit referenced by HREF | [optional]
|
|
187
236
|
**limit** | **Integer**| Number of results to return per page. | [optional]
|
|
@@ -215,6 +264,124 @@ Name | Type | Description | Notes
|
|
|
215
264
|
- **Accept**: application/json
|
|
216
265
|
|
|
217
266
|
|
|
267
|
+
## list_roles
|
|
268
|
+
|
|
269
|
+
> ObjectRolesResponse list_roles(python_python_publication_href, opts)
|
|
270
|
+
|
|
271
|
+
List roles
|
|
272
|
+
|
|
273
|
+
List roles assigned to this object.
|
|
274
|
+
|
|
275
|
+
### Example
|
|
276
|
+
|
|
277
|
+
```ruby
|
|
278
|
+
# load the gem
|
|
279
|
+
require 'pulp_python_client'
|
|
280
|
+
# setup authorization
|
|
281
|
+
PulpPythonClient.configure do |config|
|
|
282
|
+
# Configure HTTP basic authorization: basicAuth
|
|
283
|
+
config.username = 'YOUR USERNAME'
|
|
284
|
+
config.password = 'YOUR PASSWORD'
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
api_instance = PulpPythonClient::PublicationsPypiApi.new
|
|
288
|
+
python_python_publication_href = 'python_python_publication_href_example' # String |
|
|
289
|
+
opts = {
|
|
290
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
|
291
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
begin
|
|
295
|
+
#List roles
|
|
296
|
+
result = api_instance.list_roles(python_python_publication_href, opts)
|
|
297
|
+
p result
|
|
298
|
+
rescue PulpPythonClient::ApiError => e
|
|
299
|
+
puts "Exception when calling PublicationsPypiApi->list_roles: #{e}"
|
|
300
|
+
end
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
### Parameters
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
Name | Type | Description | Notes
|
|
307
|
+
------------- | ------------- | ------------- | -------------
|
|
308
|
+
**python_python_publication_href** | **String**| |
|
|
309
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
|
310
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
|
311
|
+
|
|
312
|
+
### Return type
|
|
313
|
+
|
|
314
|
+
[**ObjectRolesResponse**](ObjectRolesResponse.md)
|
|
315
|
+
|
|
316
|
+
### Authorization
|
|
317
|
+
|
|
318
|
+
[basicAuth](../README.md#basicAuth)
|
|
319
|
+
|
|
320
|
+
### HTTP request headers
|
|
321
|
+
|
|
322
|
+
- **Content-Type**: Not defined
|
|
323
|
+
- **Accept**: application/json
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
## my_permissions
|
|
327
|
+
|
|
328
|
+
> MyPermissionsResponse my_permissions(python_python_publication_href, opts)
|
|
329
|
+
|
|
330
|
+
List user permissions
|
|
331
|
+
|
|
332
|
+
List permissions available to the current user on this object.
|
|
333
|
+
|
|
334
|
+
### Example
|
|
335
|
+
|
|
336
|
+
```ruby
|
|
337
|
+
# load the gem
|
|
338
|
+
require 'pulp_python_client'
|
|
339
|
+
# setup authorization
|
|
340
|
+
PulpPythonClient.configure do |config|
|
|
341
|
+
# Configure HTTP basic authorization: basicAuth
|
|
342
|
+
config.username = 'YOUR USERNAME'
|
|
343
|
+
config.password = 'YOUR PASSWORD'
|
|
344
|
+
end
|
|
345
|
+
|
|
346
|
+
api_instance = PulpPythonClient::PublicationsPypiApi.new
|
|
347
|
+
python_python_publication_href = 'python_python_publication_href_example' # String |
|
|
348
|
+
opts = {
|
|
349
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
|
350
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
|
351
|
+
}
|
|
352
|
+
|
|
353
|
+
begin
|
|
354
|
+
#List user permissions
|
|
355
|
+
result = api_instance.my_permissions(python_python_publication_href, opts)
|
|
356
|
+
p result
|
|
357
|
+
rescue PulpPythonClient::ApiError => e
|
|
358
|
+
puts "Exception when calling PublicationsPypiApi->my_permissions: #{e}"
|
|
359
|
+
end
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
### Parameters
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
Name | Type | Description | Notes
|
|
366
|
+
------------- | ------------- | ------------- | -------------
|
|
367
|
+
**python_python_publication_href** | **String**| |
|
|
368
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
|
369
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
|
370
|
+
|
|
371
|
+
### Return type
|
|
372
|
+
|
|
373
|
+
[**MyPermissionsResponse**](MyPermissionsResponse.md)
|
|
374
|
+
|
|
375
|
+
### Authorization
|
|
376
|
+
|
|
377
|
+
[basicAuth](../README.md#basicAuth)
|
|
378
|
+
|
|
379
|
+
### HTTP request headers
|
|
380
|
+
|
|
381
|
+
- **Content-Type**: Not defined
|
|
382
|
+
- **Accept**: application/json
|
|
383
|
+
|
|
384
|
+
|
|
218
385
|
## read
|
|
219
386
|
|
|
220
387
|
> PythonPythonPublicationResponse read(python_python_publication_href, opts)
|
|
@@ -238,7 +405,6 @@ end
|
|
|
238
405
|
api_instance = PulpPythonClient::PublicationsPypiApi.new
|
|
239
406
|
python_python_publication_href = 'python_python_publication_href_example' # String |
|
|
240
407
|
opts = {
|
|
241
|
-
x_task_diagnostics: ['x_task_diagnostics_example'], # Array<String> | List of profilers to use on tasks.
|
|
242
408
|
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
|
243
409
|
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
|
244
410
|
}
|
|
@@ -258,7 +424,6 @@ end
|
|
|
258
424
|
Name | Type | Description | Notes
|
|
259
425
|
------------- | ------------- | ------------- | -------------
|
|
260
426
|
**python_python_publication_href** | **String**| |
|
|
261
|
-
**x_task_diagnostics** | [**Array<String>**](String.md)| List of profilers to use on tasks. | [optional]
|
|
262
427
|
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
|
263
428
|
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
|
264
429
|
|
|
@@ -275,3 +440,58 @@ Name | Type | Description | Notes
|
|
|
275
440
|
- **Content-Type**: Not defined
|
|
276
441
|
- **Accept**: application/json
|
|
277
442
|
|
|
443
|
+
|
|
444
|
+
## remove_role
|
|
445
|
+
|
|
446
|
+
> NestedRoleResponse remove_role(python_python_publication_href, nested_role)
|
|
447
|
+
|
|
448
|
+
Remove a role
|
|
449
|
+
|
|
450
|
+
Remove a role for this object from users/groups.
|
|
451
|
+
|
|
452
|
+
### Example
|
|
453
|
+
|
|
454
|
+
```ruby
|
|
455
|
+
# load the gem
|
|
456
|
+
require 'pulp_python_client'
|
|
457
|
+
# setup authorization
|
|
458
|
+
PulpPythonClient.configure do |config|
|
|
459
|
+
# Configure HTTP basic authorization: basicAuth
|
|
460
|
+
config.username = 'YOUR USERNAME'
|
|
461
|
+
config.password = 'YOUR PASSWORD'
|
|
462
|
+
end
|
|
463
|
+
|
|
464
|
+
api_instance = PulpPythonClient::PublicationsPypiApi.new
|
|
465
|
+
python_python_publication_href = 'python_python_publication_href_example' # String |
|
|
466
|
+
nested_role = PulpPythonClient::NestedRole.new # NestedRole |
|
|
467
|
+
|
|
468
|
+
begin
|
|
469
|
+
#Remove a role
|
|
470
|
+
result = api_instance.remove_role(python_python_publication_href, nested_role)
|
|
471
|
+
p result
|
|
472
|
+
rescue PulpPythonClient::ApiError => e
|
|
473
|
+
puts "Exception when calling PublicationsPypiApi->remove_role: #{e}"
|
|
474
|
+
end
|
|
475
|
+
```
|
|
476
|
+
|
|
477
|
+
### Parameters
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
Name | Type | Description | Notes
|
|
481
|
+
------------- | ------------- | ------------- | -------------
|
|
482
|
+
**python_python_publication_href** | **String**| |
|
|
483
|
+
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
|
484
|
+
|
|
485
|
+
### Return type
|
|
486
|
+
|
|
487
|
+
[**NestedRoleResponse**](NestedRoleResponse.md)
|
|
488
|
+
|
|
489
|
+
### Authorization
|
|
490
|
+
|
|
491
|
+
[basicAuth](../README.md#basicAuth)
|
|
492
|
+
|
|
493
|
+
### HTTP request headers
|
|
494
|
+
|
|
495
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
496
|
+
- **Accept**: application/json
|
|
497
|
+
|
data/docs/PypiApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# PulpPythonClient::PypiApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *http://
|
|
3
|
+
All URIs are relative to *http://pulp*
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
@@ -21,11 +21,16 @@ Gets package summary stats of index.
|
|
|
21
21
|
```ruby
|
|
22
22
|
# load the gem
|
|
23
23
|
require 'pulp_python_client'
|
|
24
|
+
# setup authorization
|
|
25
|
+
PulpPythonClient.configure do |config|
|
|
26
|
+
# Configure HTTP basic authorization: basicAuth
|
|
27
|
+
config.username = 'YOUR USERNAME'
|
|
28
|
+
config.password = 'YOUR PASSWORD'
|
|
29
|
+
end
|
|
24
30
|
|
|
25
31
|
api_instance = PulpPythonClient::PypiApi.new
|
|
26
32
|
path = 'path_example' # String |
|
|
27
33
|
opts = {
|
|
28
|
-
x_task_diagnostics: ['x_task_diagnostics_example'], # Array<String> | List of profilers to use on tasks.
|
|
29
34
|
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
|
30
35
|
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
|
31
36
|
}
|
|
@@ -45,7 +50,6 @@ end
|
|
|
45
50
|
Name | Type | Description | Notes
|
|
46
51
|
------------- | ------------- | ------------- | -------------
|
|
47
52
|
**path** | **String**| |
|
|
48
|
-
**x_task_diagnostics** | [**Array<String>**](String.md)| List of profilers to use on tasks. | [optional]
|
|
49
53
|
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
|
50
54
|
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
|
51
55
|
|
|
@@ -55,7 +59,7 @@ Name | Type | Description | Notes
|
|
|
55
59
|
|
|
56
60
|
### Authorization
|
|
57
61
|
|
|
58
|
-
|
|
62
|
+
[basicAuth](../README.md#basicAuth)
|
|
59
63
|
|
|
60
64
|
### HTTP request headers
|
|
61
65
|
|
data/docs/PypiLegacyApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# PulpPythonClient::PypiLegacyApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *http://
|
|
3
|
+
All URIs are relative to *http://pulp*
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
@@ -33,7 +33,6 @@ path = 'path_example' # String |
|
|
|
33
33
|
content = File.new('/path/to/file') # File | A Python package release file to upload to the index.
|
|
34
34
|
sha256_digest = 'sha256_digest_example' # String | SHA256 of package to validate upload integrity.
|
|
35
35
|
opts = {
|
|
36
|
-
x_task_diagnostics: ['x_task_diagnostics_example'], # Array<String> | List of profilers to use on tasks.
|
|
37
36
|
action: 'file_upload' # String | Defaults to `file_upload`, don't change it or request will fail!
|
|
38
37
|
}
|
|
39
38
|
|
|
@@ -54,7 +53,6 @@ Name | Type | Description | Notes
|
|
|
54
53
|
**path** | **String**| |
|
|
55
54
|
**content** | **File**| A Python package release file to upload to the index. |
|
|
56
55
|
**sha256_digest** | **String**| SHA256 of package to validate upload integrity. |
|
|
57
|
-
**x_task_diagnostics** | [**Array<String>**](String.md)| List of profilers to use on tasks. | [optional]
|
|
58
56
|
**action** | **String**| Defaults to `file_upload`, don't change it or request will fail! | [optional] [default to 'file_upload']
|
|
59
57
|
|
|
60
58
|
### Return type
|
data/docs/PypiMetadataApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# PulpPythonClient::PypiMetadataApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *http://
|
|
3
|
+
All URIs are relative to *http://pulp*
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
@@ -21,12 +21,17 @@ Retrieves the package's core-metadata specified by https://packaging.python.org/
|
|
|
21
21
|
```ruby
|
|
22
22
|
# load the gem
|
|
23
23
|
require 'pulp_python_client'
|
|
24
|
+
# setup authorization
|
|
25
|
+
PulpPythonClient.configure do |config|
|
|
26
|
+
# Configure HTTP basic authorization: basicAuth
|
|
27
|
+
config.username = 'YOUR USERNAME'
|
|
28
|
+
config.password = 'YOUR PASSWORD'
|
|
29
|
+
end
|
|
24
30
|
|
|
25
31
|
api_instance = PulpPythonClient::PypiMetadataApi.new
|
|
26
32
|
meta = 'meta_example' # String |
|
|
27
33
|
path = 'path_example' # String |
|
|
28
34
|
opts = {
|
|
29
|
-
x_task_diagnostics: ['x_task_diagnostics_example'], # Array<String> | List of profilers to use on tasks.
|
|
30
35
|
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
|
31
36
|
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
|
32
37
|
}
|
|
@@ -47,7 +52,6 @@ Name | Type | Description | Notes
|
|
|
47
52
|
------------- | ------------- | ------------- | -------------
|
|
48
53
|
**meta** | **String**| |
|
|
49
54
|
**path** | **String**| |
|
|
50
|
-
**x_task_diagnostics** | [**Array<String>**](String.md)| List of profilers to use on tasks. | [optional]
|
|
51
55
|
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
|
52
56
|
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
|
53
57
|
|
|
@@ -57,7 +61,7 @@ Name | Type | Description | Notes
|
|
|
57
61
|
|
|
58
62
|
### Authorization
|
|
59
63
|
|
|
60
|
-
|
|
64
|
+
[basicAuth](../README.md#basicAuth)
|
|
61
65
|
|
|
62
66
|
### HTTP request headers
|
|
63
67
|
|
data/docs/PypiSimpleApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# PulpPythonClient::PypiSimpleApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *http://
|
|
3
|
+
All URIs are relative to *http://pulp*
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
@@ -35,7 +35,6 @@ path = 'path_example' # String |
|
|
|
35
35
|
content = File.new('/path/to/file') # File | A Python package release file to upload to the index.
|
|
36
36
|
sha256_digest = 'sha256_digest_example' # String | SHA256 of package to validate upload integrity.
|
|
37
37
|
opts = {
|
|
38
|
-
x_task_diagnostics: ['x_task_diagnostics_example'], # Array<String> | List of profilers to use on tasks.
|
|
39
38
|
action: 'file_upload' # String | Defaults to `file_upload`, don't change it or request will fail!
|
|
40
39
|
}
|
|
41
40
|
|
|
@@ -56,7 +55,6 @@ Name | Type | Description | Notes
|
|
|
56
55
|
**path** | **String**| |
|
|
57
56
|
**content** | **File**| A Python package release file to upload to the index. |
|
|
58
57
|
**sha256_digest** | **String**| SHA256 of package to validate upload integrity. |
|
|
59
|
-
**x_task_diagnostics** | [**Array<String>**](String.md)| List of profilers to use on tasks. | [optional]
|
|
60
58
|
**action** | **String**| Defaults to `file_upload`, don't change it or request will fail! | [optional] [default to 'file_upload']
|
|
61
59
|
|
|
62
60
|
### Return type
|
|
@@ -97,7 +95,6 @@ api_instance = PulpPythonClient::PypiSimpleApi.new
|
|
|
97
95
|
package = 'package_example' # String |
|
|
98
96
|
path = 'path_example' # String |
|
|
99
97
|
opts = {
|
|
100
|
-
x_task_diagnostics: ['x_task_diagnostics_example'], # Array<String> | List of profilers to use on tasks.
|
|
101
98
|
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
|
102
99
|
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
|
103
100
|
}
|
|
@@ -117,7 +114,6 @@ Name | Type | Description | Notes
|
|
|
117
114
|
------------- | ------------- | ------------- | -------------
|
|
118
115
|
**package** | **String**| |
|
|
119
116
|
**path** | **String**| |
|
|
120
|
-
**x_task_diagnostics** | [**Array<String>**](String.md)| List of profilers to use on tasks. | [optional]
|
|
121
117
|
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
|
122
118
|
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
|
123
119
|
|
|
@@ -158,7 +154,6 @@ end
|
|
|
158
154
|
api_instance = PulpPythonClient::PypiSimpleApi.new
|
|
159
155
|
path = 'path_example' # String |
|
|
160
156
|
opts = {
|
|
161
|
-
x_task_diagnostics: ['x_task_diagnostics_example'], # Array<String> | List of profilers to use on tasks.
|
|
162
157
|
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
|
163
158
|
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
|
164
159
|
}
|
|
@@ -177,7 +172,6 @@ end
|
|
|
177
172
|
Name | Type | Description | Notes
|
|
178
173
|
------------- | ------------- | ------------- | -------------
|
|
179
174
|
**path** | **String**| |
|
|
180
|
-
**x_task_diagnostics** | [**Array<String>**](String.md)| List of profilers to use on tasks. | [optional]
|
|
181
175
|
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
|
182
176
|
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
|
183
177
|
|
|
@@ -23,14 +23,14 @@ Name | Type | Description | Notes
|
|
|
23
23
|
**license** | **String** | Text indicating the license covering the distribution | [optional]
|
|
24
24
|
**requires_python** | **String** | The Python version(s) that the distribution is guaranteed to be compatible with. | [optional]
|
|
25
25
|
**project_url** | **String** | A browsable URL for the project and a label for it, separated by a comma. | [optional]
|
|
26
|
-
**project_urls** | [**
|
|
26
|
+
**project_urls** | [**AnyType**](.md) | A dictionary of labels and URLs for the project. | [optional]
|
|
27
27
|
**platform** | **String** | A comma-separated list of platform specifications, summarizing the operating systems supported by the package. | [optional]
|
|
28
28
|
**supported_platform** | **String** | Field to specify the OS and CPU for which the binary package was compiled. | [optional]
|
|
29
|
-
**requires_dist** | [**
|
|
30
|
-
**provides_dist** | [**
|
|
31
|
-
**obsoletes_dist** | [**
|
|
32
|
-
**requires_external** | [**
|
|
33
|
-
**classifiers** | [**
|
|
29
|
+
**requires_dist** | [**AnyType**](.md) | A JSON list containing names of some other distutils project required by this distribution. | [optional]
|
|
30
|
+
**provides_dist** | [**AnyType**](.md) | A JSON list containing names of a Distutils project which is contained within this distribution. | [optional]
|
|
31
|
+
**obsoletes_dist** | [**AnyType**](.md) | A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time. | [optional]
|
|
32
|
+
**requires_external** | [**AnyType**](.md) | A JSON list containing some dependency in the system that the distribution is to be used. | [optional]
|
|
33
|
+
**classifiers** | [**AnyType**](.md) | A JSON list containing classification values for a Python package. | [optional]
|
|
34
34
|
|
|
35
35
|
## Code Sample
|
|
36
36
|
|
|
@@ -27,14 +27,14 @@ Name | Type | Description | Notes
|
|
|
27
27
|
**license** | **String** | Text indicating the license covering the distribution | [optional]
|
|
28
28
|
**requires_python** | **String** | The Python version(s) that the distribution is guaranteed to be compatible with. | [optional]
|
|
29
29
|
**project_url** | **String** | A browsable URL for the project and a label for it, separated by a comma. | [optional]
|
|
30
|
-
**project_urls** | [**
|
|
30
|
+
**project_urls** | [**AnyType**](.md) | A dictionary of labels and URLs for the project. | [optional]
|
|
31
31
|
**platform** | **String** | A comma-separated list of platform specifications, summarizing the operating systems supported by the package. | [optional]
|
|
32
32
|
**supported_platform** | **String** | Field to specify the OS and CPU for which the binary package was compiled. | [optional]
|
|
33
|
-
**requires_dist** | [**
|
|
34
|
-
**provides_dist** | [**
|
|
35
|
-
**obsoletes_dist** | [**
|
|
36
|
-
**requires_external** | [**
|
|
37
|
-
**classifiers** | [**
|
|
33
|
+
**requires_dist** | [**AnyType**](.md) | A JSON list containing names of some other distutils project required by this distribution. | [optional]
|
|
34
|
+
**provides_dist** | [**AnyType**](.md) | A JSON list containing names of a Distutils project which is contained within this distribution. | [optional]
|
|
35
|
+
**obsoletes_dist** | [**AnyType**](.md) | A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time. | [optional]
|
|
36
|
+
**requires_external** | [**AnyType**](.md) | A JSON list containing some dependency in the system that the distribution is to be used. | [optional]
|
|
37
|
+
**classifiers** | [**AnyType**](.md) | A JSON list containing classification values for a Python package. | [optional]
|
|
38
38
|
|
|
39
39
|
## Code Sample
|
|
40
40
|
|