pulpcore_client 3.22.20 → 3.23.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +26 -4
- data/docs/ArtifactDistributionResponse.md +9 -9
- data/docs/DistributionsApi.md +4 -0
- data/docs/DistributionsArtifactsApi.md +4 -0
- data/docs/Domain.md +27 -0
- data/docs/DomainResponse.md +31 -0
- data/docs/DomainsApi.md +362 -0
- data/docs/ExportersFilesystemApi.md +3 -3
- data/docs/ExportersFilesystemExportsApi.md +3 -3
- data/docs/GroupRole.md +3 -1
- data/docs/GroupRoleResponse.md +3 -1
- data/docs/GroupsApi.md +6 -6
- data/docs/GroupsRolesApi.md +6 -4
- data/docs/PaginatedDomainResponseList.md +23 -0
- data/docs/PaginatedUpstreamPulpResponseList.md +23 -0
- data/docs/PatchedDomain.md +27 -0
- data/docs/PatchedUpstreamPulp.md +37 -0
- data/docs/RepositoriesApi.md +16 -0
- data/docs/RepositoryResponse.md +1 -1
- data/docs/RolesApi.md +6 -6
- data/docs/StatusResponse.md +3 -1
- data/docs/StorageClassEnum.md +16 -0
- data/docs/TaskSchedulesApi.md +2 -2
- data/docs/TasksApi.md +1 -1
- data/docs/UpstreamPulp.md +37 -0
- data/docs/UpstreamPulpResponse.md +39 -0
- data/docs/UpstreamPulpsApi.md +405 -0
- data/docs/UserRole.md +4 -2
- data/docs/UserRoleResponse.md +4 -2
- data/docs/UsersApi.md +6 -6
- data/docs/UsersRolesApi.md +6 -4
- data/docs/VersionResponse.md +3 -1
- data/lib/pulpcore_client/api/distributions_api.rb +6 -0
- data/lib/pulpcore_client/api/distributions_artifacts_api.rb +6 -0
- data/lib/pulpcore_client/api/domains_api.rb +446 -0
- data/lib/pulpcore_client/api/exporters_filesystem_api.rb +6 -6
- data/lib/pulpcore_client/api/exporters_filesystem_exports_api.rb +6 -6
- data/lib/pulpcore_client/api/groups_api.rb +12 -12
- data/lib/pulpcore_client/api/groups_roles_api.rb +11 -8
- data/lib/pulpcore_client/api/repositories_api.rb +24 -0
- data/lib/pulpcore_client/api/roles_api.rb +12 -12
- data/lib/pulpcore_client/api/task_schedules_api.rb +4 -4
- data/lib/pulpcore_client/api/tasks_api.rb +2 -2
- data/lib/pulpcore_client/api/upstream_pulps_api.rb +492 -0
- data/lib/pulpcore_client/api/users_api.rb +12 -12
- data/lib/pulpcore_client/api/users_roles_api.rb +11 -8
- data/lib/pulpcore_client/api/workers_api.rb +1 -1
- data/lib/pulpcore_client/models/artifact_distribution_response.rb +43 -43
- data/lib/pulpcore_client/models/domain.rb +323 -0
- data/lib/pulpcore_client/models/domain_response.rb +318 -0
- data/lib/pulpcore_client/models/group_role.rb +16 -5
- data/lib/pulpcore_client/models/group_role_response.rb +15 -4
- data/lib/pulpcore_client/models/nested_role.rb +19 -0
- data/lib/pulpcore_client/models/paginated_domain_response_list.rb +237 -0
- data/lib/pulpcore_client/models/paginated_upstream_pulp_response_list.rb +237 -0
- data/lib/pulpcore_client/models/patched_domain.rb +304 -0
- data/lib/pulpcore_client/models/patched_upstream_pulp.rb +450 -0
- data/lib/pulpcore_client/models/repository_response.rb +1 -1
- data/lib/pulpcore_client/models/status_response.rb +19 -4
- data/lib/pulpcore_client/models/storage_class_enum.rb +37 -0
- data/lib/pulpcore_client/models/upstream_pulp.rb +477 -0
- data/lib/pulpcore_client/models/upstream_pulp_response.rb +338 -0
- data/lib/pulpcore_client/models/user_role.rb +17 -6
- data/lib/pulpcore_client/models/user_role_response.rb +16 -5
- data/lib/pulpcore_client/models/version_response.rb +19 -4
- data/lib/pulpcore_client/version.rb +1 -1
- data/lib/pulpcore_client.rb +11 -0
- data/spec/api/distributions_api_spec.rb +2 -0
- data/spec/api/distributions_artifacts_api_spec.rb +2 -0
- data/spec/api/domains_api_spec.rb +120 -0
- data/spec/api/exporters_filesystem_api_spec.rb +3 -3
- data/spec/api/exporters_filesystem_exports_api_spec.rb +3 -3
- data/spec/api/groups_api_spec.rb +6 -6
- data/spec/api/groups_roles_api_spec.rb +5 -4
- data/spec/api/repositories_api_spec.rb +8 -0
- data/spec/api/roles_api_spec.rb +6 -6
- data/spec/api/task_schedules_api_spec.rb +2 -2
- data/spec/api/tasks_api_spec.rb +1 -1
- data/spec/api/upstream_pulps_api_spec.rb +127 -0
- data/spec/api/users_api_spec.rb +6 -6
- data/spec/api/users_roles_api_spec.rb +5 -4
- data/spec/models/artifact_distribution_response_spec.rb +7 -7
- data/spec/models/domain_response_spec.rb +83 -0
- data/spec/models/domain_spec.rb +71 -0
- data/spec/models/group_role_response_spec.rb +6 -0
- data/spec/models/group_role_spec.rb +6 -0
- data/spec/models/paginated_domain_response_list_spec.rb +59 -0
- data/spec/models/paginated_upstream_pulp_response_list_spec.rb +59 -0
- data/spec/models/patched_domain_spec.rb +71 -0
- data/spec/models/patched_upstream_pulp_spec.rb +101 -0
- data/spec/models/status_response_spec.rb +6 -0
- data/spec/models/storage_class_enum_spec.rb +35 -0
- data/spec/models/upstream_pulp_response_spec.rb +107 -0
- data/spec/models/upstream_pulp_spec.rb +101 -0
- data/spec/models/user_role_response_spec.rb +6 -0
- data/spec/models/user_role_spec.rb +6 -0
- data/spec/models/version_response_spec.rb +6 -0
- metadata +178 -134
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 27e22c568fe64e64c7b06137a6c586966bf7665a45de956d23f8ae1d217f3244
|
4
|
+
data.tar.gz: 35b2f27b75a1d64a84c43f8de778b9b42492caa4cf26191832788c07880c0b4c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4bf7ec2ed3c1da66b46b2d781c4906c5ca32761d07ca52a20718eb996bf341e640bfba0dad2f4895536e7ee99014256b629228b6e5d11eaf9609b9a358dc6c57
|
7
|
+
data.tar.gz: da9f58d3590209937e4e092e88d6b8eda7b227a963605f5b2cb2f7bd22c01a0460c45ebcbe8e2089a4936b03376299fcc6314a8277731e66cbf5a1a045a33626
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Fetch, Upload, Organize, and Distribute Software Packages
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: v3
|
10
|
-
- Package version: 3.
|
10
|
+
- Package version: 3.23.0
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://pulpproject.org](https://pulpproject.org)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build pulpcore_client.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./pulpcore_client-3.
|
27
|
+
gem install ./pulpcore_client-3.23.0.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./pulpcore_client-3.
|
30
|
+
(for development, run `gem install --dev ./pulpcore_client-3.23.0.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'pulpcore_client', '~> 3.
|
36
|
+
gem 'pulpcore_client', '~> 3.23.0'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -129,6 +129,12 @@ Class | Method | HTTP request | Description
|
|
129
129
|
*PulpcoreClient::DistributionsApi* | [**list**](docs/DistributionsApi.md#list) | **GET** /pulp/api/v3/distributions/ | List distributions
|
130
130
|
*PulpcoreClient::DistributionsArtifactsApi* | [**list**](docs/DistributionsArtifactsApi.md#list) | **GET** /pulp/api/v3/distributions/core/artifacts/ | List artifact distributions
|
131
131
|
*PulpcoreClient::DistributionsArtifactsApi* | [**read**](docs/DistributionsArtifactsApi.md#read) | **GET** {artifact_distribution_href} | Inspect an artifact distribution
|
132
|
+
*PulpcoreClient::DomainsApi* | [**create**](docs/DomainsApi.md#create) | **POST** /pulp/api/v3/domains/ | Create a domain
|
133
|
+
*PulpcoreClient::DomainsApi* | [**delete**](docs/DomainsApi.md#delete) | **DELETE** {domain_href} | Delete a domain
|
134
|
+
*PulpcoreClient::DomainsApi* | [**list**](docs/DomainsApi.md#list) | **GET** /pulp/api/v3/domains/ | List domains
|
135
|
+
*PulpcoreClient::DomainsApi* | [**partial_update**](docs/DomainsApi.md#partial_update) | **PATCH** {domain_href} | Update a domain
|
136
|
+
*PulpcoreClient::DomainsApi* | [**read**](docs/DomainsApi.md#read) | **GET** {domain_href} | Inspect a domain
|
137
|
+
*PulpcoreClient::DomainsApi* | [**update**](docs/DomainsApi.md#update) | **PUT** {domain_href} | Update a domain
|
132
138
|
*PulpcoreClient::ExportersFilesystemApi* | [**create**](docs/ExportersFilesystemApi.md#create) | **POST** /pulp/api/v3/exporters/core/filesystem/ | Create a filesystem exporter
|
133
139
|
*PulpcoreClient::ExportersFilesystemApi* | [**delete**](docs/ExportersFilesystemApi.md#delete) | **DELETE** {filesystem_exporter_href} | Delete a filesystem exporter
|
134
140
|
*PulpcoreClient::ExportersFilesystemApi* | [**list**](docs/ExportersFilesystemApi.md#list) | **GET** /pulp/api/v3/exporters/core/filesystem/ | List filesystem exporters
|
@@ -221,6 +227,13 @@ Class | Method | HTTP request | Description
|
|
221
227
|
*PulpcoreClient::UploadsApi* | [**read**](docs/UploadsApi.md#read) | **GET** {upload_href} | Inspect an upload
|
222
228
|
*PulpcoreClient::UploadsApi* | [**remove_role**](docs/UploadsApi.md#remove_role) | **POST** {upload_href}remove_role/ |
|
223
229
|
*PulpcoreClient::UploadsApi* | [**update**](docs/UploadsApi.md#update) | **PUT** {upload_href} | Upload a file chunk
|
230
|
+
*PulpcoreClient::UpstreamPulpsApi* | [**create**](docs/UpstreamPulpsApi.md#create) | **POST** /pulp/api/v3/upstream-pulps/ | Create an upstream pulp
|
231
|
+
*PulpcoreClient::UpstreamPulpsApi* | [**delete**](docs/UpstreamPulpsApi.md#delete) | **DELETE** {upstream_pulp_href} | Delete an upstream pulp
|
232
|
+
*PulpcoreClient::UpstreamPulpsApi* | [**list**](docs/UpstreamPulpsApi.md#list) | **GET** /pulp/api/v3/upstream-pulps/ | List upstream pulps
|
233
|
+
*PulpcoreClient::UpstreamPulpsApi* | [**partial_update**](docs/UpstreamPulpsApi.md#partial_update) | **PATCH** {upstream_pulp_href} | Update an upstream pulp
|
234
|
+
*PulpcoreClient::UpstreamPulpsApi* | [**read**](docs/UpstreamPulpsApi.md#read) | **GET** {upstream_pulp_href} | Inspect an upstream pulp
|
235
|
+
*PulpcoreClient::UpstreamPulpsApi* | [**replicate**](docs/UpstreamPulpsApi.md#replicate) | **POST** {upstream_pulp_href}replicate/ | Replicate
|
236
|
+
*PulpcoreClient::UpstreamPulpsApi* | [**update**](docs/UpstreamPulpsApi.md#update) | **PUT** {upstream_pulp_href} | Update an upstream pulp
|
224
237
|
*PulpcoreClient::UsersApi* | [**create**](docs/UsersApi.md#create) | **POST** /pulp/api/v3/users/ | Create an user
|
225
238
|
*PulpcoreClient::UsersApi* | [**delete**](docs/UsersApi.md#delete) | **DELETE** {auth_user_href} | Delete an user
|
226
239
|
*PulpcoreClient::UsersApi* | [**list**](docs/UsersApi.md#list) | **GET** /pulp/api/v3/users/ | List users
|
@@ -251,6 +264,8 @@ Class | Method | HTTP request | Description
|
|
251
264
|
- [PulpcoreClient::ContentSummaryResponse](docs/ContentSummaryResponse.md)
|
252
265
|
- [PulpcoreClient::DatabaseConnectionResponse](docs/DatabaseConnectionResponse.md)
|
253
266
|
- [PulpcoreClient::DistributionResponse](docs/DistributionResponse.md)
|
267
|
+
- [PulpcoreClient::Domain](docs/Domain.md)
|
268
|
+
- [PulpcoreClient::DomainResponse](docs/DomainResponse.md)
|
254
269
|
- [PulpcoreClient::EvaluationResponse](docs/EvaluationResponse.md)
|
255
270
|
- [PulpcoreClient::FilesystemExport](docs/FilesystemExport.md)
|
256
271
|
- [PulpcoreClient::FilesystemExportResponse](docs/FilesystemExportResponse.md)
|
@@ -278,6 +293,7 @@ Class | Method | HTTP request | Description
|
|
278
293
|
- [PulpcoreClient::PaginatedContentGuardResponseList](docs/PaginatedContentGuardResponseList.md)
|
279
294
|
- [PulpcoreClient::PaginatedContentRedirectContentGuardResponseList](docs/PaginatedContentRedirectContentGuardResponseList.md)
|
280
295
|
- [PulpcoreClient::PaginatedDistributionResponseList](docs/PaginatedDistributionResponseList.md)
|
296
|
+
- [PulpcoreClient::PaginatedDomainResponseList](docs/PaginatedDomainResponseList.md)
|
281
297
|
- [PulpcoreClient::PaginatedFilesystemExportResponseList](docs/PaginatedFilesystemExportResponseList.md)
|
282
298
|
- [PulpcoreClient::PaginatedFilesystemExporterResponseList](docs/PaginatedFilesystemExporterResponseList.md)
|
283
299
|
- [PulpcoreClient::PaginatedGroupResponseList](docs/PaginatedGroupResponseList.md)
|
@@ -299,11 +315,13 @@ Class | Method | HTTP request | Description
|
|
299
315
|
- [PulpcoreClient::PaginatedTaskResponseList](docs/PaginatedTaskResponseList.md)
|
300
316
|
- [PulpcoreClient::PaginatedTaskScheduleResponseList](docs/PaginatedTaskScheduleResponseList.md)
|
301
317
|
- [PulpcoreClient::PaginatedUploadResponseList](docs/PaginatedUploadResponseList.md)
|
318
|
+
- [PulpcoreClient::PaginatedUpstreamPulpResponseList](docs/PaginatedUpstreamPulpResponseList.md)
|
302
319
|
- [PulpcoreClient::PaginatedUserResponseList](docs/PaginatedUserResponseList.md)
|
303
320
|
- [PulpcoreClient::PaginatedUserRoleResponseList](docs/PaginatedUserRoleResponseList.md)
|
304
321
|
- [PulpcoreClient::PaginatedWorkerResponseList](docs/PaginatedWorkerResponseList.md)
|
305
322
|
- [PulpcoreClient::PatchedAccessPolicy](docs/PatchedAccessPolicy.md)
|
306
323
|
- [PulpcoreClient::PatchedContentRedirectContentGuard](docs/PatchedContentRedirectContentGuard.md)
|
324
|
+
- [PulpcoreClient::PatchedDomain](docs/PatchedDomain.md)
|
307
325
|
- [PulpcoreClient::PatchedFilesystemExporter](docs/PatchedFilesystemExporter.md)
|
308
326
|
- [PulpcoreClient::PatchedGroup](docs/PatchedGroup.md)
|
309
327
|
- [PulpcoreClient::PatchedPulpExporter](docs/PatchedPulpExporter.md)
|
@@ -311,6 +329,7 @@ Class | Method | HTTP request | Description
|
|
311
329
|
- [PulpcoreClient::PatchedRBACContentGuard](docs/PatchedRBACContentGuard.md)
|
312
330
|
- [PulpcoreClient::PatchedRole](docs/PatchedRole.md)
|
313
331
|
- [PulpcoreClient::PatchedTaskCancel](docs/PatchedTaskCancel.md)
|
332
|
+
- [PulpcoreClient::PatchedUpstreamPulp](docs/PatchedUpstreamPulp.md)
|
314
333
|
- [PulpcoreClient::PatchedUser](docs/PatchedUser.md)
|
315
334
|
- [PulpcoreClient::PolicyEnum](docs/PolicyEnum.md)
|
316
335
|
- [PulpcoreClient::ProgressReportResponse](docs/ProgressReportResponse.md)
|
@@ -339,6 +358,7 @@ Class | Method | HTTP request | Description
|
|
339
358
|
- [PulpcoreClient::SigningServiceResponse](docs/SigningServiceResponse.md)
|
340
359
|
- [PulpcoreClient::StatesEnum](docs/StatesEnum.md)
|
341
360
|
- [PulpcoreClient::StatusResponse](docs/StatusResponse.md)
|
361
|
+
- [PulpcoreClient::StorageClassEnum](docs/StorageClassEnum.md)
|
342
362
|
- [PulpcoreClient::StorageResponse](docs/StorageResponse.md)
|
343
363
|
- [PulpcoreClient::TaskGroupOperationResponse](docs/TaskGroupOperationResponse.md)
|
344
364
|
- [PulpcoreClient::TaskGroupResponse](docs/TaskGroupResponse.md)
|
@@ -350,6 +370,8 @@ Class | Method | HTTP request | Description
|
|
350
370
|
- [PulpcoreClient::UploadCommit](docs/UploadCommit.md)
|
351
371
|
- [PulpcoreClient::UploadDetailResponse](docs/UploadDetailResponse.md)
|
352
372
|
- [PulpcoreClient::UploadResponse](docs/UploadResponse.md)
|
373
|
+
- [PulpcoreClient::UpstreamPulp](docs/UpstreamPulp.md)
|
374
|
+
- [PulpcoreClient::UpstreamPulpResponse](docs/UpstreamPulpResponse.md)
|
353
375
|
- [PulpcoreClient::User](docs/User.md)
|
354
376
|
- [PulpcoreClient::UserGroup](docs/UserGroup.md)
|
355
377
|
- [PulpcoreClient::UserGroupResponse](docs/UserGroupResponse.md)
|
@@ -4,26 +4,26 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |
|
8
|
-
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
9
7
|
**pulp_href** | **String** | | [optional] [readonly]
|
10
|
-
**base_url** | **String** | The URL for accessing the publication as defined by this distribution. | [optional] [readonly]
|
11
|
-
**content_guard** | **String** | An optional content-guard. | [optional]
|
12
8
|
**pulp_labels** | **Hash<String, String>** | | [optional]
|
9
|
+
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
10
|
+
**content_guard** | **String** | An optional content-guard. | [optional]
|
11
|
+
**base_url** | **String** | The URL for accessing the publication as defined by this distribution. | [optional] [readonly]
|
13
12
|
**name** | **String** | A unique name. Ex, `rawhide` and `stable`. |
|
13
|
+
**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |
|
14
14
|
|
15
15
|
## Code Sample
|
16
16
|
|
17
17
|
```ruby
|
18
18
|
require 'PulpcoreClient'
|
19
19
|
|
20
|
-
instance = PulpcoreClient::ArtifactDistributionResponse.new(
|
20
|
+
instance = PulpcoreClient::ArtifactDistributionResponse.new(pulp_href: null,
|
21
|
+
pulp_labels: null,
|
21
22
|
pulp_created: null,
|
22
|
-
pulp_href: null,
|
23
|
-
base_url: null,
|
24
23
|
content_guard: null,
|
25
|
-
|
26
|
-
name: null
|
24
|
+
base_url: null,
|
25
|
+
name: null,
|
26
|
+
base_path: null)
|
27
27
|
```
|
28
28
|
|
29
29
|
|
data/docs/DistributionsApi.md
CHANGED
@@ -43,6 +43,8 @@ opts = {
|
|
43
43
|
offset: 56, # Integer | The initial index from which to return the results.
|
44
44
|
ordering: ['ordering_example'], # Array<String> | Ordering
|
45
45
|
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
46
|
+
repository: 'repository_example', # String | Filter results where repository matches value
|
47
|
+
repository__in: ['repository__in_example'], # Array<String> | Filter results where repository is in a comma-separated list of values
|
46
48
|
with_content: 'with_content_example', # String | Filter distributions based on the content served by them
|
47
49
|
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
48
50
|
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
@@ -75,6 +77,8 @@ Name | Type | Description | Notes
|
|
75
77
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
76
78
|
**ordering** | [**Array<String>**](String.md)| Ordering | [optional]
|
77
79
|
**pulp_label_select** | **String**| Filter labels by search string | [optional]
|
80
|
+
**repository** | **String**| Filter results where repository matches value | [optional]
|
81
|
+
**repository__in** | [**Array<String>**](String.md)| Filter results where repository is in a comma-separated list of values | [optional]
|
78
82
|
**with_content** | **String**| Filter distributions based on the content served by them | [optional]
|
79
83
|
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
80
84
|
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
@@ -44,6 +44,8 @@ opts = {
|
|
44
44
|
offset: 56, # Integer | The initial index from which to return the results.
|
45
45
|
ordering: ['ordering_example'], # Array<String> | Ordering
|
46
46
|
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
47
|
+
repository: 'repository_example', # String | Filter results where repository matches value
|
48
|
+
repository__in: ['repository__in_example'], # Array<String> | Filter results where repository is in a comma-separated list of values
|
47
49
|
with_content: 'with_content_example', # String | Filter distributions based on the content served by them
|
48
50
|
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
49
51
|
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
@@ -76,6 +78,8 @@ Name | Type | Description | Notes
|
|
76
78
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
77
79
|
**ordering** | [**Array<String>**](String.md)| Ordering | [optional]
|
78
80
|
**pulp_label_select** | **String**| Filter labels by search string | [optional]
|
81
|
+
**repository** | **String**| Filter results where repository matches value | [optional]
|
82
|
+
**repository__in** | [**Array<String>**](String.md)| Filter results where repository is in a comma-separated list of values | [optional]
|
79
83
|
**with_content** | **String**| Filter distributions based on the content served by them | [optional]
|
80
84
|
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
81
85
|
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
data/docs/Domain.md
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
# PulpcoreClient::Domain
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | A name for this domain. |
|
8
|
+
**description** | **String** | An optional description. | [optional]
|
9
|
+
**storage_class** | [**StorageClassEnum**](StorageClassEnum.md) | Backend storage class for domain. |
|
10
|
+
**storage_settings** | [**Object**](.md) | Settings for storage class. |
|
11
|
+
**redirect_to_object_storage** | **Boolean** | Boolean to have the content app redirect to object storage. | [optional] [default to true]
|
12
|
+
**hide_guarded_distributions** | **Boolean** | Boolean to hide distributions with a content guard in the content app. | [optional] [default to false]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'PulpcoreClient'
|
18
|
+
|
19
|
+
instance = PulpcoreClient::Domain.new(name: null,
|
20
|
+
description: null,
|
21
|
+
storage_class: null,
|
22
|
+
storage_settings: null,
|
23
|
+
redirect_to_object_storage: null,
|
24
|
+
hide_guarded_distributions: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# PulpcoreClient::DomainResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**pulp_href** | **String** | | [optional] [readonly]
|
8
|
+
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
9
|
+
**name** | **String** | A name for this domain. |
|
10
|
+
**description** | **String** | An optional description. | [optional]
|
11
|
+
**storage_class** | [**StorageClassEnum**](StorageClassEnum.md) | Backend storage class for domain. |
|
12
|
+
**storage_settings** | [**Object**](.md) | Settings for storage class. |
|
13
|
+
**redirect_to_object_storage** | **Boolean** | Boolean to have the content app redirect to object storage. | [optional] [default to true]
|
14
|
+
**hide_guarded_distributions** | **Boolean** | Boolean to hide distributions with a content guard in the content app. | [optional] [default to false]
|
15
|
+
|
16
|
+
## Code Sample
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'PulpcoreClient'
|
20
|
+
|
21
|
+
instance = PulpcoreClient::DomainResponse.new(pulp_href: null,
|
22
|
+
pulp_created: null,
|
23
|
+
name: null,
|
24
|
+
description: null,
|
25
|
+
storage_class: null,
|
26
|
+
storage_settings: null,
|
27
|
+
redirect_to_object_storage: null,
|
28
|
+
hide_guarded_distributions: null)
|
29
|
+
```
|
30
|
+
|
31
|
+
|
data/docs/DomainsApi.md
ADDED
@@ -0,0 +1,362 @@
|
|
1
|
+
# PulpcoreClient::DomainsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pulp*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create**](DomainsApi.md#create) | **POST** /pulp/api/v3/domains/ | Create a domain
|
8
|
+
[**delete**](DomainsApi.md#delete) | **DELETE** {domain_href} | Delete a domain
|
9
|
+
[**list**](DomainsApi.md#list) | **GET** /pulp/api/v3/domains/ | List domains
|
10
|
+
[**partial_update**](DomainsApi.md#partial_update) | **PATCH** {domain_href} | Update a domain
|
11
|
+
[**read**](DomainsApi.md#read) | **GET** {domain_href} | Inspect a domain
|
12
|
+
[**update**](DomainsApi.md#update) | **PUT** {domain_href} | Update a domain
|
13
|
+
|
14
|
+
|
15
|
+
|
16
|
+
## create
|
17
|
+
|
18
|
+
> DomainResponse create(domain)
|
19
|
+
|
20
|
+
Create a domain
|
21
|
+
|
22
|
+
ViewSet for Domain. NOTE: This API endpoint is in \"tech preview\" and subject to change
|
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::DomainsApi.new
|
37
|
+
domain = PulpcoreClient::Domain.new # Domain |
|
38
|
+
|
39
|
+
begin
|
40
|
+
#Create a domain
|
41
|
+
result = api_instance.create(domain)
|
42
|
+
p result
|
43
|
+
rescue PulpcoreClient::ApiError => e
|
44
|
+
puts "Exception when calling DomainsApi->create: #{e}"
|
45
|
+
end
|
46
|
+
```
|
47
|
+
|
48
|
+
### Parameters
|
49
|
+
|
50
|
+
|
51
|
+
Name | Type | Description | Notes
|
52
|
+
------------- | ------------- | ------------- | -------------
|
53
|
+
**domain** | [**Domain**](Domain.md)| |
|
54
|
+
|
55
|
+
### Return type
|
56
|
+
|
57
|
+
[**DomainResponse**](DomainResponse.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(domain_href)
|
72
|
+
|
73
|
+
Delete a domain
|
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::DomainsApi.new
|
90
|
+
domain_href = 'domain_href_example' # String |
|
91
|
+
|
92
|
+
begin
|
93
|
+
#Delete a domain
|
94
|
+
result = api_instance.delete(domain_href)
|
95
|
+
p result
|
96
|
+
rescue PulpcoreClient::ApiError => e
|
97
|
+
puts "Exception when calling DomainsApi->delete: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
### Parameters
|
102
|
+
|
103
|
+
|
104
|
+
Name | Type | Description | Notes
|
105
|
+
------------- | ------------- | ------------- | -------------
|
106
|
+
**domain_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
|
+
|
122
|
+
## list
|
123
|
+
|
124
|
+
> PaginatedDomainResponseList list(opts)
|
125
|
+
|
126
|
+
List domains
|
127
|
+
|
128
|
+
ViewSet for Domain. NOTE: This API endpoint is in \"tech preview\" and subject to change
|
129
|
+
|
130
|
+
### Example
|
131
|
+
|
132
|
+
```ruby
|
133
|
+
# load the gem
|
134
|
+
require 'pulpcore_client'
|
135
|
+
# setup authorization
|
136
|
+
PulpcoreClient.configure do |config|
|
137
|
+
# Configure HTTP basic authorization: basicAuth
|
138
|
+
config.username = 'YOUR USERNAME'
|
139
|
+
config.password = 'YOUR PASSWORD'
|
140
|
+
end
|
141
|
+
|
142
|
+
api_instance = PulpcoreClient::DomainsApi.new
|
143
|
+
opts = {
|
144
|
+
limit: 56, # Integer | Number of results to return per page.
|
145
|
+
name: 'name_example', # String | Filter results where name matches value
|
146
|
+
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
147
|
+
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
148
|
+
name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
149
|
+
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
150
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
151
|
+
ordering: ['ordering_example'], # Array<String> | Ordering
|
152
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
153
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
154
|
+
}
|
155
|
+
|
156
|
+
begin
|
157
|
+
#List domains
|
158
|
+
result = api_instance.list(opts)
|
159
|
+
p result
|
160
|
+
rescue PulpcoreClient::ApiError => e
|
161
|
+
puts "Exception when calling DomainsApi->list: #{e}"
|
162
|
+
end
|
163
|
+
```
|
164
|
+
|
165
|
+
### Parameters
|
166
|
+
|
167
|
+
|
168
|
+
Name | Type | Description | Notes
|
169
|
+
------------- | ------------- | ------------- | -------------
|
170
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
171
|
+
**name** | **String**| Filter results where name matches value | [optional]
|
172
|
+
**name__contains** | **String**| Filter results where name contains value | [optional]
|
173
|
+
**name__icontains** | **String**| Filter results where name contains value | [optional]
|
174
|
+
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
175
|
+
**name__startswith** | **String**| Filter results where name starts with value | [optional]
|
176
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
177
|
+
**ordering** | [**Array<String>**](String.md)| Ordering | [optional]
|
178
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
179
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
180
|
+
|
181
|
+
### Return type
|
182
|
+
|
183
|
+
[**PaginatedDomainResponseList**](PaginatedDomainResponseList.md)
|
184
|
+
|
185
|
+
### Authorization
|
186
|
+
|
187
|
+
[basicAuth](../README.md#basicAuth)
|
188
|
+
|
189
|
+
### HTTP request headers
|
190
|
+
|
191
|
+
- **Content-Type**: Not defined
|
192
|
+
- **Accept**: application/json
|
193
|
+
|
194
|
+
|
195
|
+
## partial_update
|
196
|
+
|
197
|
+
> AsyncOperationResponse partial_update(domain_href, patched_domain)
|
198
|
+
|
199
|
+
Update a domain
|
200
|
+
|
201
|
+
Trigger an asynchronous partial update task
|
202
|
+
|
203
|
+
### Example
|
204
|
+
|
205
|
+
```ruby
|
206
|
+
# load the gem
|
207
|
+
require 'pulpcore_client'
|
208
|
+
# setup authorization
|
209
|
+
PulpcoreClient.configure do |config|
|
210
|
+
# Configure HTTP basic authorization: basicAuth
|
211
|
+
config.username = 'YOUR USERNAME'
|
212
|
+
config.password = 'YOUR PASSWORD'
|
213
|
+
end
|
214
|
+
|
215
|
+
api_instance = PulpcoreClient::DomainsApi.new
|
216
|
+
domain_href = 'domain_href_example' # String |
|
217
|
+
patched_domain = PulpcoreClient::PatchedDomain.new # PatchedDomain |
|
218
|
+
|
219
|
+
begin
|
220
|
+
#Update a domain
|
221
|
+
result = api_instance.partial_update(domain_href, patched_domain)
|
222
|
+
p result
|
223
|
+
rescue PulpcoreClient::ApiError => e
|
224
|
+
puts "Exception when calling DomainsApi->partial_update: #{e}"
|
225
|
+
end
|
226
|
+
```
|
227
|
+
|
228
|
+
### Parameters
|
229
|
+
|
230
|
+
|
231
|
+
Name | Type | Description | Notes
|
232
|
+
------------- | ------------- | ------------- | -------------
|
233
|
+
**domain_href** | **String**| |
|
234
|
+
**patched_domain** | [**PatchedDomain**](PatchedDomain.md)| |
|
235
|
+
|
236
|
+
### Return type
|
237
|
+
|
238
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
239
|
+
|
240
|
+
### Authorization
|
241
|
+
|
242
|
+
[basicAuth](../README.md#basicAuth)
|
243
|
+
|
244
|
+
### HTTP request headers
|
245
|
+
|
246
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
247
|
+
- **Accept**: application/json
|
248
|
+
|
249
|
+
|
250
|
+
## read
|
251
|
+
|
252
|
+
> DomainResponse read(domain_href, opts)
|
253
|
+
|
254
|
+
Inspect a domain
|
255
|
+
|
256
|
+
ViewSet for Domain. NOTE: This API endpoint is in \"tech preview\" and subject to change
|
257
|
+
|
258
|
+
### Example
|
259
|
+
|
260
|
+
```ruby
|
261
|
+
# load the gem
|
262
|
+
require 'pulpcore_client'
|
263
|
+
# setup authorization
|
264
|
+
PulpcoreClient.configure do |config|
|
265
|
+
# Configure HTTP basic authorization: basicAuth
|
266
|
+
config.username = 'YOUR USERNAME'
|
267
|
+
config.password = 'YOUR PASSWORD'
|
268
|
+
end
|
269
|
+
|
270
|
+
api_instance = PulpcoreClient::DomainsApi.new
|
271
|
+
domain_href = 'domain_href_example' # String |
|
272
|
+
opts = {
|
273
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
274
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
275
|
+
}
|
276
|
+
|
277
|
+
begin
|
278
|
+
#Inspect a domain
|
279
|
+
result = api_instance.read(domain_href, opts)
|
280
|
+
p result
|
281
|
+
rescue PulpcoreClient::ApiError => e
|
282
|
+
puts "Exception when calling DomainsApi->read: #{e}"
|
283
|
+
end
|
284
|
+
```
|
285
|
+
|
286
|
+
### Parameters
|
287
|
+
|
288
|
+
|
289
|
+
Name | Type | Description | Notes
|
290
|
+
------------- | ------------- | ------------- | -------------
|
291
|
+
**domain_href** | **String**| |
|
292
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
293
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
294
|
+
|
295
|
+
### Return type
|
296
|
+
|
297
|
+
[**DomainResponse**](DomainResponse.md)
|
298
|
+
|
299
|
+
### Authorization
|
300
|
+
|
301
|
+
[basicAuth](../README.md#basicAuth)
|
302
|
+
|
303
|
+
### HTTP request headers
|
304
|
+
|
305
|
+
- **Content-Type**: Not defined
|
306
|
+
- **Accept**: application/json
|
307
|
+
|
308
|
+
|
309
|
+
## update
|
310
|
+
|
311
|
+
> AsyncOperationResponse update(domain_href, domain)
|
312
|
+
|
313
|
+
Update a domain
|
314
|
+
|
315
|
+
Trigger an asynchronous update task
|
316
|
+
|
317
|
+
### Example
|
318
|
+
|
319
|
+
```ruby
|
320
|
+
# load the gem
|
321
|
+
require 'pulpcore_client'
|
322
|
+
# setup authorization
|
323
|
+
PulpcoreClient.configure do |config|
|
324
|
+
# Configure HTTP basic authorization: basicAuth
|
325
|
+
config.username = 'YOUR USERNAME'
|
326
|
+
config.password = 'YOUR PASSWORD'
|
327
|
+
end
|
328
|
+
|
329
|
+
api_instance = PulpcoreClient::DomainsApi.new
|
330
|
+
domain_href = 'domain_href_example' # String |
|
331
|
+
domain = PulpcoreClient::Domain.new # Domain |
|
332
|
+
|
333
|
+
begin
|
334
|
+
#Update a domain
|
335
|
+
result = api_instance.update(domain_href, domain)
|
336
|
+
p result
|
337
|
+
rescue PulpcoreClient::ApiError => e
|
338
|
+
puts "Exception when calling DomainsApi->update: #{e}"
|
339
|
+
end
|
340
|
+
```
|
341
|
+
|
342
|
+
### Parameters
|
343
|
+
|
344
|
+
|
345
|
+
Name | Type | Description | Notes
|
346
|
+
------------- | ------------- | ------------- | -------------
|
347
|
+
**domain_href** | **String**| |
|
348
|
+
**domain** | [**Domain**](Domain.md)| |
|
349
|
+
|
350
|
+
### Return type
|
351
|
+
|
352
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
353
|
+
|
354
|
+
### Authorization
|
355
|
+
|
356
|
+
[basicAuth](../README.md#basicAuth)
|
357
|
+
|
358
|
+
### HTTP request headers
|
359
|
+
|
360
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
361
|
+
- **Accept**: application/json
|
362
|
+
|
@@ -19,7 +19,7 @@ Method | HTTP request | Description
|
|
19
19
|
|
20
20
|
Create a filesystem exporter
|
21
21
|
|
22
|
-
Endpoint for managing FilesystemExporters.
|
22
|
+
Endpoint for managing FilesystemExporters.
|
23
23
|
|
24
24
|
### Example
|
25
25
|
|
@@ -125,7 +125,7 @@ Name | Type | Description | Notes
|
|
125
125
|
|
126
126
|
List filesystem exporters
|
127
127
|
|
128
|
-
Endpoint for managing FilesystemExporters.
|
128
|
+
Endpoint for managing FilesystemExporters.
|
129
129
|
|
130
130
|
### Example
|
131
131
|
|
@@ -253,7 +253,7 @@ Name | Type | Description | Notes
|
|
253
253
|
|
254
254
|
Inspect a filesystem exporter
|
255
255
|
|
256
|
-
Endpoint for managing FilesystemExporters.
|
256
|
+
Endpoint for managing FilesystemExporters.
|
257
257
|
|
258
258
|
### Example
|
259
259
|
|
@@ -72,7 +72,7 @@ Name | Type | Description | Notes
|
|
72
72
|
|
73
73
|
Delete a filesystem export
|
74
74
|
|
75
|
-
Endpoint for managing FilesystemExports.
|
75
|
+
Endpoint for managing FilesystemExports.
|
76
76
|
|
77
77
|
### Example
|
78
78
|
|
@@ -124,7 +124,7 @@ nil (empty response body)
|
|
124
124
|
|
125
125
|
List filesystem exports
|
126
126
|
|
127
|
-
Endpoint for managing FilesystemExports.
|
127
|
+
Endpoint for managing FilesystemExports.
|
128
128
|
|
129
129
|
### Example
|
130
130
|
|
@@ -187,7 +187,7 @@ Name | Type | Description | Notes
|
|
187
187
|
|
188
188
|
Inspect a filesystem export
|
189
189
|
|
190
|
-
Endpoint for managing FilesystemExports.
|
190
|
+
Endpoint for managing FilesystemExports.
|
191
191
|
|
192
192
|
### Example
|
193
193
|
|