pulp_container_client 2.14.14 → 2.14.16

Sign up to get free protection for your applications and to get access to all the features.
Files changed (250) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +222 -246
  3. data/docs/AccessPoliciesApi.md +28 -32
  4. data/docs/ArtifactDistributionResponse.md +7 -7
  5. data/docs/ArtifactsApi.md +23 -27
  6. data/docs/ContainerContainerDistribution.md +5 -5
  7. data/docs/ContainerContainerDistributionResponse.md +8 -8
  8. data/docs/ContainerContainerPushRepository.md +5 -5
  9. data/docs/ContainerContainerPushRepositoryResponse.md +8 -8
  10. data/docs/ContainerContainerRemote.md +1 -1
  11. data/docs/ContainerContainerRemoteResponse.md +1 -1
  12. data/docs/ContainerContainerRepository.md +1 -1
  13. data/docs/ContainerContainerRepositoryResponse.md +1 -1
  14. data/docs/ContentApi.md +8 -14
  15. data/docs/ContentBlobsApi.md +13 -17
  16. data/docs/ContentManifestsApi.md +15 -19
  17. data/docs/ContentSignaturesApi.md +13 -17
  18. data/docs/ContentTagsApi.md +15 -19
  19. data/docs/ContentguardsApi.md +8 -14
  20. data/docs/ContentguardsContentRedirectApi.md +53 -57
  21. data/docs/ContentguardsRbacApi.md +53 -57
  22. data/docs/DistributionsApi.md +8 -18
  23. data/docs/DistributionsArtifactsApi.md +13 -21
  24. data/docs/DistributionsContainerApi.md +53 -61
  25. data/docs/DocsApiJsonApi.md +6 -6
  26. data/docs/DocsApiYamlApi.md +6 -6
  27. data/docs/ExportersFilesystemApi.md +36 -40
  28. data/docs/ExportersFilesystemExportsApi.md +24 -24
  29. data/docs/ExportersPulpApi.md +33 -37
  30. data/docs/ExportersPulpExportsApi.md +21 -21
  31. data/docs/FilesystemExporter.md +1 -1
  32. data/docs/FilesystemExporterResponse.md +1 -1
  33. data/docs/GroupRole.md +1 -3
  34. data/docs/GroupRoleResponse.md +1 -3
  35. data/docs/GroupsApi.md +59 -63
  36. data/docs/GroupsRolesApi.md +27 -33
  37. data/docs/GroupsUsersApi.md +16 -16
  38. data/docs/ImportersPulpApi.md +33 -37
  39. data/docs/ImportersPulpImportCheckApi.md +1 -1
  40. data/docs/ImportersPulpImportsApi.md +21 -21
  41. data/docs/OrphansApi.md +6 -6
  42. data/docs/OrphansCleanupApi.md +6 -6
  43. data/docs/PatchedFilesystemExporter.md +1 -1
  44. data/docs/PatchedcontainerContainerDistribution.md +5 -5
  45. data/docs/PatchedcontainerContainerPushRepository.md +5 -5
  46. data/docs/PatchedcontainerContainerRemote.md +1 -1
  47. data/docs/PatchedcontainerContainerRepository.md +1 -1
  48. data/docs/PublicationsApi.md +9 -15
  49. data/docs/PulpContainerNamespacesApi.md +43 -47
  50. data/docs/RemoteResponse.md +1 -1
  51. data/docs/RemoteResponseHiddenFields.md +2 -2
  52. data/docs/RemotesApi.md +8 -14
  53. data/docs/RemotesContainerApi.md +53 -57
  54. data/docs/RepairApi.md +6 -6
  55. data/docs/RepositoriesApi.md +8 -30
  56. data/docs/RepositoriesContainerApi.md +102 -122
  57. data/docs/RepositoriesContainerPushApi.md +68 -88
  58. data/docs/RepositoriesContainerPushVersionsApi.md +23 -25
  59. data/docs/RepositoriesContainerVersionsApi.md +23 -25
  60. data/docs/RepositoriesReclaimSpaceApi.md +6 -6
  61. data/docs/RepositoryResponse.md +1 -1
  62. data/docs/RepositoryVersionsApi.md +8 -12
  63. data/docs/RolesApi.md +39 -43
  64. data/docs/SigningServicesApi.md +13 -17
  65. data/docs/StatusApi.md +1 -1
  66. data/docs/StatusResponse.md +1 -3
  67. data/docs/TaskGroupsApi.md +11 -11
  68. data/docs/TaskSchedulesApi.md +35 -39
  69. data/docs/TasksApi.md +101 -105
  70. data/docs/TokenApi.md +6 -6
  71. data/docs/UploadsApi.md +53 -57
  72. data/docs/UserRole.md +2 -4
  73. data/docs/UserRoleResponse.md +2 -4
  74. data/docs/UsersApi.md +39 -43
  75. data/docs/UsersRolesApi.md +27 -33
  76. data/docs/VersionResponse.md +1 -3
  77. data/docs/WorkersApi.md +13 -17
  78. data/lib/pulp_container_client/api/access_policies_api.rb +33 -39
  79. data/lib/pulp_container_client/api/artifacts_api.rb +31 -37
  80. data/lib/pulp_container_client/api/content_api.rb +7 -20
  81. data/lib/pulp_container_client/api/content_blobs_api.rb +13 -19
  82. data/lib/pulp_container_client/api/content_manifests_api.rb +15 -21
  83. data/lib/pulp_container_client/api/content_signatures_api.rb +13 -19
  84. data/lib/pulp_container_client/api/content_tags_api.rb +15 -21
  85. data/lib/pulp_container_client/api/contentguards_api.rb +7 -20
  86. data/lib/pulp_container_client/api/contentguards_content_redirect_api.rb +65 -71
  87. data/lib/pulp_container_client/api/contentguards_rbac_api.rb +65 -71
  88. data/lib/pulp_container_client/api/distributions_api.rb +7 -26
  89. data/lib/pulp_container_client/api/distributions_artifacts_api.rb +13 -25
  90. data/lib/pulp_container_client/api/distributions_container_api.rb +65 -77
  91. data/lib/pulp_container_client/api/docs_api_json_api.rb +5 -5
  92. data/lib/pulp_container_client/api/docs_api_yaml_api.rb +5 -5
  93. data/lib/pulp_container_client/api/exporters_filesystem_api.rb +45 -51
  94. data/lib/pulp_container_client/api/exporters_filesystem_exports_api.rb +31 -31
  95. data/lib/pulp_container_client/api/exporters_pulp_api.rb +39 -45
  96. data/lib/pulp_container_client/api/exporters_pulp_exports_api.rb +25 -25
  97. data/lib/pulp_container_client/api/groups_api.rb +77 -83
  98. data/lib/pulp_container_client/api/groups_roles_api.rb +35 -44
  99. data/lib/pulp_container_client/api/groups_users_api.rb +19 -19
  100. data/lib/pulp_container_client/api/importers_pulp_api.rb +39 -45
  101. data/lib/pulp_container_client/api/importers_pulp_imports_api.rb +25 -25
  102. data/lib/pulp_container_client/api/orphans_api.rb +5 -5
  103. data/lib/pulp_container_client/api/orphans_cleanup_api.rb +6 -6
  104. data/lib/pulp_container_client/api/publications_api.rb +9 -18
  105. data/lib/pulp_container_client/api/pulp_container_namespaces_api.rb +51 -57
  106. data/lib/pulp_container_client/api/remotes_api.rb +7 -20
  107. data/lib/pulp_container_client/api/remotes_container_api.rb +65 -71
  108. data/lib/pulp_container_client/api/repair_api.rb +6 -6
  109. data/lib/pulp_container_client/api/repositories_api.rb +7 -44
  110. data/lib/pulp_container_client/api/repositories_container_api.rb +128 -158
  111. data/lib/pulp_container_client/api/repositories_container_push_api.rb +88 -118
  112. data/lib/pulp_container_client/api/repositories_container_push_versions_api.rb +27 -30
  113. data/lib/pulp_container_client/api/repositories_container_versions_api.rb +27 -30
  114. data/lib/pulp_container_client/api/repositories_reclaim_space_api.rb +6 -6
  115. data/lib/pulp_container_client/api/repository_versions_api.rb +7 -12
  116. data/lib/pulp_container_client/api/roles_api.rb +51 -57
  117. data/lib/pulp_container_client/api/signing_services_api.rb +13 -19
  118. data/lib/pulp_container_client/api/task_groups_api.rb +11 -11
  119. data/lib/pulp_container_client/api/task_schedules_api.rb +43 -49
  120. data/lib/pulp_container_client/api/tasks_api.rb +125 -131
  121. data/lib/pulp_container_client/api/token_api.rb +5 -5
  122. data/lib/pulp_container_client/api/uploads_api.rb +67 -73
  123. data/lib/pulp_container_client/api/users_api.rb +51 -57
  124. data/lib/pulp_container_client/api/users_roles_api.rb +35 -44
  125. data/lib/pulp_container_client/api/workers_api.rb +14 -20
  126. data/lib/pulp_container_client/configuration.rb +3 -3
  127. data/lib/pulp_container_client/models/artifact_distribution_response.rb +35 -35
  128. data/lib/pulp_container_client/models/container_container_distribution.rb +45 -45
  129. data/lib/pulp_container_client/models/container_container_distribution_response.rb +39 -39
  130. data/lib/pulp_container_client/models/container_container_push_repository.rb +37 -37
  131. data/lib/pulp_container_client/models/container_container_push_repository_response.rb +33 -33
  132. data/lib/pulp_container_client/models/container_container_remote.rb +21 -21
  133. data/lib/pulp_container_client/models/container_container_remote_response.rb +21 -21
  134. data/lib/pulp_container_client/models/container_container_repository.rb +1 -1
  135. data/lib/pulp_container_client/models/container_container_repository_response.rb +1 -1
  136. data/lib/pulp_container_client/models/filesystem_exporter.rb +1 -1
  137. data/lib/pulp_container_client/models/filesystem_exporter_response.rb +1 -1
  138. data/lib/pulp_container_client/models/group_role.rb +5 -16
  139. data/lib/pulp_container_client/models/group_role_response.rb +4 -15
  140. data/lib/pulp_container_client/models/nested_role.rb +0 -19
  141. data/lib/pulp_container_client/models/patched_filesystem_exporter.rb +1 -1
  142. data/lib/pulp_container_client/models/patchedcontainer_container_distribution.rb +36 -36
  143. data/lib/pulp_container_client/models/patchedcontainer_container_push_repository.rb +37 -37
  144. data/lib/pulp_container_client/models/patchedcontainer_container_remote.rb +21 -21
  145. data/lib/pulp_container_client/models/patchedcontainer_container_repository.rb +1 -1
  146. data/lib/pulp_container_client/models/remote_response.rb +21 -21
  147. data/lib/pulp_container_client/models/remote_response_hidden_fields.rb +10 -0
  148. data/lib/pulp_container_client/models/repository_response.rb +1 -1
  149. data/lib/pulp_container_client/models/status_response.rb +4 -19
  150. data/lib/pulp_container_client/models/user_role.rb +6 -17
  151. data/lib/pulp_container_client/models/user_role_response.rb +5 -16
  152. data/lib/pulp_container_client/models/version_response.rb +4 -19
  153. data/lib/pulp_container_client/version.rb +1 -1
  154. data/lib/pulp_container_client.rb +0 -11
  155. data/spec/api/access_policies_api_spec.rb +11 -13
  156. data/spec/api/artifacts_api_spec.rb +9 -11
  157. data/spec/api/content_api_spec.rb +3 -6
  158. data/spec/api/content_blobs_api_spec.rb +5 -7
  159. data/spec/api/content_manifests_api_spec.rb +6 -8
  160. data/spec/api/content_signatures_api_spec.rb +5 -7
  161. data/spec/api/content_tags_api_spec.rb +6 -8
  162. data/spec/api/contentguards_api_spec.rb +3 -6
  163. data/spec/api/contentguards_content_redirect_api_spec.rb +21 -23
  164. data/spec/api/contentguards_rbac_api_spec.rb +21 -23
  165. data/spec/api/distributions_api_spec.rb +3 -8
  166. data/spec/api/distributions_artifacts_api_spec.rb +5 -9
  167. data/spec/api/distributions_container_api_spec.rb +21 -25
  168. data/spec/api/docs_api_json_api_spec.rb +2 -2
  169. data/spec/api/docs_api_yaml_api_spec.rb +2 -2
  170. data/spec/api/exporters_filesystem_api_spec.rb +16 -18
  171. data/spec/api/exporters_filesystem_exports_api_spec.rb +11 -11
  172. data/spec/api/exporters_pulp_api_spec.rb +13 -15
  173. data/spec/api/exporters_pulp_exports_api_spec.rb +8 -8
  174. data/spec/api/groups_api_spec.rb +27 -29
  175. data/spec/api/groups_roles_api_spec.rb +13 -16
  176. data/spec/api/groups_users_api_spec.rb +6 -6
  177. data/spec/api/importers_pulp_api_spec.rb +13 -15
  178. data/spec/api/importers_pulp_imports_api_spec.rb +8 -8
  179. data/spec/api/orphans_api_spec.rb +2 -2
  180. data/spec/api/orphans_cleanup_api_spec.rb +2 -2
  181. data/spec/api/publications_api_spec.rb +4 -7
  182. data/spec/api/pulp_container_namespaces_api_spec.rb +17 -19
  183. data/spec/api/remotes_api_spec.rb +3 -6
  184. data/spec/api/remotes_container_api_spec.rb +21 -23
  185. data/spec/api/repair_api_spec.rb +2 -2
  186. data/spec/api/repositories_api_spec.rb +3 -14
  187. data/spec/api/repositories_container_api_spec.rb +39 -49
  188. data/spec/api/repositories_container_push_api_spec.rb +27 -37
  189. data/spec/api/repositories_container_push_versions_api_spec.rb +9 -10
  190. data/spec/api/repositories_container_versions_api_spec.rb +9 -10
  191. data/spec/api/repositories_reclaim_space_api_spec.rb +2 -2
  192. data/spec/api/repository_versions_api_spec.rb +3 -5
  193. data/spec/api/roles_api_spec.rb +19 -21
  194. data/spec/api/signing_services_api_spec.rb +5 -7
  195. data/spec/api/task_groups_api_spec.rb +4 -4
  196. data/spec/api/task_schedules_api_spec.rb +15 -17
  197. data/spec/api/tasks_api_spec.rb +32 -34
  198. data/spec/api/token_api_spec.rb +2 -2
  199. data/spec/api/uploads_api_spec.rb +21 -23
  200. data/spec/api/users_api_spec.rb +19 -21
  201. data/spec/api/users_roles_api_spec.rb +13 -16
  202. data/spec/api/workers_api_spec.rb +5 -7
  203. data/spec/configuration_spec.rb +3 -3
  204. data/spec/models/artifact_distribution_response_spec.rb +7 -7
  205. data/spec/models/container_container_distribution_response_spec.rb +6 -6
  206. data/spec/models/container_container_distribution_spec.rb +4 -4
  207. data/spec/models/container_container_push_repository_response_spec.rb +6 -6
  208. data/spec/models/container_container_push_repository_spec.rb +4 -4
  209. data/spec/models/group_role_response_spec.rb +0 -6
  210. data/spec/models/group_role_spec.rb +0 -6
  211. data/spec/models/patchedcontainer_container_distribution_spec.rb +4 -4
  212. data/spec/models/patchedcontainer_container_push_repository_spec.rb +4 -4
  213. data/spec/models/status_response_spec.rb +0 -6
  214. data/spec/models/user_role_response_spec.rb +0 -6
  215. data/spec/models/user_role_spec.rb +0 -6
  216. data/spec/models/version_response_spec.rb +0 -6
  217. metadata +196 -240
  218. data/docs/Domain.md +0 -27
  219. data/docs/DomainResponse.md +0 -31
  220. data/docs/DomainsApi.md +0 -366
  221. data/docs/PaginatedDomainResponseList.md +0 -23
  222. data/docs/PaginatedUpstreamPulpResponseList.md +0 -23
  223. data/docs/PatchedDomain.md +0 -27
  224. data/docs/PatchedUpstreamPulp.md +0 -37
  225. data/docs/StorageClassEnum.md +0 -16
  226. data/docs/UpstreamPulp.md +0 -37
  227. data/docs/UpstreamPulpResponse.md +0 -39
  228. data/docs/UpstreamPulpsApi.md +0 -405
  229. data/lib/pulp_container_client/api/domains_api.rb +0 -452
  230. data/lib/pulp_container_client/api/upstream_pulps_api.rb +0 -492
  231. data/lib/pulp_container_client/models/domain.rb +0 -323
  232. data/lib/pulp_container_client/models/domain_response.rb +0 -318
  233. data/lib/pulp_container_client/models/paginated_domain_response_list.rb +0 -237
  234. data/lib/pulp_container_client/models/paginated_upstream_pulp_response_list.rb +0 -237
  235. data/lib/pulp_container_client/models/patched_domain.rb +0 -304
  236. data/lib/pulp_container_client/models/patched_upstream_pulp.rb +0 -450
  237. data/lib/pulp_container_client/models/storage_class_enum.rb +0 -37
  238. data/lib/pulp_container_client/models/upstream_pulp.rb +0 -477
  239. data/lib/pulp_container_client/models/upstream_pulp_response.rb +0 -338
  240. data/spec/api/domains_api_spec.rb +0 -122
  241. data/spec/api/upstream_pulps_api_spec.rb +0 -127
  242. data/spec/models/domain_response_spec.rb +0 -83
  243. data/spec/models/domain_spec.rb +0 -71
  244. data/spec/models/paginated_domain_response_list_spec.rb +0 -59
  245. data/spec/models/paginated_upstream_pulp_response_list_spec.rb +0 -59
  246. data/spec/models/patched_domain_spec.rb +0 -71
  247. data/spec/models/patched_upstream_pulp_spec.rb +0 -101
  248. data/spec/models/storage_class_enum_spec.rb +0 -35
  249. data/spec/models/upstream_pulp_response_spec.rb +0 -107
  250. data/spec/models/upstream_pulp_spec.rb +0 -101
data/docs/Domain.md DELETED
@@ -1,27 +0,0 @@
1
- # PulpContainerClient::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. * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage |
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 'PulpContainerClient'
18
-
19
- instance = PulpContainerClient::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
-
@@ -1,31 +0,0 @@
1
- # PulpContainerClient::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. * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage |
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 'PulpContainerClient'
20
-
21
- instance = PulpContainerClient::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 DELETED
@@ -1,366 +0,0 @@
1
- # PulpContainerClient::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 'pulp_container_client'
29
- # setup authorization
30
- PulpContainerClient.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 = PulpContainerClient::DomainsApi.new
37
- domain = PulpContainerClient::Domain.new # Domain |
38
-
39
- begin
40
- #Create a domain
41
- result = api_instance.create(domain)
42
- p result
43
- rescue PulpContainerClient::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 'pulp_container_client'
82
- # setup authorization
83
- PulpContainerClient.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 = PulpContainerClient::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 PulpContainerClient::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 'pulp_container_client'
135
- # setup authorization
136
- PulpContainerClient.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 = PulpContainerClient::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 * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `storage_class` - Storage class * `-storage_class` - Storage class (descending) * `storage_settings` - Storage settings * `-storage_settings` - Storage settings (descending) * `redirect_to_object_storage` - Redirect to object storage * `-redirect_to_object_storage` - Redirect to object storage (descending) * `hide_guarded_distributions` - Hide guarded distributions * `-hide_guarded_distributions` - Hide guarded distributions (descending) * `pk` - Pk * `-pk` - Pk (descending)
152
- pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
153
- pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
154
- fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
155
- exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
156
- }
157
-
158
- begin
159
- #List domains
160
- result = api_instance.list(opts)
161
- p result
162
- rescue PulpContainerClient::ApiError => e
163
- puts "Exception when calling DomainsApi->list: #{e}"
164
- end
165
- ```
166
-
167
- ### Parameters
168
-
169
-
170
- Name | Type | Description | Notes
171
- ------------- | ------------- | ------------- | -------------
172
- **limit** | **Integer**| Number of results to return per page. | [optional]
173
- **name** | **String**| Filter results where name matches value | [optional]
174
- **name__contains** | **String**| Filter results where name contains value | [optional]
175
- **name__icontains** | **String**| Filter results where name contains value | [optional]
176
- **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
177
- **name__startswith** | **String**| Filter results where name starts with value | [optional]
178
- **offset** | **Integer**| The initial index from which to return the results. | [optional]
179
- **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;storage_class&#x60; - Storage class * &#x60;-storage_class&#x60; - Storage class (descending) * &#x60;storage_settings&#x60; - Storage settings * &#x60;-storage_settings&#x60; - Storage settings (descending) * &#x60;redirect_to_object_storage&#x60; - Redirect to object storage * &#x60;-redirect_to_object_storage&#x60; - Redirect to object storage (descending) * &#x60;hide_guarded_distributions&#x60; - Hide guarded distributions * &#x60;-hide_guarded_distributions&#x60; - Hide guarded distributions (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional]
180
- **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional]
181
- **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional]
182
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
183
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
184
-
185
- ### Return type
186
-
187
- [**PaginatedDomainResponseList**](PaginatedDomainResponseList.md)
188
-
189
- ### Authorization
190
-
191
- [basicAuth](../README.md#basicAuth)
192
-
193
- ### HTTP request headers
194
-
195
- - **Content-Type**: Not defined
196
- - **Accept**: application/json
197
-
198
-
199
- ## partial_update
200
-
201
- > AsyncOperationResponse partial_update(domain_href, patched_domain)
202
-
203
- Update a domain
204
-
205
- Trigger an asynchronous partial update task
206
-
207
- ### Example
208
-
209
- ```ruby
210
- # load the gem
211
- require 'pulp_container_client'
212
- # setup authorization
213
- PulpContainerClient.configure do |config|
214
- # Configure HTTP basic authorization: basicAuth
215
- config.username = 'YOUR USERNAME'
216
- config.password = 'YOUR PASSWORD'
217
- end
218
-
219
- api_instance = PulpContainerClient::DomainsApi.new
220
- domain_href = 'domain_href_example' # String |
221
- patched_domain = PulpContainerClient::PatchedDomain.new # PatchedDomain |
222
-
223
- begin
224
- #Update a domain
225
- result = api_instance.partial_update(domain_href, patched_domain)
226
- p result
227
- rescue PulpContainerClient::ApiError => e
228
- puts "Exception when calling DomainsApi->partial_update: #{e}"
229
- end
230
- ```
231
-
232
- ### Parameters
233
-
234
-
235
- Name | Type | Description | Notes
236
- ------------- | ------------- | ------------- | -------------
237
- **domain_href** | **String**| |
238
- **patched_domain** | [**PatchedDomain**](PatchedDomain.md)| |
239
-
240
- ### Return type
241
-
242
- [**AsyncOperationResponse**](AsyncOperationResponse.md)
243
-
244
- ### Authorization
245
-
246
- [basicAuth](../README.md#basicAuth)
247
-
248
- ### HTTP request headers
249
-
250
- - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
251
- - **Accept**: application/json
252
-
253
-
254
- ## read
255
-
256
- > DomainResponse read(domain_href, opts)
257
-
258
- Inspect a domain
259
-
260
- ViewSet for Domain. NOTE: This API endpoint is in \"tech preview\" and subject to change
261
-
262
- ### Example
263
-
264
- ```ruby
265
- # load the gem
266
- require 'pulp_container_client'
267
- # setup authorization
268
- PulpContainerClient.configure do |config|
269
- # Configure HTTP basic authorization: basicAuth
270
- config.username = 'YOUR USERNAME'
271
- config.password = 'YOUR PASSWORD'
272
- end
273
-
274
- api_instance = PulpContainerClient::DomainsApi.new
275
- domain_href = 'domain_href_example' # String |
276
- opts = {
277
- fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
278
- exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
279
- }
280
-
281
- begin
282
- #Inspect a domain
283
- result = api_instance.read(domain_href, opts)
284
- p result
285
- rescue PulpContainerClient::ApiError => e
286
- puts "Exception when calling DomainsApi->read: #{e}"
287
- end
288
- ```
289
-
290
- ### Parameters
291
-
292
-
293
- Name | Type | Description | Notes
294
- ------------- | ------------- | ------------- | -------------
295
- **domain_href** | **String**| |
296
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
297
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
298
-
299
- ### Return type
300
-
301
- [**DomainResponse**](DomainResponse.md)
302
-
303
- ### Authorization
304
-
305
- [basicAuth](../README.md#basicAuth)
306
-
307
- ### HTTP request headers
308
-
309
- - **Content-Type**: Not defined
310
- - **Accept**: application/json
311
-
312
-
313
- ## update
314
-
315
- > AsyncOperationResponse update(domain_href, domain)
316
-
317
- Update a domain
318
-
319
- Trigger an asynchronous update task
320
-
321
- ### Example
322
-
323
- ```ruby
324
- # load the gem
325
- require 'pulp_container_client'
326
- # setup authorization
327
- PulpContainerClient.configure do |config|
328
- # Configure HTTP basic authorization: basicAuth
329
- config.username = 'YOUR USERNAME'
330
- config.password = 'YOUR PASSWORD'
331
- end
332
-
333
- api_instance = PulpContainerClient::DomainsApi.new
334
- domain_href = 'domain_href_example' # String |
335
- domain = PulpContainerClient::Domain.new # Domain |
336
-
337
- begin
338
- #Update a domain
339
- result = api_instance.update(domain_href, domain)
340
- p result
341
- rescue PulpContainerClient::ApiError => e
342
- puts "Exception when calling DomainsApi->update: #{e}"
343
- end
344
- ```
345
-
346
- ### Parameters
347
-
348
-
349
- Name | Type | Description | Notes
350
- ------------- | ------------- | ------------- | -------------
351
- **domain_href** | **String**| |
352
- **domain** | [**Domain**](Domain.md)| |
353
-
354
- ### Return type
355
-
356
- [**AsyncOperationResponse**](AsyncOperationResponse.md)
357
-
358
- ### Authorization
359
-
360
- [basicAuth](../README.md#basicAuth)
361
-
362
- ### HTTP request headers
363
-
364
- - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
365
- - **Accept**: application/json
366
-
@@ -1,23 +0,0 @@
1
- # PulpContainerClient::PaginatedDomainResponseList
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **count** | **Integer** | | [optional]
8
- **_next** | **String** | | [optional]
9
- **previous** | **String** | | [optional]
10
- **results** | [**Array&lt;DomainResponse&gt;**](DomainResponse.md) | | [optional]
11
-
12
- ## Code Sample
13
-
14
- ```ruby
15
- require 'PulpContainerClient'
16
-
17
- instance = PulpContainerClient::PaginatedDomainResponseList.new(count: 123,
18
- _next: http://api.example.org/accounts/?offset&#x3D;400&amp;limit&#x3D;100,
19
- previous: http://api.example.org/accounts/?offset&#x3D;200&amp;limit&#x3D;100,
20
- results: null)
21
- ```
22
-
23
-
@@ -1,23 +0,0 @@
1
- # PulpContainerClient::PaginatedUpstreamPulpResponseList
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **count** | **Integer** | | [optional]
8
- **_next** | **String** | | [optional]
9
- **previous** | **String** | | [optional]
10
- **results** | [**Array&lt;UpstreamPulpResponse&gt;**](UpstreamPulpResponse.md) | | [optional]
11
-
12
- ## Code Sample
13
-
14
- ```ruby
15
- require 'PulpContainerClient'
16
-
17
- instance = PulpContainerClient::PaginatedUpstreamPulpResponseList.new(count: 123,
18
- _next: http://api.example.org/accounts/?offset&#x3D;400&amp;limit&#x3D;100,
19
- previous: http://api.example.org/accounts/?offset&#x3D;200&amp;limit&#x3D;100,
20
- results: null)
21
- ```
22
-
23
-
@@ -1,27 +0,0 @@
1
- # PulpContainerClient::PatchedDomain
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **name** | **String** | A name for this domain. | [optional]
8
- **description** | **String** | An optional description. | [optional]
9
- **storage_class** | [**StorageClassEnum**](StorageClassEnum.md) | Backend storage class for domain. * &#x60;pulpcore.app.models.storage.FileSystem&#x60; - Use local filesystem as storage * &#x60;storages.backends.s3boto3.S3Boto3Storage&#x60; - Use Amazon S3 as storage * &#x60;storages.backends.azure_storage.AzureStorage&#x60; - Use Azure Blob as storage | [optional]
10
- **storage_settings** | [**Object**](.md) | Settings for storage class. | [optional]
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 'PulpContainerClient'
18
-
19
- instance = PulpContainerClient::PatchedDomain.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
-
@@ -1,37 +0,0 @@
1
- # PulpContainerClient::PatchedUpstreamPulp
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **name** | **String** | A unique name for this Pulp server. | [optional]
8
- **base_url** | **String** | The transport, hostname, and an optional port of the Pulp server. e.g. https://example.com | [optional]
9
- **api_root** | **String** | The API root. Defaults to &#39;/pulp/&#39;. | [optional]
10
- **domain** | **String** | The domain of the Pulp server if enabled. | [optional]
11
- **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
12
- **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional]
13
- **client_key** | **String** | A PEM encoded private key used for authentication. | [optional]
14
- **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional]
15
- **username** | **String** | The username to be used for authentication when syncing. | [optional]
16
- **password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional]
17
- **pulp_label_select** | **String** | One or more comma separated labels that will be used to filter distributions on the upstream Pulp. E.g. \&quot;foo&#x3D;bar,key&#x3D;val\&quot; or \&quot;foo,key\&quot; | [optional]
18
-
19
- ## Code Sample
20
-
21
- ```ruby
22
- require 'PulpContainerClient'
23
-
24
- instance = PulpContainerClient::PatchedUpstreamPulp.new(name: null,
25
- base_url: null,
26
- api_root: null,
27
- domain: null,
28
- ca_cert: null,
29
- client_cert: null,
30
- client_key: null,
31
- tls_validation: null,
32
- username: null,
33
- password: null,
34
- pulp_label_select: null)
35
- ```
36
-
37
-
@@ -1,16 +0,0 @@
1
- # PulpContainerClient::StorageClassEnum
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
-
8
- ## Code Sample
9
-
10
- ```ruby
11
- require 'PulpContainerClient'
12
-
13
- instance = PulpContainerClient::StorageClassEnum.new()
14
- ```
15
-
16
-
data/docs/UpstreamPulp.md DELETED
@@ -1,37 +0,0 @@
1
- # PulpContainerClient::UpstreamPulp
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **name** | **String** | A unique name for this Pulp server. |
8
- **base_url** | **String** | The transport, hostname, and an optional port of the Pulp server. e.g. https://example.com |
9
- **api_root** | **String** | The API root. Defaults to &#39;/pulp/&#39;. |
10
- **domain** | **String** | The domain of the Pulp server if enabled. | [optional]
11
- **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
12
- **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional]
13
- **client_key** | **String** | A PEM encoded private key used for authentication. | [optional]
14
- **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional]
15
- **username** | **String** | The username to be used for authentication when syncing. | [optional]
16
- **password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional]
17
- **pulp_label_select** | **String** | One or more comma separated labels that will be used to filter distributions on the upstream Pulp. E.g. \&quot;foo&#x3D;bar,key&#x3D;val\&quot; or \&quot;foo,key\&quot; | [optional]
18
-
19
- ## Code Sample
20
-
21
- ```ruby
22
- require 'PulpContainerClient'
23
-
24
- instance = PulpContainerClient::UpstreamPulp.new(name: null,
25
- base_url: null,
26
- api_root: null,
27
- domain: null,
28
- ca_cert: null,
29
- client_cert: null,
30
- client_key: null,
31
- tls_validation: null,
32
- username: null,
33
- password: null,
34
- pulp_label_select: null)
35
- ```
36
-
37
-
@@ -1,39 +0,0 @@
1
- # PulpContainerClient::UpstreamPulpResponse
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 unique name for this Pulp server. |
10
- **base_url** | **String** | The transport, hostname, and an optional port of the Pulp server. e.g. https://example.com |
11
- **api_root** | **String** | The API root. Defaults to &#39;/pulp/&#39;. |
12
- **domain** | **String** | The domain of the Pulp server if enabled. | [optional]
13
- **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
14
- **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional]
15
- **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional]
16
- **pulp_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional] [readonly]
17
- **hidden_fields** | [**Array&lt;RemoteResponseHiddenFields&gt;**](RemoteResponseHiddenFields.md) | List of hidden (write only) fields | [optional] [readonly]
18
- **pulp_label_select** | **String** | One or more comma separated labels that will be used to filter distributions on the upstream Pulp. E.g. \&quot;foo&#x3D;bar,key&#x3D;val\&quot; or \&quot;foo,key\&quot; | [optional]
19
-
20
- ## Code Sample
21
-
22
- ```ruby
23
- require 'PulpContainerClient'
24
-
25
- instance = PulpContainerClient::UpstreamPulpResponse.new(pulp_href: null,
26
- pulp_created: null,
27
- name: null,
28
- base_url: null,
29
- api_root: null,
30
- domain: null,
31
- ca_cert: null,
32
- client_cert: null,
33
- tls_validation: null,
34
- pulp_last_updated: null,
35
- hidden_fields: null,
36
- pulp_label_select: null)
37
- ```
38
-
39
-