pulp_maven_client 0.24.1 → 0.25.1

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.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +26 -4
  3. data/docs/ContentPackageApi.md +351 -0
  4. data/docs/DistributionsMavenApi.md +312 -0
  5. data/docs/MavenMavenPackageResponse.md +48 -0
  6. data/docs/MyPermissionsResponse.md +18 -0
  7. data/docs/NestedRole.md +22 -0
  8. data/docs/NestedRoleResponse.md +22 -0
  9. data/docs/ObjectRolesResponse.md +18 -0
  10. data/docs/PaginatedmavenMavenPackageResponseList.md +24 -0
  11. data/docs/RemotesMavenApi.md +312 -0
  12. data/docs/RepositoriesMavenApi.md +315 -3
  13. data/lib/pulp_maven_client/api/content_package_api.rb +369 -0
  14. data/lib/pulp_maven_client/api/distributions_maven_api.rb +298 -0
  15. data/lib/pulp_maven_client/api/remotes_maven_api.rb +298 -0
  16. data/lib/pulp_maven_client/api/repositories_maven_api.rb +304 -6
  17. data/lib/pulp_maven_client/models/maven_maven_package_response.rb +371 -0
  18. data/lib/pulp_maven_client/models/my_permissions_response.rb +223 -0
  19. data/lib/pulp_maven_client/models/nested_role.rb +263 -0
  20. data/lib/pulp_maven_client/models/nested_role_response.rb +244 -0
  21. data/lib/pulp_maven_client/models/object_roles_response.rb +223 -0
  22. data/lib/pulp_maven_client/models/paginatedmaven_maven_package_response_list.rb +257 -0
  23. data/lib/pulp_maven_client/version.rb +1 -1
  24. data/lib/pulp_maven_client.rb +7 -0
  25. data/spec/api/content_package_api_spec.rb +109 -0
  26. data/spec/api/distributions_maven_api_spec.rb +58 -0
  27. data/spec/api/remotes_maven_api_spec.rb +58 -0
  28. data/spec/api/repositories_maven_api_spec.rb +61 -3
  29. data/spec/models/maven_maven_package_response_spec.rb +126 -0
  30. data/spec/models/my_permissions_response_spec.rb +36 -0
  31. data/spec/models/nested_role_response_spec.rb +48 -0
  32. data/spec/models/nested_role_spec.rb +48 -0
  33. data/spec/models/object_roles_response_spec.rb +36 -0
  34. data/spec/models/paginatedmaven_maven_package_response_list_spec.rb +54 -0
  35. metadata +56 -28
@@ -5,12 +5,16 @@ All URIs are relative to *http://localhost:24817*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**add_cached_content**](RepositoriesMavenApi.md#add_cached_content) | **POST** {maven_maven_repository_href}add_cached_content/ | Add cached content |
8
+ | [**add_role**](RepositoriesMavenApi.md#add_role) | **POST** {maven_maven_repository_href}add_role/ | Add a role |
8
9
  | [**create**](RepositoriesMavenApi.md#create) | **POST** /pulp/api/v3/repositories/maven/maven/ | Create a maven repository |
9
10
  | [**delete**](RepositoriesMavenApi.md#delete) | **DELETE** {maven_maven_repository_href} | Delete a maven repository |
10
11
  | [**list**](RepositoriesMavenApi.md#list) | **GET** /pulp/api/v3/repositories/maven/maven/ | List maven repositorys |
12
+ | [**list_roles**](RepositoriesMavenApi.md#list_roles) | **GET** {maven_maven_repository_href}list_roles/ | List roles |
11
13
  | [**modify**](RepositoriesMavenApi.md#modify) | **POST** {maven_maven_repository_href}modify/ | Modify Repository Content |
14
+ | [**my_permissions**](RepositoriesMavenApi.md#my_permissions) | **GET** {maven_maven_repository_href}my_permissions/ | List user permissions |
12
15
  | [**partial_update**](RepositoriesMavenApi.md#partial_update) | **PATCH** {maven_maven_repository_href} | Update a maven repository |
13
16
  | [**read**](RepositoriesMavenApi.md#read) | **GET** {maven_maven_repository_href} | Inspect a maven repository |
17
+ | [**remove_role**](RepositoriesMavenApi.md#remove_role) | **POST** {maven_maven_repository_href}remove_role/ | Remove a role |
14
18
  | [**repair_metadata**](RepositoriesMavenApi.md#repair_metadata) | **POST** {maven_maven_repository_href}repair_metadata/ | Repair metadata |
15
19
  | [**set_label**](RepositoriesMavenApi.md#set_label) | **POST** {maven_maven_repository_href}set_label/ | Set a label |
16
20
  | [**unset_label**](RepositoriesMavenApi.md#unset_label) | **POST** {maven_maven_repository_href}unset_label/ | Unset a label |
@@ -93,13 +97,89 @@ end
93
97
  - **Accept**: application/json
94
98
 
95
99
 
100
+ ## add_role
101
+
102
+ > <NestedRoleResponse> add_role(maven_maven_repository_href, nested_role, opts)
103
+
104
+ Add a role
105
+
106
+ Add a role for this object to users/groups.
107
+
108
+ ### Examples
109
+
110
+ ```ruby
111
+ require 'time'
112
+ require 'pulp_maven_client'
113
+ # setup authorization
114
+ PulpMavenClient.configure do |config|
115
+ # Configure HTTP basic authorization: basicAuth
116
+ config.username = 'YOUR USERNAME'
117
+ config.password = 'YOUR PASSWORD'
118
+ end
119
+
120
+ api_instance = PulpMavenClient::RepositoriesMavenApi.new
121
+ maven_maven_repository_href = 'maven_maven_repository_href_example' # String |
122
+ nested_role = PulpMavenClient::NestedRole.new({role: 'role_example'}) # NestedRole |
123
+ opts = {
124
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
125
+ }
126
+
127
+ begin
128
+ # Add a role
129
+ result = api_instance.add_role(maven_maven_repository_href, nested_role, opts)
130
+ p result
131
+ rescue PulpMavenClient::ApiError => e
132
+ puts "Error when calling RepositoriesMavenApi->add_role: #{e}"
133
+ end
134
+ ```
135
+
136
+ #### Using the add_role_with_http_info variant
137
+
138
+ This returns an Array which contains the response data, status code and headers.
139
+
140
+ > <Array(<NestedRoleResponse>, Integer, Hash)> add_role_with_http_info(maven_maven_repository_href, nested_role, opts)
141
+
142
+ ```ruby
143
+ begin
144
+ # Add a role
145
+ data, status_code, headers = api_instance.add_role_with_http_info(maven_maven_repository_href, nested_role, opts)
146
+ p status_code # => 2xx
147
+ p headers # => { ... }
148
+ p data # => <NestedRoleResponse>
149
+ rescue PulpMavenClient::ApiError => e
150
+ puts "Error when calling RepositoriesMavenApi->add_role_with_http_info: #{e}"
151
+ end
152
+ ```
153
+
154
+ ### Parameters
155
+
156
+ | Name | Type | Description | Notes |
157
+ | ---- | ---- | ----------- | ----- |
158
+ | **maven_maven_repository_href** | **String** | | |
159
+ | **nested_role** | [**NestedRole**](NestedRole.md) | | |
160
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
161
+
162
+ ### Return type
163
+
164
+ [**NestedRoleResponse**](NestedRoleResponse.md)
165
+
166
+ ### Authorization
167
+
168
+ [basicAuth](../README.md#basicAuth)
169
+
170
+ ### HTTP request headers
171
+
172
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
173
+ - **Accept**: application/json
174
+
175
+
96
176
  ## create
97
177
 
98
178
  > <MavenMavenRepositoryResponse> create(maven_maven_repository, opts)
99
179
 
100
180
  Create a maven repository
101
181
 
102
- A ViewSet for MavenRemote.
182
+ A ViewSet for MavenRepository.
103
183
 
104
184
  ### Examples
105
185
 
@@ -247,7 +327,7 @@ end
247
327
 
248
328
  List maven repositorys
249
329
 
250
- A ViewSet for MavenRemote.
330
+ A ViewSet for MavenRepository.
251
331
 
252
332
  ### Examples
253
333
 
@@ -389,6 +469,84 @@ end
389
469
  - **Accept**: application/json
390
470
 
391
471
 
472
+ ## list_roles
473
+
474
+ > <ObjectRolesResponse> list_roles(maven_maven_repository_href, opts)
475
+
476
+ List roles
477
+
478
+ List roles assigned to this object.
479
+
480
+ ### Examples
481
+
482
+ ```ruby
483
+ require 'time'
484
+ require 'pulp_maven_client'
485
+ # setup authorization
486
+ PulpMavenClient.configure do |config|
487
+ # Configure HTTP basic authorization: basicAuth
488
+ config.username = 'YOUR USERNAME'
489
+ config.password = 'YOUR PASSWORD'
490
+ end
491
+
492
+ api_instance = PulpMavenClient::RepositoriesMavenApi.new
493
+ maven_maven_repository_href = 'maven_maven_repository_href_example' # String |
494
+ opts = {
495
+ x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
496
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
497
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
498
+ }
499
+
500
+ begin
501
+ # List roles
502
+ result = api_instance.list_roles(maven_maven_repository_href, opts)
503
+ p result
504
+ rescue PulpMavenClient::ApiError => e
505
+ puts "Error when calling RepositoriesMavenApi->list_roles: #{e}"
506
+ end
507
+ ```
508
+
509
+ #### Using the list_roles_with_http_info variant
510
+
511
+ This returns an Array which contains the response data, status code and headers.
512
+
513
+ > <Array(<ObjectRolesResponse>, Integer, Hash)> list_roles_with_http_info(maven_maven_repository_href, opts)
514
+
515
+ ```ruby
516
+ begin
517
+ # List roles
518
+ data, status_code, headers = api_instance.list_roles_with_http_info(maven_maven_repository_href, opts)
519
+ p status_code # => 2xx
520
+ p headers # => { ... }
521
+ p data # => <ObjectRolesResponse>
522
+ rescue PulpMavenClient::ApiError => e
523
+ puts "Error when calling RepositoriesMavenApi->list_roles_with_http_info: #{e}"
524
+ end
525
+ ```
526
+
527
+ ### Parameters
528
+
529
+ | Name | Type | Description | Notes |
530
+ | ---- | ---- | ----------- | ----- |
531
+ | **maven_maven_repository_href** | **String** | | |
532
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
533
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
534
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
535
+
536
+ ### Return type
537
+
538
+ [**ObjectRolesResponse**](ObjectRolesResponse.md)
539
+
540
+ ### Authorization
541
+
542
+ [basicAuth](../README.md#basicAuth)
543
+
544
+ ### HTTP request headers
545
+
546
+ - **Content-Type**: Not defined
547
+ - **Accept**: application/json
548
+
549
+
392
550
  ## modify
393
551
 
394
552
  > <AsyncOperationResponse> modify(maven_maven_repository_href, repository_add_remove_content, opts)
@@ -465,6 +623,84 @@ end
465
623
  - **Accept**: application/json
466
624
 
467
625
 
626
+ ## my_permissions
627
+
628
+ > <MyPermissionsResponse> my_permissions(maven_maven_repository_href, opts)
629
+
630
+ List user permissions
631
+
632
+ List permissions available to the current user on this object.
633
+
634
+ ### Examples
635
+
636
+ ```ruby
637
+ require 'time'
638
+ require 'pulp_maven_client'
639
+ # setup authorization
640
+ PulpMavenClient.configure do |config|
641
+ # Configure HTTP basic authorization: basicAuth
642
+ config.username = 'YOUR USERNAME'
643
+ config.password = 'YOUR PASSWORD'
644
+ end
645
+
646
+ api_instance = PulpMavenClient::RepositoriesMavenApi.new
647
+ maven_maven_repository_href = 'maven_maven_repository_href_example' # String |
648
+ opts = {
649
+ x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
650
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
651
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
652
+ }
653
+
654
+ begin
655
+ # List user permissions
656
+ result = api_instance.my_permissions(maven_maven_repository_href, opts)
657
+ p result
658
+ rescue PulpMavenClient::ApiError => e
659
+ puts "Error when calling RepositoriesMavenApi->my_permissions: #{e}"
660
+ end
661
+ ```
662
+
663
+ #### Using the my_permissions_with_http_info variant
664
+
665
+ This returns an Array which contains the response data, status code and headers.
666
+
667
+ > <Array(<MyPermissionsResponse>, Integer, Hash)> my_permissions_with_http_info(maven_maven_repository_href, opts)
668
+
669
+ ```ruby
670
+ begin
671
+ # List user permissions
672
+ data, status_code, headers = api_instance.my_permissions_with_http_info(maven_maven_repository_href, opts)
673
+ p status_code # => 2xx
674
+ p headers # => { ... }
675
+ p data # => <MyPermissionsResponse>
676
+ rescue PulpMavenClient::ApiError => e
677
+ puts "Error when calling RepositoriesMavenApi->my_permissions_with_http_info: #{e}"
678
+ end
679
+ ```
680
+
681
+ ### Parameters
682
+
683
+ | Name | Type | Description | Notes |
684
+ | ---- | ---- | ----------- | ----- |
685
+ | **maven_maven_repository_href** | **String** | | |
686
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
687
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
688
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
689
+
690
+ ### Return type
691
+
692
+ [**MyPermissionsResponse**](MyPermissionsResponse.md)
693
+
694
+ ### Authorization
695
+
696
+ [basicAuth](../README.md#basicAuth)
697
+
698
+ ### HTTP request headers
699
+
700
+ - **Content-Type**: Not defined
701
+ - **Accept**: application/json
702
+
703
+
468
704
  ## partial_update
469
705
 
470
706
  > <MavenMavenRepositoryResponse> partial_update(maven_maven_repository_href, patchedmaven_maven_repository, opts)
@@ -547,7 +783,7 @@ end
547
783
 
548
784
  Inspect a maven repository
549
785
 
550
- A ViewSet for MavenRemote.
786
+ A ViewSet for MavenRepository.
551
787
 
552
788
  ### Examples
553
789
 
@@ -619,6 +855,82 @@ end
619
855
  - **Accept**: application/json
620
856
 
621
857
 
858
+ ## remove_role
859
+
860
+ > <NestedRoleResponse> remove_role(maven_maven_repository_href, nested_role, opts)
861
+
862
+ Remove a role
863
+
864
+ Remove a role for this object from users/groups.
865
+
866
+ ### Examples
867
+
868
+ ```ruby
869
+ require 'time'
870
+ require 'pulp_maven_client'
871
+ # setup authorization
872
+ PulpMavenClient.configure do |config|
873
+ # Configure HTTP basic authorization: basicAuth
874
+ config.username = 'YOUR USERNAME'
875
+ config.password = 'YOUR PASSWORD'
876
+ end
877
+
878
+ api_instance = PulpMavenClient::RepositoriesMavenApi.new
879
+ maven_maven_repository_href = 'maven_maven_repository_href_example' # String |
880
+ nested_role = PulpMavenClient::NestedRole.new({role: 'role_example'}) # NestedRole |
881
+ opts = {
882
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
883
+ }
884
+
885
+ begin
886
+ # Remove a role
887
+ result = api_instance.remove_role(maven_maven_repository_href, nested_role, opts)
888
+ p result
889
+ rescue PulpMavenClient::ApiError => e
890
+ puts "Error when calling RepositoriesMavenApi->remove_role: #{e}"
891
+ end
892
+ ```
893
+
894
+ #### Using the remove_role_with_http_info variant
895
+
896
+ This returns an Array which contains the response data, status code and headers.
897
+
898
+ > <Array(<NestedRoleResponse>, Integer, Hash)> remove_role_with_http_info(maven_maven_repository_href, nested_role, opts)
899
+
900
+ ```ruby
901
+ begin
902
+ # Remove a role
903
+ data, status_code, headers = api_instance.remove_role_with_http_info(maven_maven_repository_href, nested_role, opts)
904
+ p status_code # => 2xx
905
+ p headers # => { ... }
906
+ p data # => <NestedRoleResponse>
907
+ rescue PulpMavenClient::ApiError => e
908
+ puts "Error when calling RepositoriesMavenApi->remove_role_with_http_info: #{e}"
909
+ end
910
+ ```
911
+
912
+ ### Parameters
913
+
914
+ | Name | Type | Description | Notes |
915
+ | ---- | ---- | ----------- | ----- |
916
+ | **maven_maven_repository_href** | **String** | | |
917
+ | **nested_role** | [**NestedRole**](NestedRole.md) | | |
918
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
919
+
920
+ ### Return type
921
+
922
+ [**NestedRoleResponse**](NestedRoleResponse.md)
923
+
924
+ ### Authorization
925
+
926
+ [basicAuth](../README.md#basicAuth)
927
+
928
+ ### HTTP request headers
929
+
930
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
931
+ - **Accept**: application/json
932
+
933
+
622
934
  ## repair_metadata
623
935
 
624
936
  > <AsyncOperationResponse> repair_metadata(maven_maven_repository_href, opts)