pulp_rpm_client 3.18.0.dev1651206466 → 3.18.0.dev1651552515

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of pulp_rpm_client might be problematic. Click here for more details.

Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +36 -8
  3. data/docs/AcsRpmApi.md +228 -0
  4. data/docs/DistributionsRpmApi.md +228 -0
  5. data/docs/MyPermissionsResponse.md +17 -0
  6. data/docs/NestedRole.md +21 -0
  7. data/docs/NestedRoleResponse.md +21 -0
  8. data/docs/ObjectRolesResponse.md +17 -0
  9. data/docs/PublicationsRpmApi.md +228 -0
  10. data/docs/RemotesRpmApi.md +228 -0
  11. data/docs/RemotesUlnApi.md +228 -0
  12. data/docs/RepositoriesRpmApi.md +228 -0
  13. data/lib/pulp_rpm_client/api/acs_rpm_api.rb +268 -0
  14. data/lib/pulp_rpm_client/api/distributions_rpm_api.rb +268 -0
  15. data/lib/pulp_rpm_client/api/publications_rpm_api.rb +268 -0
  16. data/lib/pulp_rpm_client/api/remotes_rpm_api.rb +268 -0
  17. data/lib/pulp_rpm_client/api/remotes_uln_api.rb +268 -0
  18. data/lib/pulp_rpm_client/api/repositories_rpm_api.rb +268 -0
  19. data/lib/pulp_rpm_client/models/my_permissions_response.rb +213 -0
  20. data/lib/pulp_rpm_client/models/nested_role.rb +234 -0
  21. data/lib/pulp_rpm_client/models/nested_role_response.rb +234 -0
  22. data/lib/pulp_rpm_client/models/object_roles_response.rb +213 -0
  23. data/lib/pulp_rpm_client/version.rb +1 -1
  24. data/lib/pulp_rpm_client.rb +4 -0
  25. data/spec/api/acs_rpm_api_spec.rb +50 -0
  26. data/spec/api/distributions_rpm_api_spec.rb +50 -0
  27. data/spec/api/publications_rpm_api_spec.rb +50 -0
  28. data/spec/api/remotes_rpm_api_spec.rb +50 -0
  29. data/spec/api/remotes_uln_api_spec.rb +50 -0
  30. data/spec/api/repositories_rpm_api_spec.rb +50 -0
  31. data/spec/models/my_permissions_response_spec.rb +41 -0
  32. data/spec/models/nested_role_response_spec.rb +53 -0
  33. data/spec/models/nested_role_spec.rb +53 -0
  34. data/spec/models/object_roles_response_spec.rb +41 -0
  35. metadata +18 -2
@@ -0,0 +1,21 @@
1
+ # PulpRpmClient::NestedRole
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **users** | **Array<String>** | | [optional]
8
+ **groups** | **Array<String>** | | [optional]
9
+ **role** | **String** | |
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'PulpRpmClient'
15
+
16
+ instance = PulpRpmClient::NestedRole.new(users: null,
17
+ groups: null,
18
+ role: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,21 @@
1
+ # PulpRpmClient::NestedRoleResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **users** | **Array<String>** | | [optional]
8
+ **groups** | **Array<String>** | | [optional]
9
+ **role** | **String** | |
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'PulpRpmClient'
15
+
16
+ instance = PulpRpmClient::NestedRoleResponse.new(users: null,
17
+ groups: null,
18
+ role: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,17 @@
1
+ # PulpRpmClient::ObjectRolesResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **roles** | [**Array<NestedRoleResponse>**](NestedRoleResponse.md) | |
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'PulpRpmClient'
13
+
14
+ instance = PulpRpmClient::ObjectRolesResponse.new(roles: null)
15
+ ```
16
+
17
+
@@ -4,13 +4,71 @@ All URIs are relative to *https://pulp*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**add_role**](PublicationsRpmApi.md#add_role) | **POST** {rpm_rpm_publication_href}add_role/ |
7
8
  [**create**](PublicationsRpmApi.md#create) | **POST** /pulp/api/v3/publications/rpm/rpm/ | Create a rpm publication
8
9
  [**delete**](PublicationsRpmApi.md#delete) | **DELETE** {rpm_rpm_publication_href} | Delete a rpm publication
9
10
  [**list**](PublicationsRpmApi.md#list) | **GET** /pulp/api/v3/publications/rpm/rpm/ | List rpm publications
11
+ [**list_roles**](PublicationsRpmApi.md#list_roles) | **GET** {rpm_rpm_publication_href}list_roles/ |
12
+ [**my_permissions**](PublicationsRpmApi.md#my_permissions) | **GET** {rpm_rpm_publication_href}my_permissions/ |
10
13
  [**read**](PublicationsRpmApi.md#read) | **GET** {rpm_rpm_publication_href} | Inspect a rpm publication
14
+ [**remove_role**](PublicationsRpmApi.md#remove_role) | **POST** {rpm_rpm_publication_href}remove_role/ |
11
15
 
12
16
 
13
17
 
18
+ ## add_role
19
+
20
+ > NestedRoleResponse add_role(rpm_rpm_publication_href, nested_role)
21
+
22
+
23
+
24
+ Add a role for this object to users/groups.
25
+
26
+ ### Example
27
+
28
+ ```ruby
29
+ # load the gem
30
+ require 'pulp_rpm_client'
31
+ # setup authorization
32
+ PulpRpmClient.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 = PulpRpmClient::PublicationsRpmApi.new
39
+ rpm_rpm_publication_href = 'rpm_rpm_publication_href_example' # String |
40
+ nested_role = PulpRpmClient::NestedRole.new # NestedRole |
41
+
42
+ begin
43
+ result = api_instance.add_role(rpm_rpm_publication_href, nested_role)
44
+ p result
45
+ rescue PulpRpmClient::ApiError => e
46
+ puts "Exception when calling PublicationsRpmApi->add_role: #{e}"
47
+ end
48
+ ```
49
+
50
+ ### Parameters
51
+
52
+
53
+ Name | Type | Description | Notes
54
+ ------------- | ------------- | ------------- | -------------
55
+ **rpm_rpm_publication_href** | **String**| |
56
+ **nested_role** | [**NestedRole**](NestedRole.md)| |
57
+
58
+ ### Return type
59
+
60
+ [**NestedRoleResponse**](NestedRoleResponse.md)
61
+
62
+ ### Authorization
63
+
64
+ [basicAuth](../README.md#basicAuth)
65
+
66
+ ### HTTP request headers
67
+
68
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
69
+ - **Accept**: application/json
70
+
71
+
14
72
  ## create
15
73
 
16
74
  > AsyncOperationResponse create(rpm_rpm_publication)
@@ -197,6 +255,122 @@ Name | Type | Description | Notes
197
255
  - **Accept**: application/json
198
256
 
199
257
 
258
+ ## list_roles
259
+
260
+ > ObjectRolesResponse list_roles(rpm_rpm_publication_href, opts)
261
+
262
+
263
+
264
+ List roles assigned to this object.
265
+
266
+ ### Example
267
+
268
+ ```ruby
269
+ # load the gem
270
+ require 'pulp_rpm_client'
271
+ # setup authorization
272
+ PulpRpmClient.configure do |config|
273
+ # Configure HTTP basic authorization: basicAuth
274
+ config.username = 'YOUR USERNAME'
275
+ config.password = 'YOUR PASSWORD'
276
+ end
277
+
278
+ api_instance = PulpRpmClient::PublicationsRpmApi.new
279
+ rpm_rpm_publication_href = 'rpm_rpm_publication_href_example' # String |
280
+ opts = {
281
+ fields: 'fields_example', # String | A list of fields to include in the response.
282
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
283
+ }
284
+
285
+ begin
286
+ result = api_instance.list_roles(rpm_rpm_publication_href, opts)
287
+ p result
288
+ rescue PulpRpmClient::ApiError => e
289
+ puts "Exception when calling PublicationsRpmApi->list_roles: #{e}"
290
+ end
291
+ ```
292
+
293
+ ### Parameters
294
+
295
+
296
+ Name | Type | Description | Notes
297
+ ------------- | ------------- | ------------- | -------------
298
+ **rpm_rpm_publication_href** | **String**| |
299
+ **fields** | **String**| A list of fields to include in the response. | [optional]
300
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
301
+
302
+ ### Return type
303
+
304
+ [**ObjectRolesResponse**](ObjectRolesResponse.md)
305
+
306
+ ### Authorization
307
+
308
+ [basicAuth](../README.md#basicAuth)
309
+
310
+ ### HTTP request headers
311
+
312
+ - **Content-Type**: Not defined
313
+ - **Accept**: application/json
314
+
315
+
316
+ ## my_permissions
317
+
318
+ > MyPermissionsResponse my_permissions(rpm_rpm_publication_href, opts)
319
+
320
+
321
+
322
+ List permissions available to the current user on this object.
323
+
324
+ ### Example
325
+
326
+ ```ruby
327
+ # load the gem
328
+ require 'pulp_rpm_client'
329
+ # setup authorization
330
+ PulpRpmClient.configure do |config|
331
+ # Configure HTTP basic authorization: basicAuth
332
+ config.username = 'YOUR USERNAME'
333
+ config.password = 'YOUR PASSWORD'
334
+ end
335
+
336
+ api_instance = PulpRpmClient::PublicationsRpmApi.new
337
+ rpm_rpm_publication_href = 'rpm_rpm_publication_href_example' # String |
338
+ opts = {
339
+ fields: 'fields_example', # String | A list of fields to include in the response.
340
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
341
+ }
342
+
343
+ begin
344
+ result = api_instance.my_permissions(rpm_rpm_publication_href, opts)
345
+ p result
346
+ rescue PulpRpmClient::ApiError => e
347
+ puts "Exception when calling PublicationsRpmApi->my_permissions: #{e}"
348
+ end
349
+ ```
350
+
351
+ ### Parameters
352
+
353
+
354
+ Name | Type | Description | Notes
355
+ ------------- | ------------- | ------------- | -------------
356
+ **rpm_rpm_publication_href** | **String**| |
357
+ **fields** | **String**| A list of fields to include in the response. | [optional]
358
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
359
+
360
+ ### Return type
361
+
362
+ [**MyPermissionsResponse**](MyPermissionsResponse.md)
363
+
364
+ ### Authorization
365
+
366
+ [basicAuth](../README.md#basicAuth)
367
+
368
+ ### HTTP request headers
369
+
370
+ - **Content-Type**: Not defined
371
+ - **Accept**: application/json
372
+
373
+
200
374
  ## read
201
375
 
202
376
  > RpmRpmPublicationResponse read(rpm_rpm_publication_href, opts)
@@ -255,3 +429,57 @@ Name | Type | Description | Notes
255
429
  - **Content-Type**: Not defined
256
430
  - **Accept**: application/json
257
431
 
432
+
433
+ ## remove_role
434
+
435
+ > NestedRoleResponse remove_role(rpm_rpm_publication_href, nested_role)
436
+
437
+
438
+
439
+ Remove a role for this object from users/groups.
440
+
441
+ ### Example
442
+
443
+ ```ruby
444
+ # load the gem
445
+ require 'pulp_rpm_client'
446
+ # setup authorization
447
+ PulpRpmClient.configure do |config|
448
+ # Configure HTTP basic authorization: basicAuth
449
+ config.username = 'YOUR USERNAME'
450
+ config.password = 'YOUR PASSWORD'
451
+ end
452
+
453
+ api_instance = PulpRpmClient::PublicationsRpmApi.new
454
+ rpm_rpm_publication_href = 'rpm_rpm_publication_href_example' # String |
455
+ nested_role = PulpRpmClient::NestedRole.new # NestedRole |
456
+
457
+ begin
458
+ result = api_instance.remove_role(rpm_rpm_publication_href, nested_role)
459
+ p result
460
+ rescue PulpRpmClient::ApiError => e
461
+ puts "Exception when calling PublicationsRpmApi->remove_role: #{e}"
462
+ end
463
+ ```
464
+
465
+ ### Parameters
466
+
467
+
468
+ Name | Type | Description | Notes
469
+ ------------- | ------------- | ------------- | -------------
470
+ **rpm_rpm_publication_href** | **String**| |
471
+ **nested_role** | [**NestedRole**](NestedRole.md)| |
472
+
473
+ ### Return type
474
+
475
+ [**NestedRoleResponse**](NestedRoleResponse.md)
476
+
477
+ ### Authorization
478
+
479
+ [basicAuth](../README.md#basicAuth)
480
+
481
+ ### HTTP request headers
482
+
483
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
484
+ - **Accept**: application/json
485
+
@@ -4,15 +4,73 @@ All URIs are relative to *https://pulp*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**add_role**](RemotesRpmApi.md#add_role) | **POST** {rpm_rpm_remote_href}add_role/ |
7
8
  [**create**](RemotesRpmApi.md#create) | **POST** /pulp/api/v3/remotes/rpm/rpm/ | Create a rpm remote
8
9
  [**delete**](RemotesRpmApi.md#delete) | **DELETE** {rpm_rpm_remote_href} | Delete a rpm remote
9
10
  [**list**](RemotesRpmApi.md#list) | **GET** /pulp/api/v3/remotes/rpm/rpm/ | List rpm remotes
11
+ [**list_roles**](RemotesRpmApi.md#list_roles) | **GET** {rpm_rpm_remote_href}list_roles/ |
12
+ [**my_permissions**](RemotesRpmApi.md#my_permissions) | **GET** {rpm_rpm_remote_href}my_permissions/ |
10
13
  [**partial_update**](RemotesRpmApi.md#partial_update) | **PATCH** {rpm_rpm_remote_href} | Update a rpm remote
11
14
  [**read**](RemotesRpmApi.md#read) | **GET** {rpm_rpm_remote_href} | Inspect a rpm remote
15
+ [**remove_role**](RemotesRpmApi.md#remove_role) | **POST** {rpm_rpm_remote_href}remove_role/ |
12
16
  [**update**](RemotesRpmApi.md#update) | **PUT** {rpm_rpm_remote_href} | Update a rpm remote
13
17
 
14
18
 
15
19
 
20
+ ## add_role
21
+
22
+ > NestedRoleResponse add_role(rpm_rpm_remote_href, nested_role)
23
+
24
+
25
+
26
+ Add a role for this object to users/groups.
27
+
28
+ ### Example
29
+
30
+ ```ruby
31
+ # load the gem
32
+ require 'pulp_rpm_client'
33
+ # setup authorization
34
+ PulpRpmClient.configure do |config|
35
+ # Configure HTTP basic authorization: basicAuth
36
+ config.username = 'YOUR USERNAME'
37
+ config.password = 'YOUR PASSWORD'
38
+ end
39
+
40
+ api_instance = PulpRpmClient::RemotesRpmApi.new
41
+ rpm_rpm_remote_href = 'rpm_rpm_remote_href_example' # String |
42
+ nested_role = PulpRpmClient::NestedRole.new # NestedRole |
43
+
44
+ begin
45
+ result = api_instance.add_role(rpm_rpm_remote_href, nested_role)
46
+ p result
47
+ rescue PulpRpmClient::ApiError => e
48
+ puts "Exception when calling RemotesRpmApi->add_role: #{e}"
49
+ end
50
+ ```
51
+
52
+ ### Parameters
53
+
54
+
55
+ Name | Type | Description | Notes
56
+ ------------- | ------------- | ------------- | -------------
57
+ **rpm_rpm_remote_href** | **String**| |
58
+ **nested_role** | [**NestedRole**](NestedRole.md)| |
59
+
60
+ ### Return type
61
+
62
+ [**NestedRoleResponse**](NestedRoleResponse.md)
63
+
64
+ ### Authorization
65
+
66
+ [basicAuth](../README.md#basicAuth)
67
+
68
+ ### HTTP request headers
69
+
70
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
71
+ - **Accept**: application/json
72
+
73
+
16
74
  ## create
17
75
 
18
76
  > RpmRpmRemoteResponse create(rpm_rpm_remote)
@@ -206,6 +264,122 @@ Name | Type | Description | Notes
206
264
  - **Accept**: application/json
207
265
 
208
266
 
267
+ ## list_roles
268
+
269
+ > ObjectRolesResponse list_roles(rpm_rpm_remote_href, opts)
270
+
271
+
272
+
273
+ List roles assigned to this object.
274
+
275
+ ### Example
276
+
277
+ ```ruby
278
+ # load the gem
279
+ require 'pulp_rpm_client'
280
+ # setup authorization
281
+ PulpRpmClient.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 = PulpRpmClient::RemotesRpmApi.new
288
+ rpm_rpm_remote_href = 'rpm_rpm_remote_href_example' # String |
289
+ opts = {
290
+ fields: 'fields_example', # String | A list of fields to include in the response.
291
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
292
+ }
293
+
294
+ begin
295
+ result = api_instance.list_roles(rpm_rpm_remote_href, opts)
296
+ p result
297
+ rescue PulpRpmClient::ApiError => e
298
+ puts "Exception when calling RemotesRpmApi->list_roles: #{e}"
299
+ end
300
+ ```
301
+
302
+ ### Parameters
303
+
304
+
305
+ Name | Type | Description | Notes
306
+ ------------- | ------------- | ------------- | -------------
307
+ **rpm_rpm_remote_href** | **String**| |
308
+ **fields** | **String**| A list of fields to include in the response. | [optional]
309
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
310
+
311
+ ### Return type
312
+
313
+ [**ObjectRolesResponse**](ObjectRolesResponse.md)
314
+
315
+ ### Authorization
316
+
317
+ [basicAuth](../README.md#basicAuth)
318
+
319
+ ### HTTP request headers
320
+
321
+ - **Content-Type**: Not defined
322
+ - **Accept**: application/json
323
+
324
+
325
+ ## my_permissions
326
+
327
+ > MyPermissionsResponse my_permissions(rpm_rpm_remote_href, opts)
328
+
329
+
330
+
331
+ List permissions available to the current user on this object.
332
+
333
+ ### Example
334
+
335
+ ```ruby
336
+ # load the gem
337
+ require 'pulp_rpm_client'
338
+ # setup authorization
339
+ PulpRpmClient.configure do |config|
340
+ # Configure HTTP basic authorization: basicAuth
341
+ config.username = 'YOUR USERNAME'
342
+ config.password = 'YOUR PASSWORD'
343
+ end
344
+
345
+ api_instance = PulpRpmClient::RemotesRpmApi.new
346
+ rpm_rpm_remote_href = 'rpm_rpm_remote_href_example' # String |
347
+ opts = {
348
+ fields: 'fields_example', # String | A list of fields to include in the response.
349
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
350
+ }
351
+
352
+ begin
353
+ result = api_instance.my_permissions(rpm_rpm_remote_href, opts)
354
+ p result
355
+ rescue PulpRpmClient::ApiError => e
356
+ puts "Exception when calling RemotesRpmApi->my_permissions: #{e}"
357
+ end
358
+ ```
359
+
360
+ ### Parameters
361
+
362
+
363
+ Name | Type | Description | Notes
364
+ ------------- | ------------- | ------------- | -------------
365
+ **rpm_rpm_remote_href** | **String**| |
366
+ **fields** | **String**| A list of fields to include in the response. | [optional]
367
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
368
+
369
+ ### Return type
370
+
371
+ [**MyPermissionsResponse**](MyPermissionsResponse.md)
372
+
373
+ ### Authorization
374
+
375
+ [basicAuth](../README.md#basicAuth)
376
+
377
+ ### HTTP request headers
378
+
379
+ - **Content-Type**: Not defined
380
+ - **Accept**: application/json
381
+
382
+
209
383
  ## partial_update
210
384
 
211
385
  > AsyncOperationResponse partial_update(rpm_rpm_remote_href, patchedrpm_rpm_remote)
@@ -320,6 +494,60 @@ Name | Type | Description | Notes
320
494
  - **Accept**: application/json
321
495
 
322
496
 
497
+ ## remove_role
498
+
499
+ > NestedRoleResponse remove_role(rpm_rpm_remote_href, nested_role)
500
+
501
+
502
+
503
+ Remove a role for this object from users/groups.
504
+
505
+ ### Example
506
+
507
+ ```ruby
508
+ # load the gem
509
+ require 'pulp_rpm_client'
510
+ # setup authorization
511
+ PulpRpmClient.configure do |config|
512
+ # Configure HTTP basic authorization: basicAuth
513
+ config.username = 'YOUR USERNAME'
514
+ config.password = 'YOUR PASSWORD'
515
+ end
516
+
517
+ api_instance = PulpRpmClient::RemotesRpmApi.new
518
+ rpm_rpm_remote_href = 'rpm_rpm_remote_href_example' # String |
519
+ nested_role = PulpRpmClient::NestedRole.new # NestedRole |
520
+
521
+ begin
522
+ result = api_instance.remove_role(rpm_rpm_remote_href, nested_role)
523
+ p result
524
+ rescue PulpRpmClient::ApiError => e
525
+ puts "Exception when calling RemotesRpmApi->remove_role: #{e}"
526
+ end
527
+ ```
528
+
529
+ ### Parameters
530
+
531
+
532
+ Name | Type | Description | Notes
533
+ ------------- | ------------- | ------------- | -------------
534
+ **rpm_rpm_remote_href** | **String**| |
535
+ **nested_role** | [**NestedRole**](NestedRole.md)| |
536
+
537
+ ### Return type
538
+
539
+ [**NestedRoleResponse**](NestedRoleResponse.md)
540
+
541
+ ### Authorization
542
+
543
+ [basicAuth](../README.md#basicAuth)
544
+
545
+ ### HTTP request headers
546
+
547
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
548
+ - **Accept**: application/json
549
+
550
+
323
551
  ## update
324
552
 
325
553
  > AsyncOperationResponse update(rpm_rpm_remote_href, rpm_rpm_remote)