pulpcore_client 3.19.1 → 3.20.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (219) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +93 -16
  3. data/docs/AccessPoliciesApi.md +2 -2
  4. data/docs/AccessPolicy.md +3 -1
  5. data/docs/AccessPolicyResponse.md +3 -1
  6. data/docs/AcsApi.md +417 -0
  7. data/docs/AlternateContentSource.md +23 -0
  8. data/docs/AlternateContentSourceResponse.md +27 -0
  9. data/docs/ArtifactsApi.md +2 -2
  10. data/docs/ContentApi.md +117 -3
  11. data/docs/ContentGuard.md +19 -0
  12. data/docs/ContentguardsApi.md +282 -3
  13. data/docs/ContentguardsContentRedirectApi.md +230 -2
  14. data/docs/ContentguardsRbacApi.md +2 -2
  15. data/docs/Distribution.md +25 -0
  16. data/docs/DistributionsApi.md +283 -3
  17. data/docs/Export.md +17 -0
  18. data/docs/ExportResponse.md +25 -0
  19. data/docs/Exporter.md +17 -0
  20. data/docs/ExporterResponse.md +21 -0
  21. data/docs/ExportersApi.md +362 -0
  22. data/docs/{GroupsModelPermissionsApi.md → ExportersExportsApi.md} +46 -48
  23. data/docs/ExportersFilesystemApi.md +2 -2
  24. data/docs/ExportersFilesystemExportsApi.md +0 -2
  25. data/docs/ExportersPulpApi.md +2 -2
  26. data/docs/ExportersPulpExportsApi.md +0 -2
  27. data/docs/GroupRole.md +1 -1
  28. data/docs/GroupRoleResponse.md +6 -2
  29. data/docs/GroupsApi.md +2 -2
  30. data/docs/GroupsRolesApi.md +2 -2
  31. data/docs/GroupsUsersApi.md +0 -2
  32. data/docs/Import.md +19 -0
  33. data/docs/Importer.md +17 -0
  34. data/docs/ImporterResponse.md +21 -0
  35. data/docs/ImportersApi.md +361 -0
  36. data/docs/{GroupsObjectPermissionsApi.md → ImportersImportsApi.md} +46 -48
  37. data/docs/ImportersPulpApi.md +2 -2
  38. data/docs/ImportersPulpImportsApi.md +0 -2
  39. data/docs/MultipleArtifactContent.md +17 -0
  40. data/docs/OrphansCleanup.md +1 -1
  41. data/docs/PaginatedAlternateContentSourceResponseList.md +23 -0
  42. data/docs/{PaginatedPermissionResponseList.md → PaginatedExportResponseList.md} +3 -3
  43. data/docs/PaginatedExporterResponseList.md +23 -0
  44. data/docs/PaginatedImporterResponseList.md +23 -0
  45. data/docs/PaginatedRemoteResponseList.md +23 -0
  46. data/docs/PatchedAccessPolicy.md +3 -1
  47. data/docs/PatchedAlternateContentSource.md +23 -0
  48. data/docs/PatchedContentGuard.md +19 -0
  49. data/docs/PatchedDistribution.md +25 -0
  50. data/docs/PatchedExporter.md +17 -0
  51. data/docs/PatchedImporter.md +17 -0
  52. data/docs/PatchedRemote.md +57 -0
  53. data/docs/PatchedRepository.md +25 -0
  54. data/docs/PolicyEnum.md +16 -0
  55. data/docs/PublicationsApi.md +117 -2
  56. data/docs/Remote.md +57 -0
  57. data/docs/RemoteResponse.md +53 -0
  58. data/docs/RemotesApi.md +376 -0
  59. data/docs/RepositoriesApi.md +283 -3
  60. data/docs/RepositoriesVersionsApi.md +271 -0
  61. data/docs/Repository.md +25 -0
  62. data/docs/RepositoryVersionsApi.md +2 -0
  63. data/docs/RolesApi.md +6 -2
  64. data/docs/SigningServicesApi.md +0 -2
  65. data/docs/TaskGroupsApi.md +2 -2
  66. data/docs/TaskSchedulesApi.md +2 -2
  67. data/docs/TasksApi.md +2 -2
  68. data/docs/UploadsApi.md +0 -2
  69. data/docs/UserRole.md +1 -1
  70. data/docs/UserRoleResponse.md +6 -2
  71. data/docs/UsersApi.md +2 -61
  72. data/docs/UsersRolesApi.md +2 -2
  73. data/docs/VersionResponse.md +3 -1
  74. data/docs/WorkersApi.md +2 -2
  75. data/lib/pulpcore_client/api/access_policies_api.rb +7 -3
  76. data/lib/pulpcore_client/api/acs_api.rb +514 -0
  77. data/lib/pulpcore_client/api/artifacts_api.rb +7 -3
  78. data/lib/pulpcore_client/api/content_api.rb +141 -5
  79. data/lib/pulpcore_client/api/contentguards_api.rb +341 -5
  80. data/lib/pulpcore_client/api/contentguards_content_redirect_api.rb +275 -3
  81. data/lib/pulpcore_client/api/contentguards_rbac_api.rb +7 -3
  82. data/lib/pulpcore_client/api/distributions_api.rb +343 -5
  83. data/lib/pulpcore_client/api/exporters_api.rb +446 -0
  84. data/lib/pulpcore_client/api/{groups_model_permissions_api.rb → exporters_exports_api.rb} +76 -79
  85. data/lib/pulpcore_client/api/exporters_filesystem_api.rb +7 -3
  86. data/lib/pulpcore_client/api/exporters_filesystem_exports_api.rb +0 -3
  87. data/lib/pulpcore_client/api/exporters_pulp_api.rb +7 -3
  88. data/lib/pulpcore_client/api/exporters_pulp_exports_api.rb +0 -3
  89. data/lib/pulpcore_client/api/groups_api.rb +7 -3
  90. data/lib/pulpcore_client/api/groups_roles_api.rb +7 -3
  91. data/lib/pulpcore_client/api/groups_users_api.rb +0 -3
  92. data/lib/pulpcore_client/api/importers_api.rb +444 -0
  93. data/lib/pulpcore_client/api/{groups_object_permissions_api.rb → importers_imports_api.rb} +76 -79
  94. data/lib/pulpcore_client/api/importers_pulp_api.rb +7 -3
  95. data/lib/pulpcore_client/api/importers_pulp_imports_api.rb +0 -3
  96. data/lib/pulpcore_client/api/publications_api.rb +138 -3
  97. data/lib/pulpcore_client/api/remotes_api.rb +467 -0
  98. data/lib/pulpcore_client/api/repositories_api.rb +343 -5
  99. data/lib/pulpcore_client/api/repositories_versions_api.rb +343 -0
  100. data/lib/pulpcore_client/api/repository_versions_api.rb +7 -0
  101. data/lib/pulpcore_client/api/roles_api.rb +13 -3
  102. data/lib/pulpcore_client/api/signing_services_api.rb +0 -3
  103. data/lib/pulpcore_client/api/task_groups_api.rb +7 -3
  104. data/lib/pulpcore_client/api/task_schedules_api.rb +7 -3
  105. data/lib/pulpcore_client/api/tasks_api.rb +7 -3
  106. data/lib/pulpcore_client/api/uploads_api.rb +0 -3
  107. data/lib/pulpcore_client/api/users_api.rb +7 -69
  108. data/lib/pulpcore_client/api/users_roles_api.rb +7 -3
  109. data/lib/pulpcore_client/api/workers_api.rb +7 -3
  110. data/lib/pulpcore_client/models/access_policy.rb +14 -4
  111. data/lib/pulpcore_client/models/access_policy_response.rb +14 -4
  112. data/lib/pulpcore_client/models/alternate_content_source.rb +270 -0
  113. data/lib/pulpcore_client/models/alternate_content_source_response.rb +270 -0
  114. data/lib/pulpcore_client/models/content_guard.rb +258 -0
  115. data/lib/pulpcore_client/models/distribution.rb +297 -0
  116. data/lib/pulpcore_client/models/export.rb +209 -0
  117. data/lib/pulpcore_client/models/export_response.rb +250 -0
  118. data/lib/pulpcore_client/models/exporter.rb +232 -0
  119. data/lib/pulpcore_client/models/{permission_response.rb → exporter_response.rb} +24 -27
  120. data/lib/pulpcore_client/models/group_role.rb +1 -1
  121. data/lib/pulpcore_client/models/group_role_response.rb +26 -6
  122. data/lib/pulpcore_client/models/import.rb +228 -0
  123. data/lib/pulpcore_client/models/importer.rb +232 -0
  124. data/lib/pulpcore_client/models/importer_response.rb +232 -0
  125. data/lib/pulpcore_client/models/multiple_artifact_content.rb +213 -0
  126. data/lib/pulpcore_client/models/orphans_cleanup.rb +0 -2
  127. data/lib/pulpcore_client/models/paginated_alternate_content_source_response_list.rb +237 -0
  128. data/lib/pulpcore_client/models/{paginated_permission_response_list.rb → paginated_export_response_list.rb} +4 -4
  129. data/lib/pulpcore_client/models/paginated_exporter_response_list.rb +237 -0
  130. data/lib/pulpcore_client/models/paginated_importer_response_list.rb +237 -0
  131. data/lib/pulpcore_client/models/paginated_remote_response_list.rb +237 -0
  132. data/lib/pulpcore_client/models/patched_access_policy.rb +14 -4
  133. data/lib/pulpcore_client/models/patched_alternate_content_source.rb +256 -0
  134. data/lib/pulpcore_client/models/patched_content_guard.rb +249 -0
  135. data/lib/pulpcore_client/models/patched_distribution.rb +279 -0
  136. data/lib/pulpcore_client/models/patched_exporter.rb +223 -0
  137. data/lib/pulpcore_client/models/patched_importer.rb +223 -0
  138. data/lib/pulpcore_client/models/patched_remote.rb +649 -0
  139. data/lib/pulpcore_client/models/patched_repository.rb +295 -0
  140. data/lib/pulpcore_client/models/policy_enum.rb +36 -0
  141. data/lib/pulpcore_client/models/remote.rb +667 -0
  142. data/lib/pulpcore_client/models/remote_response.rb +483 -0
  143. data/lib/pulpcore_client/models/repository.rb +304 -0
  144. data/lib/pulpcore_client/models/user_role.rb +1 -1
  145. data/lib/pulpcore_client/models/user_role_response.rb +26 -6
  146. data/lib/pulpcore_client/models/version_response.rb +19 -4
  147. data/lib/pulpcore_client/version.rb +1 -1
  148. data/lib/pulpcore_client.rb +35 -4
  149. data/spec/api/access_policies_api_spec.rb +1 -1
  150. data/spec/api/acs_api_spec.rb +132 -0
  151. data/spec/api/artifacts_api_spec.rb +1 -1
  152. data/spec/api/content_api_spec.rb +28 -2
  153. data/spec/api/contentguards_api_spec.rb +66 -2
  154. data/spec/api/contentguards_content_redirect_api_spec.rb +51 -1
  155. data/spec/api/contentguards_rbac_api_spec.rb +1 -1
  156. data/spec/api/distributions_api_spec.rb +66 -2
  157. data/spec/api/exporters_api_spec.rb +120 -0
  158. data/spec/api/{groups_model_permissions_api_spec.rb → exporters_exports_api_spec.rb} +22 -23
  159. data/spec/api/exporters_filesystem_api_spec.rb +1 -1
  160. data/spec/api/exporters_filesystem_exports_api_spec.rb +0 -1
  161. data/spec/api/exporters_pulp_api_spec.rb +1 -1
  162. data/spec/api/exporters_pulp_exports_api_spec.rb +0 -1
  163. data/spec/api/groups_api_spec.rb +1 -1
  164. data/spec/api/groups_roles_api_spec.rb +1 -1
  165. data/spec/api/groups_users_api_spec.rb +0 -1
  166. data/spec/api/importers_api_spec.rb +120 -0
  167. data/spec/api/{groups_object_permissions_api_spec.rb → importers_imports_api_spec.rb} +22 -23
  168. data/spec/api/importers_pulp_api_spec.rb +1 -1
  169. data/spec/api/importers_pulp_imports_api_spec.rb +0 -1
  170. data/spec/api/publications_api_spec.rb +28 -1
  171. data/spec/api/remotes_api_spec.rb +127 -0
  172. data/spec/api/repositories_api_spec.rb +66 -2
  173. data/spec/api/repositories_versions_api_spec.rb +104 -0
  174. data/spec/api/repository_versions_api_spec.rb +1 -0
  175. data/spec/api/roles_api_spec.rb +3 -1
  176. data/spec/api/signing_services_api_spec.rb +0 -1
  177. data/spec/api/task_groups_api_spec.rb +1 -1
  178. data/spec/api/task_schedules_api_spec.rb +1 -1
  179. data/spec/api/tasks_api_spec.rb +1 -1
  180. data/spec/api/uploads_api_spec.rb +0 -1
  181. data/spec/api/users_api_spec.rb +1 -14
  182. data/spec/api/users_roles_api_spec.rb +1 -1
  183. data/spec/api/workers_api_spec.rb +1 -1
  184. data/spec/models/access_policy_response_spec.rb +6 -0
  185. data/spec/models/access_policy_spec.rb +6 -0
  186. data/spec/models/alternate_content_source_response_spec.rb +71 -0
  187. data/spec/models/{permission_response_spec.rb → alternate_content_source_spec.rb} +10 -10
  188. data/spec/models/content_guard_spec.rb +47 -0
  189. data/spec/models/distribution_spec.rb +65 -0
  190. data/spec/models/export_response_spec.rb +65 -0
  191. data/spec/models/export_spec.rb +41 -0
  192. data/spec/models/exporter_response_spec.rb +53 -0
  193. data/spec/models/exporter_spec.rb +41 -0
  194. data/spec/models/group_role_response_spec.rb +12 -0
  195. data/spec/models/import_spec.rb +47 -0
  196. data/spec/models/importer_response_spec.rb +53 -0
  197. data/spec/models/importer_spec.rb +41 -0
  198. data/spec/models/multiple_artifact_content_spec.rb +41 -0
  199. data/spec/models/paginated_alternate_content_source_response_list_spec.rb +59 -0
  200. data/spec/models/{paginated_permission_response_list_spec.rb → paginated_export_response_list_spec.rb} +6 -6
  201. data/spec/models/paginated_exporter_response_list_spec.rb +59 -0
  202. data/spec/models/paginated_importer_response_list_spec.rb +59 -0
  203. data/spec/models/paginated_remote_response_list_spec.rb +59 -0
  204. data/spec/models/patched_access_policy_spec.rb +6 -0
  205. data/spec/models/patched_alternate_content_source_spec.rb +59 -0
  206. data/spec/models/patched_content_guard_spec.rb +47 -0
  207. data/spec/models/patched_distribution_spec.rb +65 -0
  208. data/spec/models/patched_exporter_spec.rb +41 -0
  209. data/spec/models/patched_importer_spec.rb +41 -0
  210. data/spec/models/patched_remote_spec.rb +161 -0
  211. data/spec/models/patched_repository_spec.rb +65 -0
  212. data/spec/models/policy_enum_spec.rb +35 -0
  213. data/spec/models/remote_response_spec.rb +149 -0
  214. data/spec/models/remote_spec.rb +161 -0
  215. data/spec/models/repository_spec.rb +65 -0
  216. data/spec/models/user_role_response_spec.rb +12 -0
  217. data/spec/models/version_response_spec.rb +6 -0
  218. metadata +263 -139
  219. data/docs/PermissionResponse.md +0 -23
@@ -4,17 +4,128 @@ All URIs are relative to *https://pulp*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**create**](RepositoriesApi.md#create) | **POST** /pulp/api/v3/repositories/ | Create a repository
8
+ [**delete**](RepositoriesApi.md#delete) | **DELETE** {repository_href} | Delete a repository
7
9
  [**list**](RepositoriesApi.md#list) | **GET** /pulp/api/v3/repositories/ | List repositories
10
+ [**partial_update**](RepositoriesApi.md#partial_update) | **PATCH** {repository_href} | Update a repository
11
+ [**read**](RepositoriesApi.md#read) | **GET** {repository_href} | Inspect a repository
12
+ [**update**](RepositoriesApi.md#update) | **PUT** {repository_href} | Update a repository
8
13
 
9
14
 
10
15
 
16
+ ## create
17
+
18
+ > RepositoryResponse create(repository)
19
+
20
+ Create a repository
21
+
22
+ An immutable repository ViewSet that does not allow the usage of the methods PATCH and PUT.
23
+
24
+ ### Example
25
+
26
+ ```ruby
27
+ # load the gem
28
+ require 'pulpcore_client'
29
+ # setup authorization
30
+ PulpcoreClient.configure do |config|
31
+ # Configure HTTP basic authorization: basicAuth
32
+ config.username = 'YOUR USERNAME'
33
+ config.password = 'YOUR PASSWORD'
34
+ end
35
+
36
+ api_instance = PulpcoreClient::RepositoriesApi.new
37
+ repository = PulpcoreClient::Repository.new # Repository |
38
+
39
+ begin
40
+ #Create a repository
41
+ result = api_instance.create(repository)
42
+ p result
43
+ rescue PulpcoreClient::ApiError => e
44
+ puts "Exception when calling RepositoriesApi->create: #{e}"
45
+ end
46
+ ```
47
+
48
+ ### Parameters
49
+
50
+
51
+ Name | Type | Description | Notes
52
+ ------------- | ------------- | ------------- | -------------
53
+ **repository** | [**Repository**](Repository.md)| |
54
+
55
+ ### Return type
56
+
57
+ [**RepositoryResponse**](RepositoryResponse.md)
58
+
59
+ ### Authorization
60
+
61
+ [basicAuth](../README.md#basicAuth)
62
+
63
+ ### HTTP request headers
64
+
65
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
66
+ - **Accept**: application/json
67
+
68
+
69
+ ## delete
70
+
71
+ > AsyncOperationResponse delete(repository_href)
72
+
73
+ Delete a repository
74
+
75
+ Trigger an asynchronous delete task
76
+
77
+ ### Example
78
+
79
+ ```ruby
80
+ # load the gem
81
+ require 'pulpcore_client'
82
+ # setup authorization
83
+ PulpcoreClient.configure do |config|
84
+ # Configure HTTP basic authorization: basicAuth
85
+ config.username = 'YOUR USERNAME'
86
+ config.password = 'YOUR PASSWORD'
87
+ end
88
+
89
+ api_instance = PulpcoreClient::RepositoriesApi.new
90
+ repository_href = 'repository_href_example' # String |
91
+
92
+ begin
93
+ #Delete a repository
94
+ result = api_instance.delete(repository_href)
95
+ p result
96
+ rescue PulpcoreClient::ApiError => e
97
+ puts "Exception when calling RepositoriesApi->delete: #{e}"
98
+ end
99
+ ```
100
+
101
+ ### Parameters
102
+
103
+
104
+ Name | Type | Description | Notes
105
+ ------------- | ------------- | ------------- | -------------
106
+ **repository_href** | **String**| |
107
+
108
+ ### Return type
109
+
110
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
111
+
112
+ ### Authorization
113
+
114
+ [basicAuth](../README.md#basicAuth)
115
+
116
+ ### HTTP request headers
117
+
118
+ - **Content-Type**: Not defined
119
+ - **Accept**: application/json
120
+
121
+
11
122
  ## list
12
123
 
13
124
  > PaginatedRepositoryResponseList list(opts)
14
125
 
15
126
  List repositories
16
127
 
17
- Endpoint to list all repositories.
128
+ An immutable repository ViewSet that does not allow the usage of the methods PATCH and PUT.
18
129
 
19
130
  ### Example
20
131
 
@@ -37,7 +148,7 @@ opts = {
37
148
  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
38
149
  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
39
150
  offset: 56, # Integer | The initial index from which to return the results.
40
- ordering: 'ordering_example', # String | Which field to use when ordering the results.
151
+ ordering: ['ordering_example'], # Array<String> | Ordering
41
152
  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
42
153
  fields: 'fields_example', # String | A list of fields to include in the response.
43
154
  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
@@ -64,7 +175,7 @@ Name | Type | Description | Notes
64
175
  **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
65
176
  **name__startswith** | **String**| Filter results where name starts with value | [optional]
66
177
  **offset** | **Integer**| The initial index from which to return the results. | [optional]
67
- **ordering** | **String**| Which field to use when ordering the results. | [optional]
178
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional]
68
179
  **pulp_label_select** | **String**| Filter labels by search string | [optional]
69
180
  **fields** | **String**| A list of fields to include in the response. | [optional]
70
181
  **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
@@ -82,3 +193,172 @@ Name | Type | Description | Notes
82
193
  - **Content-Type**: Not defined
83
194
  - **Accept**: application/json
84
195
 
196
+
197
+ ## partial_update
198
+
199
+ > AsyncOperationResponse partial_update(repository_href, patched_repository)
200
+
201
+ Update a repository
202
+
203
+ Trigger an asynchronous partial update task
204
+
205
+ ### Example
206
+
207
+ ```ruby
208
+ # load the gem
209
+ require 'pulpcore_client'
210
+ # setup authorization
211
+ PulpcoreClient.configure do |config|
212
+ # Configure HTTP basic authorization: basicAuth
213
+ config.username = 'YOUR USERNAME'
214
+ config.password = 'YOUR PASSWORD'
215
+ end
216
+
217
+ api_instance = PulpcoreClient::RepositoriesApi.new
218
+ repository_href = 'repository_href_example' # String |
219
+ patched_repository = PulpcoreClient::PatchedRepository.new # PatchedRepository |
220
+
221
+ begin
222
+ #Update a repository
223
+ result = api_instance.partial_update(repository_href, patched_repository)
224
+ p result
225
+ rescue PulpcoreClient::ApiError => e
226
+ puts "Exception when calling RepositoriesApi->partial_update: #{e}"
227
+ end
228
+ ```
229
+
230
+ ### Parameters
231
+
232
+
233
+ Name | Type | Description | Notes
234
+ ------------- | ------------- | ------------- | -------------
235
+ **repository_href** | **String**| |
236
+ **patched_repository** | [**PatchedRepository**](PatchedRepository.md)| |
237
+
238
+ ### Return type
239
+
240
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
241
+
242
+ ### Authorization
243
+
244
+ [basicAuth](../README.md#basicAuth)
245
+
246
+ ### HTTP request headers
247
+
248
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
249
+ - **Accept**: application/json
250
+
251
+
252
+ ## read
253
+
254
+ > RepositoryResponse read(repository_href, opts)
255
+
256
+ Inspect a repository
257
+
258
+ An immutable repository ViewSet that does not allow the usage of the methods PATCH and PUT.
259
+
260
+ ### Example
261
+
262
+ ```ruby
263
+ # load the gem
264
+ require 'pulpcore_client'
265
+ # setup authorization
266
+ PulpcoreClient.configure do |config|
267
+ # Configure HTTP basic authorization: basicAuth
268
+ config.username = 'YOUR USERNAME'
269
+ config.password = 'YOUR PASSWORD'
270
+ end
271
+
272
+ api_instance = PulpcoreClient::RepositoriesApi.new
273
+ repository_href = 'repository_href_example' # String |
274
+ opts = {
275
+ fields: 'fields_example', # String | A list of fields to include in the response.
276
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
277
+ }
278
+
279
+ begin
280
+ #Inspect a repository
281
+ result = api_instance.read(repository_href, opts)
282
+ p result
283
+ rescue PulpcoreClient::ApiError => e
284
+ puts "Exception when calling RepositoriesApi->read: #{e}"
285
+ end
286
+ ```
287
+
288
+ ### Parameters
289
+
290
+
291
+ Name | Type | Description | Notes
292
+ ------------- | ------------- | ------------- | -------------
293
+ **repository_href** | **String**| |
294
+ **fields** | **String**| A list of fields to include in the response. | [optional]
295
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
296
+
297
+ ### Return type
298
+
299
+ [**RepositoryResponse**](RepositoryResponse.md)
300
+
301
+ ### Authorization
302
+
303
+ [basicAuth](../README.md#basicAuth)
304
+
305
+ ### HTTP request headers
306
+
307
+ - **Content-Type**: Not defined
308
+ - **Accept**: application/json
309
+
310
+
311
+ ## update
312
+
313
+ > AsyncOperationResponse update(repository_href, repository)
314
+
315
+ Update a repository
316
+
317
+ Trigger an asynchronous update task
318
+
319
+ ### Example
320
+
321
+ ```ruby
322
+ # load the gem
323
+ require 'pulpcore_client'
324
+ # setup authorization
325
+ PulpcoreClient.configure do |config|
326
+ # Configure HTTP basic authorization: basicAuth
327
+ config.username = 'YOUR USERNAME'
328
+ config.password = 'YOUR PASSWORD'
329
+ end
330
+
331
+ api_instance = PulpcoreClient::RepositoriesApi.new
332
+ repository_href = 'repository_href_example' # String |
333
+ repository = PulpcoreClient::Repository.new # Repository |
334
+
335
+ begin
336
+ #Update a repository
337
+ result = api_instance.update(repository_href, repository)
338
+ p result
339
+ rescue PulpcoreClient::ApiError => e
340
+ puts "Exception when calling RepositoriesApi->update: #{e}"
341
+ end
342
+ ```
343
+
344
+ ### Parameters
345
+
346
+
347
+ Name | Type | Description | Notes
348
+ ------------- | ------------- | ------------- | -------------
349
+ **repository_href** | **String**| |
350
+ **repository** | [**Repository**](Repository.md)| |
351
+
352
+ ### Return type
353
+
354
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
355
+
356
+ ### Authorization
357
+
358
+ [basicAuth](../README.md#basicAuth)
359
+
360
+ ### HTTP request headers
361
+
362
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
363
+ - **Accept**: application/json
364
+
@@ -0,0 +1,271 @@
1
+ # PulpcoreClient::RepositoriesVersionsApi
2
+
3
+ All URIs are relative to *https://pulp*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**delete**](RepositoriesVersionsApi.md#delete) | **DELETE** {repositories_repository_version_href} | Delete a repository version
8
+ [**list**](RepositoriesVersionsApi.md#list) | **GET** {repository_href}versions/ | List repository versions
9
+ [**read**](RepositoriesVersionsApi.md#read) | **GET** {repositories_repository_version_href} | Inspect a repository version
10
+ [**repair**](RepositoriesVersionsApi.md#repair) | **POST** {repositories_repository_version_href}repair/ |
11
+
12
+
13
+
14
+ ## delete
15
+
16
+ > AsyncOperationResponse delete(repositories_repository_version_href)
17
+
18
+ Delete a repository version
19
+
20
+ Trigger an asynchronous task to delete a repository version.
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: basicAuth
30
+ config.username = 'YOUR USERNAME'
31
+ config.password = 'YOUR PASSWORD'
32
+ end
33
+
34
+ api_instance = PulpcoreClient::RepositoriesVersionsApi.new
35
+ repositories_repository_version_href = 'repositories_repository_version_href_example' # String |
36
+
37
+ begin
38
+ #Delete a repository version
39
+ result = api_instance.delete(repositories_repository_version_href)
40
+ p result
41
+ rescue PulpcoreClient::ApiError => e
42
+ puts "Exception when calling RepositoriesVersionsApi->delete: #{e}"
43
+ end
44
+ ```
45
+
46
+ ### Parameters
47
+
48
+
49
+ Name | Type | Description | Notes
50
+ ------------- | ------------- | ------------- | -------------
51
+ **repositories_repository_version_href** | **String**| |
52
+
53
+ ### Return type
54
+
55
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
56
+
57
+ ### Authorization
58
+
59
+ [basicAuth](../README.md#basicAuth)
60
+
61
+ ### HTTP request headers
62
+
63
+ - **Content-Type**: Not defined
64
+ - **Accept**: application/json
65
+
66
+
67
+ ## list
68
+
69
+ > PaginatedRepositoryVersionResponseList list(repository_href, opts)
70
+
71
+ List repository versions
72
+
73
+ A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.
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: basicAuth
83
+ config.username = 'YOUR USERNAME'
84
+ config.password = 'YOUR PASSWORD'
85
+ end
86
+
87
+ api_instance = PulpcoreClient::RepositoriesVersionsApi.new
88
+ repository_href = 'repository_href_example' # String |
89
+ opts = {
90
+ content: 'content_example', # String | Content Unit referenced by HREF
91
+ content__in: 'content__in_example', # String | Content Unit referenced by HREF
92
+ limit: 56, # Integer | Number of results to return per page.
93
+ number: 56, # Integer |
94
+ number__gt: 56, # Integer | Filter results where number is greater than value
95
+ number__gte: 56, # Integer | Filter results where number is greater than or equal to value
96
+ number__lt: 56, # Integer | Filter results where number is less than value
97
+ number__lte: 56, # Integer | Filter results where number is less than or equal to value
98
+ number__range: [56], # Array<Integer> | Filter results where number is between two comma separated values
99
+ offset: 56, # Integer | The initial index from which to return the results.
100
+ ordering: ['ordering_example'], # Array<String> | Ordering
101
+ pulp_created: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | ISO 8601 formatted dates are supported
102
+ pulp_created__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than value
103
+ pulp_created__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than or equal to value
104
+ pulp_created__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than value
105
+ pulp_created__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than or equal to value
106
+ pulp_created__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_created is between two comma separated values
107
+ fields: 'fields_example', # String | A list of fields to include in the response.
108
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
109
+ }
110
+
111
+ begin
112
+ #List repository versions
113
+ result = api_instance.list(repository_href, opts)
114
+ p result
115
+ rescue PulpcoreClient::ApiError => e
116
+ puts "Exception when calling RepositoriesVersionsApi->list: #{e}"
117
+ end
118
+ ```
119
+
120
+ ### Parameters
121
+
122
+
123
+ Name | Type | Description | Notes
124
+ ------------- | ------------- | ------------- | -------------
125
+ **repository_href** | **String**| |
126
+ **content** | **String**| Content Unit referenced by HREF | [optional]
127
+ **content__in** | **String**| Content Unit referenced by HREF | [optional]
128
+ **limit** | **Integer**| Number of results to return per page. | [optional]
129
+ **number** | **Integer**| | [optional]
130
+ **number__gt** | **Integer**| Filter results where number is greater than value | [optional]
131
+ **number__gte** | **Integer**| Filter results where number is greater than or equal to value | [optional]
132
+ **number__lt** | **Integer**| Filter results where number is less than value | [optional]
133
+ **number__lte** | **Integer**| Filter results where number is less than or equal to value | [optional]
134
+ **number__range** | [**Array&lt;Integer&gt;**](Integer.md)| Filter results where number is between two comma separated values | [optional]
135
+ **offset** | **Integer**| The initial index from which to return the results. | [optional]
136
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional]
137
+ **pulp_created** | **DateTime**| ISO 8601 formatted dates are supported | [optional]
138
+ **pulp_created__gt** | **DateTime**| Filter results where pulp_created is greater than value | [optional]
139
+ **pulp_created__gte** | **DateTime**| Filter results where pulp_created is greater than or equal to value | [optional]
140
+ **pulp_created__lt** | **DateTime**| Filter results where pulp_created is less than value | [optional]
141
+ **pulp_created__lte** | **DateTime**| Filter results where pulp_created is less than or equal to value | [optional]
142
+ **pulp_created__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_created is between two comma separated values | [optional]
143
+ **fields** | **String**| A list of fields to include in the response. | [optional]
144
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
145
+
146
+ ### Return type
147
+
148
+ [**PaginatedRepositoryVersionResponseList**](PaginatedRepositoryVersionResponseList.md)
149
+
150
+ ### Authorization
151
+
152
+ [basicAuth](../README.md#basicAuth)
153
+
154
+ ### HTTP request headers
155
+
156
+ - **Content-Type**: Not defined
157
+ - **Accept**: application/json
158
+
159
+
160
+ ## read
161
+
162
+ > RepositoryVersionResponse read(repositories_repository_version_href, opts)
163
+
164
+ Inspect a repository version
165
+
166
+ A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.
167
+
168
+ ### Example
169
+
170
+ ```ruby
171
+ # load the gem
172
+ require 'pulpcore_client'
173
+ # setup authorization
174
+ PulpcoreClient.configure do |config|
175
+ # Configure HTTP basic authorization: basicAuth
176
+ config.username = 'YOUR USERNAME'
177
+ config.password = 'YOUR PASSWORD'
178
+ end
179
+
180
+ api_instance = PulpcoreClient::RepositoriesVersionsApi.new
181
+ repositories_repository_version_href = 'repositories_repository_version_href_example' # String |
182
+ opts = {
183
+ fields: 'fields_example', # String | A list of fields to include in the response.
184
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
185
+ }
186
+
187
+ begin
188
+ #Inspect a repository version
189
+ result = api_instance.read(repositories_repository_version_href, opts)
190
+ p result
191
+ rescue PulpcoreClient::ApiError => e
192
+ puts "Exception when calling RepositoriesVersionsApi->read: #{e}"
193
+ end
194
+ ```
195
+
196
+ ### Parameters
197
+
198
+
199
+ Name | Type | Description | Notes
200
+ ------------- | ------------- | ------------- | -------------
201
+ **repositories_repository_version_href** | **String**| |
202
+ **fields** | **String**| A list of fields to include in the response. | [optional]
203
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
204
+
205
+ ### Return type
206
+
207
+ [**RepositoryVersionResponse**](RepositoryVersionResponse.md)
208
+
209
+ ### Authorization
210
+
211
+ [basicAuth](../README.md#basicAuth)
212
+
213
+ ### HTTP request headers
214
+
215
+ - **Content-Type**: Not defined
216
+ - **Accept**: application/json
217
+
218
+
219
+ ## repair
220
+
221
+ > AsyncOperationResponse repair(repositories_repository_version_href, repair)
222
+
223
+
224
+
225
+ Trigger an asynchronous task to repair a repository version.
226
+
227
+ ### Example
228
+
229
+ ```ruby
230
+ # load the gem
231
+ require 'pulpcore_client'
232
+ # setup authorization
233
+ PulpcoreClient.configure do |config|
234
+ # Configure HTTP basic authorization: basicAuth
235
+ config.username = 'YOUR USERNAME'
236
+ config.password = 'YOUR PASSWORD'
237
+ end
238
+
239
+ api_instance = PulpcoreClient::RepositoriesVersionsApi.new
240
+ repositories_repository_version_href = 'repositories_repository_version_href_example' # String |
241
+ repair = PulpcoreClient::Repair.new # Repair |
242
+
243
+ begin
244
+ result = api_instance.repair(repositories_repository_version_href, repair)
245
+ p result
246
+ rescue PulpcoreClient::ApiError => e
247
+ puts "Exception when calling RepositoriesVersionsApi->repair: #{e}"
248
+ end
249
+ ```
250
+
251
+ ### Parameters
252
+
253
+
254
+ Name | Type | Description | Notes
255
+ ------------- | ------------- | ------------- | -------------
256
+ **repositories_repository_version_href** | **String**| |
257
+ **repair** | [**Repair**](Repair.md)| |
258
+
259
+ ### Return type
260
+
261
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
262
+
263
+ ### Authorization
264
+
265
+ [basicAuth](../README.md#basicAuth)
266
+
267
+ ### HTTP request headers
268
+
269
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
270
+ - **Accept**: application/json
271
+
@@ -0,0 +1,25 @@
1
+ # PulpcoreClient::Repository
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **pulp_labels** | [**Object**](.md) | | [optional]
8
+ **name** | **String** | A unique name for this repository. |
9
+ **description** | **String** | An optional description. | [optional]
10
+ **retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. This is provided as a tech preview in Pulp 3 and may change in the future. | [optional]
11
+ **remote** | **String** | An optional remote to use by default when syncing. | [optional]
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'PulpcoreClient'
17
+
18
+ instance = PulpcoreClient::Repository.new(pulp_labels: null,
19
+ name: null,
20
+ description: null,
21
+ retain_repo_versions: null,
22
+ remote: null)
23
+ ```
24
+
25
+
@@ -38,6 +38,7 @@ opts = {
38
38
  number__lte: 56, # Integer | Filter results where number is less than or equal to value
39
39
  number__range: [56], # Array<Integer> | Filter results where number is between two comma separated values
40
40
  offset: 56, # Integer | The initial index from which to return the results.
41
+ ordering: ['ordering_example'], # Array<String> | Ordering
41
42
  pulp_created: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | ISO 8601 formatted dates are supported
42
43
  pulp_created__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than value
43
44
  pulp_created__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than or equal to value
@@ -72,6 +73,7 @@ Name | Type | Description | Notes
72
73
  **number__lte** | **Integer**| Filter results where number is less than or equal to value | [optional]
73
74
  **number__range** | [**Array&lt;Integer&gt;**](Integer.md)| Filter results where number is between two comma separated values | [optional]
74
75
  **offset** | **Integer**| The initial index from which to return the results. | [optional]
76
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional]
75
77
  **pulp_created** | **DateTime**| ISO 8601 formatted dates are supported | [optional]
76
78
  **pulp_created__gt** | **DateTime**| Filter results where pulp_created is greater than value | [optional]
77
79
  **pulp_created__gte** | **DateTime**| Filter results where pulp_created is greater than or equal to value | [optional]
data/docs/RolesApi.md CHANGED
@@ -140,10 +140,12 @@ end
140
140
 
141
141
  api_instance = PulpcoreClient::RolesApi.new
142
142
  opts = {
143
+ contains_permission: ['contains_permission_example'], # Array<String> | Filter roles that have any of the permissions in the list.
143
144
  description: 'description_example', # String | Filter results where description matches value
144
145
  description__contains: 'description__contains_example', # String | Filter results where description contains value
145
146
  description__icontains: 'description__icontains_example', # String | Filter results where description contains value
146
147
  description__iexact: 'description__iexact_example', # String | Filter results where description matches value
148
+ for_object_type: 'for_object_type_example', # String | Filter roles that only have permissions for the specified object HREF.
147
149
  limit: 56, # Integer | Number of results to return per page.
148
150
  locked: true, # Boolean | Filter results where locked matches value
149
151
  name: 'name_example', # String | Filter results where name matches value
@@ -152,7 +154,7 @@ opts = {
152
154
  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
153
155
  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
154
156
  offset: 56, # Integer | The initial index from which to return the results.
155
- ordering: 'ordering_example', # String | Which field to use when ordering the results.
157
+ ordering: ['ordering_example'], # Array<String> | Ordering
156
158
  fields: 'fields_example', # String | A list of fields to include in the response.
157
159
  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
158
160
  }
@@ -171,10 +173,12 @@ end
171
173
 
172
174
  Name | Type | Description | Notes
173
175
  ------------- | ------------- | ------------- | -------------
176
+ **contains_permission** | [**Array&lt;String&gt;**](String.md)| Filter roles that have any of the permissions in the list. | [optional]
174
177
  **description** | **String**| Filter results where description matches value | [optional]
175
178
  **description__contains** | **String**| Filter results where description contains value | [optional]
176
179
  **description__icontains** | **String**| Filter results where description contains value | [optional]
177
180
  **description__iexact** | **String**| Filter results where description matches value | [optional]
181
+ **for_object_type** | **String**| Filter roles that only have permissions for the specified object HREF. | [optional]
178
182
  **limit** | **Integer**| Number of results to return per page. | [optional]
179
183
  **locked** | **Boolean**| Filter results where locked matches value | [optional]
180
184
  **name** | **String**| Filter results where name matches value | [optional]
@@ -183,7 +187,7 @@ Name | Type | Description | Notes
183
187
  **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
184
188
  **name__startswith** | **String**| Filter results where name starts with value | [optional]
185
189
  **offset** | **Integer**| The initial index from which to return the results. | [optional]
186
- **ordering** | **String**| Which field to use when ordering the results. | [optional]
190
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional]
187
191
  **fields** | **String**| A list of fields to include in the response. | [optional]
188
192
  **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
189
193
 
@@ -34,7 +34,6 @@ opts = {
34
34
  limit: 56, # Integer | Number of results to return per page.
35
35
  name: 'name_example', # String |
36
36
  offset: 56, # Integer | The initial index from which to return the results.
37
- ordering: 'ordering_example', # String | Which field to use when ordering the results.
38
37
  fields: 'fields_example', # String | A list of fields to include in the response.
39
38
  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
40
39
  }
@@ -56,7 +55,6 @@ Name | Type | Description | Notes
56
55
  **limit** | **Integer**| Number of results to return per page. | [optional]
57
56
  **name** | **String**| | [optional]
58
57
  **offset** | **Integer**| The initial index from which to return the results. | [optional]
59
- **ordering** | **String**| Which field to use when ordering the results. | [optional]
60
58
  **fields** | **String**| A list of fields to include in the response. | [optional]
61
59
  **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
62
60