pulp_container_client 2.22.2 → 2.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +17 -14
- data/docs/AsyncOperationResponse.md +8 -7
- data/docs/ContainerBlobResponse.md +18 -17
- data/docs/ContainerContainerDistribution.md +24 -23
- data/docs/ContainerContainerDistributionResponse.md +40 -39
- data/docs/ContainerContainerNamespace.md +8 -7
- data/docs/ContainerContainerNamespaceResponse.md +16 -15
- data/docs/ContainerContainerPullThroughDistribution.md +26 -25
- data/docs/ContainerContainerPullThroughDistributionResponse.md +38 -37
- data/docs/ContainerContainerPullThroughRemote.md +52 -51
- data/docs/ContainerContainerPullThroughRemoteResponse.md +52 -51
- data/docs/ContainerContainerPullThroughRemoteResponseHiddenFieldsInner.md +20 -0
- data/docs/ContainerContainerPushRepository.md +16 -15
- data/docs/ContainerContainerPushRepositoryResponse.md +28 -27
- data/docs/ContainerContainerRemote.md +56 -55
- data/docs/ContainerContainerRemoteResponse.md +56 -55
- data/docs/ContainerContainerRepository.md +18 -17
- data/docs/ContainerContainerRepositoryResponse.md +30 -29
- data/docs/ContainerManifestResponse.md +42 -41
- data/docs/ContainerManifestSignatureResponse.md +28 -27
- data/docs/ContainerRepositorySyncURL.md +12 -11
- data/docs/ContainerTagResponse.md +18 -17
- data/docs/ContentBlobsApi.md +82 -49
- data/docs/ContentManifestsApi.md +86 -53
- data/docs/ContentSignaturesApi.md +97 -64
- data/docs/ContentSummaryResponse.md +12 -11
- data/docs/ContentTagsApi.md +86 -53
- data/docs/DistributionsContainerApi.md +386 -183
- data/docs/DistributionsPullThroughApi.md +385 -182
- data/docs/ManifestCopy.md +14 -13
- data/docs/MediaTypesEnum.md +4 -5
- data/docs/MyPermissionsResponse.md +8 -7
- data/docs/NestedRole.md +12 -11
- data/docs/NestedRoleResponse.md +12 -11
- data/docs/ObjectRolesResponse.md +8 -7
- data/docs/PaginatedRepositoryVersionResponseList.md +14 -13
- data/docs/PaginatedcontainerBlobResponseList.md +14 -13
- data/docs/PaginatedcontainerContainerDistributionResponseList.md +14 -13
- data/docs/PaginatedcontainerContainerNamespaceResponseList.md +14 -13
- data/docs/PaginatedcontainerContainerPullThroughDistributionResponseList.md +14 -13
- data/docs/PaginatedcontainerContainerPullThroughRemoteResponseList.md +14 -13
- data/docs/PaginatedcontainerContainerPushRepositoryResponseList.md +14 -13
- data/docs/PaginatedcontainerContainerRemoteResponseList.md +14 -13
- data/docs/PaginatedcontainerContainerRepositoryResponseList.md +14 -13
- data/docs/PaginatedcontainerManifestResponseList.md +14 -13
- data/docs/PaginatedcontainerManifestSignatureResponseList.md +14 -13
- data/docs/PaginatedcontainerTagResponseList.md +14 -13
- data/docs/PatchedcontainerContainerDistribution.md +24 -23
- data/docs/PatchedcontainerContainerPullThroughDistribution.md +26 -25
- data/docs/PatchedcontainerContainerPullThroughRemote.md +52 -51
- data/docs/PatchedcontainerContainerPushRepository.md +16 -15
- data/docs/PatchedcontainerContainerRemote.md +56 -55
- data/docs/PatchedcontainerContainerRepository.md +18 -17
- data/docs/Policy692Enum.md +4 -5
- data/docs/Policy7e0Enum.md +4 -5
- data/docs/PulpContainerNamespacesApi.md +259 -124
- data/docs/RecursiveManage.md +8 -7
- data/docs/RemotesContainerApi.md +389 -184
- data/docs/RemotesPullThroughApi.md +389 -184
- data/docs/RemoveImage.md +8 -7
- data/docs/RemoveSignatures.md +8 -7
- data/docs/RemoveSignaturesResponse.md +8 -7
- data/docs/Repair.md +8 -7
- data/docs/RepositoriesContainerApi.md +647 -291
- data/docs/RepositoriesContainerPushApi.md +419 -198
- data/docs/RepositoriesContainerPushVersionsApi.md +152 -82
- data/docs/RepositoriesContainerVersionsApi.md +152 -82
- data/docs/RepositorySign.md +12 -11
- data/docs/RepositoryVersionResponse.md +22 -21
- data/docs/SetLabel.md +10 -9
- data/docs/SetLabelResponse.md +10 -9
- data/docs/TagCopy.md +12 -11
- data/docs/TagImage.md +10 -9
- data/docs/TokenApi.md +25 -7
- data/docs/UnTagImage.md +8 -7
- data/docs/UnsetLabel.md +8 -7
- data/docs/UnsetLabelResponse.md +10 -9
- data/lib/pulp_container_client/api/content_blobs_api.rb +11 -9
- data/lib/pulp_container_client/api/content_manifests_api.rb +11 -9
- data/lib/pulp_container_client/api/content_signatures_api.rb +11 -9
- data/lib/pulp_container_client/api/content_tags_api.rb +11 -9
- data/lib/pulp_container_client/api/distributions_container_api.rb +89 -56
- data/lib/pulp_container_client/api/distributions_pull_through_api.rb +89 -56
- data/lib/pulp_container_client/api/pulp_container_namespaces_api.rb +53 -36
- data/lib/pulp_container_client/api/remotes_container_api.rb +104 -68
- data/lib/pulp_container_client/api/remotes_pull_through_api.rb +104 -68
- data/lib/pulp_container_client/api/repositories_container_api.rb +171 -102
- data/lib/pulp_container_client/api/repositories_container_push_api.rb +102 -62
- data/lib/pulp_container_client/api/repositories_container_push_versions_api.rb +40 -30
- data/lib/pulp_container_client/api/repositories_container_versions_api.rb +40 -30
- data/lib/pulp_container_client/api/token_api.rb +5 -4
- data/lib/pulp_container_client/api_client.rb +137 -102
- data/lib/pulp_container_client/api_error.rb +2 -1
- data/lib/pulp_container_client/configuration.rb +162 -21
- data/lib/pulp_container_client/models/async_operation_response.rb +32 -22
- data/lib/pulp_container_client/models/container_blob_response.rb +37 -29
- data/lib/pulp_container_client/models/container_container_distribution.rb +66 -54
- data/lib/pulp_container_client/models/container_container_distribution_response.rb +95 -83
- data/lib/pulp_container_client/models/container_container_namespace.rb +32 -22
- data/lib/pulp_container_client/models/container_container_namespace_response.rb +34 -24
- data/lib/pulp_container_client/models/container_container_pull_through_distribution.rb +68 -54
- data/lib/pulp_container_client/models/container_container_pull_through_distribution_response.rb +97 -83
- data/lib/pulp_container_client/models/container_container_pull_through_remote.rb +56 -22
- data/lib/pulp_container_client/models/container_container_pull_through_remote_response.rb +59 -25
- data/lib/pulp_container_client/models/{container_container_pull_through_remote_response_hidden_fields.rb → container_container_pull_through_remote_response_hidden_fields_inner.rb} +37 -25
- data/lib/pulp_container_client/models/container_container_push_repository.rb +73 -63
- data/lib/pulp_container_client/models/container_container_push_repository_response.rb +88 -78
- data/lib/pulp_container_client/models/container_container_remote.rb +63 -23
- data/lib/pulp_container_client/models/container_container_remote_response.rb +61 -25
- data/lib/pulp_container_client/models/container_container_repository.rb +32 -22
- data/lib/pulp_container_client/models/container_container_repository_response.rb +34 -24
- data/lib/pulp_container_client/models/container_manifest_response.rb +42 -24
- data/lib/pulp_container_client/models/container_manifest_signature_response.rb +46 -24
- data/lib/pulp_container_client/models/container_repository_sync_url.rb +30 -22
- data/lib/pulp_container_client/models/container_tag_response.rb +36 -24
- data/lib/pulp_container_client/models/content_summary_response.rb +36 -22
- data/lib/pulp_container_client/models/manifest_copy.rb +31 -23
- data/lib/pulp_container_client/models/media_types_enum.rb +8 -4
- data/lib/pulp_container_client/models/my_permissions_response.rb +32 -22
- data/lib/pulp_container_client/models/nested_role.rb +32 -22
- data/lib/pulp_container_client/models/nested_role_response.rb +32 -22
- data/lib/pulp_container_client/models/object_roles_response.rb +32 -22
- data/lib/pulp_container_client/models/paginated_repository_version_response_list.rb +34 -22
- data/lib/pulp_container_client/models/paginatedcontainer_blob_response_list.rb +34 -22
- data/lib/pulp_container_client/models/paginatedcontainer_container_distribution_response_list.rb +34 -22
- data/lib/pulp_container_client/models/paginatedcontainer_container_namespace_response_list.rb +34 -22
- data/lib/pulp_container_client/models/paginatedcontainer_container_pull_through_distribution_response_list.rb +34 -22
- data/lib/pulp_container_client/models/paginatedcontainer_container_pull_through_remote_response_list.rb +34 -22
- data/lib/pulp_container_client/models/paginatedcontainer_container_push_repository_response_list.rb +34 -22
- data/lib/pulp_container_client/models/paginatedcontainer_container_remote_response_list.rb +34 -22
- data/lib/pulp_container_client/models/paginatedcontainer_container_repository_response_list.rb +34 -22
- data/lib/pulp_container_client/models/paginatedcontainer_manifest_response_list.rb +34 -22
- data/lib/pulp_container_client/models/paginatedcontainer_manifest_signature_response_list.rb +34 -22
- data/lib/pulp_container_client/models/paginatedcontainer_tag_response_list.rb +34 -22
- data/lib/pulp_container_client/models/patchedcontainer_container_distribution.rb +72 -56
- data/lib/pulp_container_client/models/patchedcontainer_container_pull_through_distribution.rb +72 -56
- data/lib/pulp_container_client/models/patchedcontainer_container_pull_through_remote.rb +62 -24
- data/lib/pulp_container_client/models/patchedcontainer_container_push_repository.rb +76 -64
- data/lib/pulp_container_client/models/patchedcontainer_container_remote.rb +72 -26
- data/lib/pulp_container_client/models/patchedcontainer_container_repository.rb +35 -23
- data/lib/pulp_container_client/models/policy692_enum.rb +8 -4
- data/lib/pulp_container_client/models/policy7e0_enum.rb +8 -4
- data/lib/pulp_container_client/models/recursive_manage.rb +31 -23
- data/lib/pulp_container_client/models/remove_image.rb +32 -22
- data/lib/pulp_container_client/models/remove_signatures.rb +32 -22
- data/lib/pulp_container_client/models/remove_signatures_response.rb +32 -22
- data/lib/pulp_container_client/models/repair.rb +30 -22
- data/lib/pulp_container_client/models/repository_sign.rb +36 -24
- data/lib/pulp_container_client/models/repository_version_response.rb +32 -24
- data/lib/pulp_container_client/models/set_label.rb +34 -22
- data/lib/pulp_container_client/models/set_label_response.rb +34 -22
- data/lib/pulp_container_client/models/tag_copy.rb +31 -23
- data/lib/pulp_container_client/models/tag_image.rb +34 -22
- data/lib/pulp_container_client/models/un_tag_image.rb +32 -22
- data/lib/pulp_container_client/models/unset_label.rb +32 -22
- data/lib/pulp_container_client/models/unset_label_response.rb +32 -22
- data/lib/pulp_container_client/version.rb +2 -2
- data/lib/pulp_container_client.rb +2 -3
- data/pulp_container_client.gemspec +9 -6
- data/spec/api/content_blobs_api_spec.rb +3 -3
- data/spec/api/content_manifests_api_spec.rb +3 -3
- data/spec/api/content_signatures_api_spec.rb +3 -3
- data/spec/api/content_tags_api_spec.rb +3 -3
- data/spec/api/distributions_container_api_spec.rb +13 -13
- data/spec/api/distributions_pull_through_api_spec.rb +13 -13
- data/spec/api/pulp_container_namespaces_api_spec.rb +9 -9
- data/spec/api/remotes_container_api_spec.rb +20 -19
- data/spec/api/remotes_pull_through_api_spec.rb +20 -19
- data/spec/api/repositories_container_api_spec.rb +22 -22
- data/spec/api/repositories_container_push_api_spec.rb +14 -14
- data/spec/api/repositories_container_push_versions_api_spec.rb +12 -11
- data/spec/api/repositories_container_versions_api_spec.rb +12 -11
- data/spec/api/token_api_spec.rb +2 -2
- data/spec/models/async_operation_response_spec.rb +7 -12
- data/spec/models/container_blob_response_spec.rb +12 -17
- data/spec/models/container_container_distribution_response_spec.rb +34 -39
- data/spec/models/container_container_distribution_spec.rb +20 -25
- data/spec/models/container_container_namespace_response_spec.rb +11 -16
- data/spec/models/container_container_namespace_spec.rb +7 -12
- data/spec/models/container_container_pull_through_distribution_response_spec.rb +33 -38
- data/spec/models/container_container_pull_through_distribution_spec.rb +21 -26
- data/spec/models/{container_container_pull_through_remote_response_hidden_fields_spec.rb → container_container_pull_through_remote_response_hidden_fields_inner_spec.rb} +11 -16
- data/spec/models/container_container_pull_through_remote_response_spec.rb +29 -34
- data/spec/models/container_container_pull_through_remote_spec.rb +29 -34
- data/spec/models/container_container_push_repository_response_spec.rb +27 -32
- data/spec/models/container_container_push_repository_spec.rb +16 -21
- data/spec/models/container_container_remote_response_spec.rb +31 -36
- data/spec/models/container_container_remote_spec.rb +31 -36
- data/spec/models/container_container_repository_response_spec.rb +18 -23
- data/spec/models/container_container_repository_spec.rb +12 -17
- data/spec/models/container_manifest_response_spec.rb +24 -29
- data/spec/models/container_manifest_signature_response_spec.rb +17 -22
- data/spec/models/container_repository_sync_url_spec.rb +9 -14
- data/spec/models/container_tag_response_spec.rb +12 -17
- data/spec/models/content_summary_response_spec.rb +9 -14
- data/spec/models/manifest_copy_spec.rb +10 -15
- data/spec/models/media_types_enum_spec.rb +6 -11
- data/spec/models/my_permissions_response_spec.rb +7 -12
- data/spec/models/nested_role_response_spec.rb +9 -14
- data/spec/models/nested_role_spec.rb +9 -14
- data/spec/models/object_roles_response_spec.rb +7 -12
- data/spec/models/paginated_repository_version_response_list_spec.rb +10 -15
- data/spec/models/paginatedcontainer_blob_response_list_spec.rb +10 -15
- data/spec/models/paginatedcontainer_container_distribution_response_list_spec.rb +10 -15
- data/spec/models/paginatedcontainer_container_namespace_response_list_spec.rb +10 -15
- data/spec/models/paginatedcontainer_container_pull_through_distribution_response_list_spec.rb +10 -15
- data/spec/models/paginatedcontainer_container_pull_through_remote_response_list_spec.rb +10 -15
- data/spec/models/paginatedcontainer_container_push_repository_response_list_spec.rb +10 -15
- data/spec/models/paginatedcontainer_container_remote_response_list_spec.rb +10 -15
- data/spec/models/paginatedcontainer_container_repository_response_list_spec.rb +10 -15
- data/spec/models/paginatedcontainer_manifest_response_list_spec.rb +10 -15
- data/spec/models/paginatedcontainer_manifest_signature_response_list_spec.rb +10 -15
- data/spec/models/paginatedcontainer_tag_response_list_spec.rb +10 -15
- data/spec/models/patchedcontainer_container_distribution_spec.rb +20 -25
- data/spec/models/patchedcontainer_container_pull_through_distribution_spec.rb +21 -26
- data/spec/models/patchedcontainer_container_pull_through_remote_spec.rb +29 -34
- data/spec/models/patchedcontainer_container_push_repository_spec.rb +16 -21
- data/spec/models/patchedcontainer_container_remote_spec.rb +31 -36
- data/spec/models/patchedcontainer_container_repository_spec.rb +12 -17
- data/spec/models/policy692_enum_spec.rb +6 -11
- data/spec/models/policy7e0_enum_spec.rb +6 -11
- data/spec/models/recursive_manage_spec.rb +7 -12
- data/spec/models/remove_image_spec.rb +7 -12
- data/spec/models/remove_signatures_response_spec.rb +7 -12
- data/spec/models/remove_signatures_spec.rb +7 -12
- data/spec/models/repair_spec.rb +7 -12
- data/spec/models/repository_sign_spec.rb +9 -14
- data/spec/models/repository_version_response_spec.rb +14 -19
- data/spec/models/set_label_response_spec.rb +8 -13
- data/spec/models/set_label_spec.rb +8 -13
- data/spec/models/tag_copy_spec.rb +9 -14
- data/spec/models/tag_image_spec.rb +8 -13
- data/spec/models/un_tag_image_spec.rb +7 -12
- data/spec/models/unset_label_response_spec.rb +8 -13
- data/spec/models/unset_label_spec.rb +7 -12
- data/spec/spec_helper.rb +1 -1
- metadata +105 -85
- data/docs/ContainerContainerPullThroughRemoteResponseHiddenFields.md +0 -19
- data/docs/OCIBuildImage.md +0 -23
- data/lib/pulp_container_client/models/oci_build_image.rb +0 -256
- data/spec/api_client_spec.rb +0 -188
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/oci_build_image_spec.rb +0 -59
@@ -2,35 +2,34 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost:24817*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**add_role**](DistributionsContainerApi.md#add_role) | **POST** {container_container_distribution_href}add_role/ | Add a role
|
8
|
-
[**create**](DistributionsContainerApi.md#create) | **POST** /pulp/api/v3/distributions/container/container/ | Create a container distribution
|
9
|
-
[**delete**](DistributionsContainerApi.md#delete) | **DELETE** {container_container_distribution_href} | Delete a container distribution
|
10
|
-
[**list**](DistributionsContainerApi.md#list) | **GET** /pulp/api/v3/distributions/container/container/ | List container distributions
|
11
|
-
[**list_roles**](DistributionsContainerApi.md#list_roles) | **GET** {container_container_distribution_href}list_roles/ | List roles
|
12
|
-
[**my_permissions**](DistributionsContainerApi.md#my_permissions) | **GET** {container_container_distribution_href}my_permissions/ | List user permissions
|
13
|
-
[**partial_update**](DistributionsContainerApi.md#partial_update) | **PATCH** {container_container_distribution_href} | Update a container distribution
|
14
|
-
[**read**](DistributionsContainerApi.md#read) | **GET** {container_container_distribution_href} | Inspect a container distribution
|
15
|
-
[**remove_role**](DistributionsContainerApi.md#remove_role) | **POST** {container_container_distribution_href}remove_role/ | Remove a role
|
16
|
-
[**set_label**](DistributionsContainerApi.md#set_label) | **POST** {container_container_distribution_href}set_label/ | Set a label
|
17
|
-
[**unset_label**](DistributionsContainerApi.md#unset_label) | **POST** {container_container_distribution_href}unset_label/ | Unset a label
|
18
|
-
[**update**](DistributionsContainerApi.md#update) | **PUT** {container_container_distribution_href} | Update a container distribution
|
19
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**add_role**](DistributionsContainerApi.md#add_role) | **POST** {container_container_distribution_href}add_role/ | Add a role |
|
8
|
+
| [**create**](DistributionsContainerApi.md#create) | **POST** /pulp/api/v3/distributions/container/container/ | Create a container distribution |
|
9
|
+
| [**delete**](DistributionsContainerApi.md#delete) | **DELETE** {container_container_distribution_href} | Delete a container distribution |
|
10
|
+
| [**list**](DistributionsContainerApi.md#list) | **GET** /pulp/api/v3/distributions/container/container/ | List container distributions |
|
11
|
+
| [**list_roles**](DistributionsContainerApi.md#list_roles) | **GET** {container_container_distribution_href}list_roles/ | List roles |
|
12
|
+
| [**my_permissions**](DistributionsContainerApi.md#my_permissions) | **GET** {container_container_distribution_href}my_permissions/ | List user permissions |
|
13
|
+
| [**partial_update**](DistributionsContainerApi.md#partial_update) | **PATCH** {container_container_distribution_href} | Update a container distribution |
|
14
|
+
| [**read**](DistributionsContainerApi.md#read) | **GET** {container_container_distribution_href} | Inspect a container distribution |
|
15
|
+
| [**remove_role**](DistributionsContainerApi.md#remove_role) | **POST** {container_container_distribution_href}remove_role/ | Remove a role |
|
16
|
+
| [**set_label**](DistributionsContainerApi.md#set_label) | **POST** {container_container_distribution_href}set_label/ | Set a label |
|
17
|
+
| [**unset_label**](DistributionsContainerApi.md#unset_label) | **POST** {container_container_distribution_href}unset_label/ | Unset a label |
|
18
|
+
| [**update**](DistributionsContainerApi.md#update) | **PUT** {container_container_distribution_href} | Update a container distribution |
|
20
19
|
|
21
20
|
|
22
21
|
## add_role
|
23
22
|
|
24
|
-
> NestedRoleResponse add_role(container_container_distribution_href, nested_role)
|
23
|
+
> <NestedRoleResponse> add_role(container_container_distribution_href, nested_role)
|
25
24
|
|
26
25
|
Add a role
|
27
26
|
|
28
27
|
Add a role for this object to users/groups.
|
29
28
|
|
30
|
-
###
|
29
|
+
### Examples
|
31
30
|
|
32
31
|
```ruby
|
33
|
-
|
32
|
+
require 'time'
|
34
33
|
require 'pulp_container_client'
|
35
34
|
# setup authorization
|
36
35
|
PulpContainerClient.configure do |config|
|
@@ -41,24 +40,41 @@ end
|
|
41
40
|
|
42
41
|
api_instance = PulpContainerClient::DistributionsContainerApi.new
|
43
42
|
container_container_distribution_href = 'container_container_distribution_href_example' # String |
|
44
|
-
nested_role = PulpContainerClient::NestedRole.new # NestedRole |
|
43
|
+
nested_role = PulpContainerClient::NestedRole.new({role: 'role_example'}) # NestedRole |
|
45
44
|
|
46
45
|
begin
|
47
|
-
#Add a role
|
46
|
+
# Add a role
|
48
47
|
result = api_instance.add_role(container_container_distribution_href, nested_role)
|
49
48
|
p result
|
50
49
|
rescue PulpContainerClient::ApiError => e
|
51
|
-
puts "
|
50
|
+
puts "Error when calling DistributionsContainerApi->add_role: #{e}"
|
52
51
|
end
|
53
52
|
```
|
54
53
|
|
55
|
-
|
54
|
+
#### Using the add_role_with_http_info variant
|
55
|
+
|
56
|
+
This returns an Array which contains the response data, status code and headers.
|
57
|
+
|
58
|
+
> <Array(<NestedRoleResponse>, Integer, Hash)> add_role_with_http_info(container_container_distribution_href, nested_role)
|
59
|
+
|
60
|
+
```ruby
|
61
|
+
begin
|
62
|
+
# Add a role
|
63
|
+
data, status_code, headers = api_instance.add_role_with_http_info(container_container_distribution_href, nested_role)
|
64
|
+
p status_code # => 2xx
|
65
|
+
p headers # => { ... }
|
66
|
+
p data # => <NestedRoleResponse>
|
67
|
+
rescue PulpContainerClient::ApiError => e
|
68
|
+
puts "Error when calling DistributionsContainerApi->add_role_with_http_info: #{e}"
|
69
|
+
end
|
70
|
+
```
|
56
71
|
|
72
|
+
### Parameters
|
57
73
|
|
58
|
-
Name | Type | Description
|
59
|
-
|
60
|
-
**container_container_distribution_href** | **String
|
61
|
-
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
74
|
+
| Name | Type | Description | Notes |
|
75
|
+
| ---- | ---- | ----------- | ----- |
|
76
|
+
| **container_container_distribution_href** | **String** | | |
|
77
|
+
| **nested_role** | [**NestedRole**](NestedRole.md) | | |
|
62
78
|
|
63
79
|
### Return type
|
64
80
|
|
@@ -76,16 +92,16 @@ Name | Type | Description | Notes
|
|
76
92
|
|
77
93
|
## create
|
78
94
|
|
79
|
-
> AsyncOperationResponse create(container_container_distribution)
|
95
|
+
> <AsyncOperationResponse> create(container_container_distribution)
|
80
96
|
|
81
97
|
Create a container distribution
|
82
98
|
|
83
99
|
Trigger an asynchronous create task
|
84
100
|
|
85
|
-
###
|
101
|
+
### Examples
|
86
102
|
|
87
103
|
```ruby
|
88
|
-
|
104
|
+
require 'time'
|
89
105
|
require 'pulp_container_client'
|
90
106
|
# setup authorization
|
91
107
|
PulpContainerClient.configure do |config|
|
@@ -95,23 +111,40 @@ PulpContainerClient.configure do |config|
|
|
95
111
|
end
|
96
112
|
|
97
113
|
api_instance = PulpContainerClient::DistributionsContainerApi.new
|
98
|
-
container_container_distribution = PulpContainerClient::ContainerContainerDistribution.new # ContainerContainerDistribution |
|
114
|
+
container_container_distribution = PulpContainerClient::ContainerContainerDistribution.new({base_path: 'base_path_example', name: 'name_example'}) # ContainerContainerDistribution |
|
99
115
|
|
100
116
|
begin
|
101
|
-
#Create a container distribution
|
117
|
+
# Create a container distribution
|
102
118
|
result = api_instance.create(container_container_distribution)
|
103
119
|
p result
|
104
120
|
rescue PulpContainerClient::ApiError => e
|
105
|
-
puts "
|
121
|
+
puts "Error when calling DistributionsContainerApi->create: #{e}"
|
106
122
|
end
|
107
123
|
```
|
108
124
|
|
109
|
-
|
125
|
+
#### Using the create_with_http_info variant
|
110
126
|
|
127
|
+
This returns an Array which contains the response data, status code and headers.
|
111
128
|
|
112
|
-
|
113
|
-
|
114
|
-
|
129
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> create_with_http_info(container_container_distribution)
|
130
|
+
|
131
|
+
```ruby
|
132
|
+
begin
|
133
|
+
# Create a container distribution
|
134
|
+
data, status_code, headers = api_instance.create_with_http_info(container_container_distribution)
|
135
|
+
p status_code # => 2xx
|
136
|
+
p headers # => { ... }
|
137
|
+
p data # => <AsyncOperationResponse>
|
138
|
+
rescue PulpContainerClient::ApiError => e
|
139
|
+
puts "Error when calling DistributionsContainerApi->create_with_http_info: #{e}"
|
140
|
+
end
|
141
|
+
```
|
142
|
+
|
143
|
+
### Parameters
|
144
|
+
|
145
|
+
| Name | Type | Description | Notes |
|
146
|
+
| ---- | ---- | ----------- | ----- |
|
147
|
+
| **container_container_distribution** | [**ContainerContainerDistribution**](ContainerContainerDistribution.md) | | |
|
115
148
|
|
116
149
|
### Return type
|
117
150
|
|
@@ -129,16 +162,16 @@ Name | Type | Description | Notes
|
|
129
162
|
|
130
163
|
## delete
|
131
164
|
|
132
|
-
> AsyncOperationResponse delete(container_container_distribution_href)
|
165
|
+
> <AsyncOperationResponse> delete(container_container_distribution_href)
|
133
166
|
|
134
167
|
Delete a container distribution
|
135
168
|
|
136
169
|
Trigger an asynchronous delete task
|
137
170
|
|
138
|
-
###
|
171
|
+
### Examples
|
139
172
|
|
140
173
|
```ruby
|
141
|
-
|
174
|
+
require 'time'
|
142
175
|
require 'pulp_container_client'
|
143
176
|
# setup authorization
|
144
177
|
PulpContainerClient.configure do |config|
|
@@ -151,20 +184,37 @@ api_instance = PulpContainerClient::DistributionsContainerApi.new
|
|
151
184
|
container_container_distribution_href = 'container_container_distribution_href_example' # String |
|
152
185
|
|
153
186
|
begin
|
154
|
-
#Delete a container distribution
|
187
|
+
# Delete a container distribution
|
155
188
|
result = api_instance.delete(container_container_distribution_href)
|
156
189
|
p result
|
157
190
|
rescue PulpContainerClient::ApiError => e
|
158
|
-
puts "
|
191
|
+
puts "Error when calling DistributionsContainerApi->delete: #{e}"
|
159
192
|
end
|
160
193
|
```
|
161
194
|
|
162
|
-
|
195
|
+
#### Using the delete_with_http_info variant
|
196
|
+
|
197
|
+
This returns an Array which contains the response data, status code and headers.
|
198
|
+
|
199
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(container_container_distribution_href)
|
163
200
|
|
201
|
+
```ruby
|
202
|
+
begin
|
203
|
+
# Delete a container distribution
|
204
|
+
data, status_code, headers = api_instance.delete_with_http_info(container_container_distribution_href)
|
205
|
+
p status_code # => 2xx
|
206
|
+
p headers # => { ... }
|
207
|
+
p data # => <AsyncOperationResponse>
|
208
|
+
rescue PulpContainerClient::ApiError => e
|
209
|
+
puts "Error when calling DistributionsContainerApi->delete_with_http_info: #{e}"
|
210
|
+
end
|
211
|
+
```
|
212
|
+
|
213
|
+
### Parameters
|
164
214
|
|
165
|
-
Name | Type | Description
|
166
|
-
|
167
|
-
**container_container_distribution_href** | **String
|
215
|
+
| Name | Type | Description | Notes |
|
216
|
+
| ---- | ---- | ----------- | ----- |
|
217
|
+
| **container_container_distribution_href** | **String** | | |
|
168
218
|
|
169
219
|
### Return type
|
170
220
|
|
@@ -182,16 +232,16 @@ Name | Type | Description | Notes
|
|
182
232
|
|
183
233
|
## list
|
184
234
|
|
185
|
-
> PaginatedcontainerContainerDistributionResponseList list(opts)
|
235
|
+
> <PaginatedcontainerContainerDistributionResponseList> list(opts)
|
186
236
|
|
187
237
|
List container distributions
|
188
238
|
|
189
239
|
The Container Distribution will serve the latest version of a Repository if ``repository`` is specified. The Container Distribution will serve a specific repository version if ``repository_version``. Note that **either** ``repository`` or ``repository_version`` can be set on a Container Distribution, but not both.
|
190
240
|
|
191
|
-
###
|
241
|
+
### Examples
|
192
242
|
|
193
243
|
```ruby
|
194
|
-
|
244
|
+
require 'time'
|
195
245
|
require 'pulp_container_client'
|
196
246
|
# setup authorization
|
197
247
|
PulpContainerClient.configure do |config|
|
@@ -205,73 +255,90 @@ opts = {
|
|
205
255
|
base_path: 'base_path_example', # String | Filter results where base_path matches value
|
206
256
|
base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
|
207
257
|
base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
|
208
|
-
base_path__in: ['
|
258
|
+
base_path__in: ['inner_example'], # Array<String> | Filter results where base_path is in a comma-separated list of values
|
209
259
|
limit: 56, # Integer | Number of results to return per page.
|
210
260
|
name: 'name_example', # String | Filter results where name matches value
|
211
261
|
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
212
262
|
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
213
263
|
name__iexact: 'name__iexact_example', # String | Filter results where name matches value
|
214
|
-
name__in: ['
|
264
|
+
name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
215
265
|
name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
|
216
266
|
name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
|
217
267
|
name__regex: 'name__regex_example', # String | Filter results where name matches regex value
|
218
268
|
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
219
269
|
namespace__name: 'namespace__name_example', # String |
|
220
270
|
offset: 56, # Integer | The initial index from which to return the results.
|
221
|
-
ordering: ['
|
222
|
-
prn__in: ['
|
223
|
-
pulp_href__in: ['
|
224
|
-
pulp_id__in: ['
|
271
|
+
ordering: ['-base_path'], # 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) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `private` - Private * `-private` - Private (descending) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
272
|
+
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
273
|
+
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
274
|
+
pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
225
275
|
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
226
276
|
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
227
|
-
repository: '
|
228
|
-
repository__in: ['
|
277
|
+
repository: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Filter results where repository matches value
|
278
|
+
repository__in: ['inner_example'], # Array<String> | Filter results where repository is in a comma-separated list of values
|
229
279
|
with_content: 'with_content_example', # String | Filter distributions based on the content served by them
|
230
|
-
fields: ['
|
231
|
-
exclude_fields: ['
|
280
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
281
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
232
282
|
}
|
233
283
|
|
234
284
|
begin
|
235
|
-
#List container distributions
|
285
|
+
# List container distributions
|
236
286
|
result = api_instance.list(opts)
|
237
287
|
p result
|
238
288
|
rescue PulpContainerClient::ApiError => e
|
239
|
-
puts "
|
289
|
+
puts "Error when calling DistributionsContainerApi->list: #{e}"
|
240
290
|
end
|
241
291
|
```
|
242
292
|
|
243
|
-
|
293
|
+
#### Using the list_with_http_info variant
|
294
|
+
|
295
|
+
This returns an Array which contains the response data, status code and headers.
|
244
296
|
|
297
|
+
> <Array(<PaginatedcontainerContainerDistributionResponseList>, Integer, Hash)> list_with_http_info(opts)
|
245
298
|
|
246
|
-
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
**
|
263
|
-
**
|
264
|
-
**
|
265
|
-
**
|
266
|
-
**
|
267
|
-
**
|
268
|
-
**
|
269
|
-
**
|
270
|
-
**
|
271
|
-
**
|
272
|
-
**
|
273
|
-
**
|
274
|
-
**
|
299
|
+
```ruby
|
300
|
+
begin
|
301
|
+
# List container distributions
|
302
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
303
|
+
p status_code # => 2xx
|
304
|
+
p headers # => { ... }
|
305
|
+
p data # => <PaginatedcontainerContainerDistributionResponseList>
|
306
|
+
rescue PulpContainerClient::ApiError => e
|
307
|
+
puts "Error when calling DistributionsContainerApi->list_with_http_info: #{e}"
|
308
|
+
end
|
309
|
+
```
|
310
|
+
|
311
|
+
### Parameters
|
312
|
+
|
313
|
+
| Name | Type | Description | Notes |
|
314
|
+
| ---- | ---- | ----------- | ----- |
|
315
|
+
| **base_path** | **String** | Filter results where base_path matches value | [optional] |
|
316
|
+
| **base_path__contains** | **String** | Filter results where base_path contains value | [optional] |
|
317
|
+
| **base_path__icontains** | **String** | Filter results where base_path contains value | [optional] |
|
318
|
+
| **base_path__in** | [**Array<String>**](String.md) | Filter results where base_path is in a comma-separated list of values | [optional] |
|
319
|
+
| **limit** | **Integer** | Number of results to return per page. | [optional] |
|
320
|
+
| **name** | **String** | Filter results where name matches value | [optional] |
|
321
|
+
| **name__contains** | **String** | Filter results where name contains value | [optional] |
|
322
|
+
| **name__icontains** | **String** | Filter results where name contains value | [optional] |
|
323
|
+
| **name__iexact** | **String** | Filter results where name matches value | [optional] |
|
324
|
+
| **name__in** | [**Array<String>**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
|
325
|
+
| **name__iregex** | **String** | Filter results where name matches regex value | [optional] |
|
326
|
+
| **name__istartswith** | **String** | Filter results where name starts with value | [optional] |
|
327
|
+
| **name__regex** | **String** | Filter results where name matches regex value | [optional] |
|
328
|
+
| **name__startswith** | **String** | Filter results where name starts with value | [optional] |
|
329
|
+
| **namespace__name** | **String** | | [optional] |
|
330
|
+
| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
|
331
|
+
| **ordering** | [**Array<String>**](String.md) | 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) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `private` - Private * `-private` - Private (descending) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
332
|
+
| **prn__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
333
|
+
| **pulp_href__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
334
|
+
| **pulp_id__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
335
|
+
| **pulp_label_select** | **String** | Filter labels by search string | [optional] |
|
336
|
+
| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
|
337
|
+
| **repository** | **String** | Filter results where repository matches value | [optional] |
|
338
|
+
| **repository__in** | [**Array<String>**](String.md) | Filter results where repository is in a comma-separated list of values | [optional] |
|
339
|
+
| **with_content** | **String** | Filter distributions based on the content served by them | [optional] |
|
340
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
341
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
275
342
|
|
276
343
|
### Return type
|
277
344
|
|
@@ -289,16 +356,16 @@ Name | Type | Description | Notes
|
|
289
356
|
|
290
357
|
## list_roles
|
291
358
|
|
292
|
-
> ObjectRolesResponse list_roles(container_container_distribution_href, opts)
|
359
|
+
> <ObjectRolesResponse> list_roles(container_container_distribution_href, opts)
|
293
360
|
|
294
361
|
List roles
|
295
362
|
|
296
363
|
List roles assigned to this object.
|
297
364
|
|
298
|
-
###
|
365
|
+
### Examples
|
299
366
|
|
300
367
|
```ruby
|
301
|
-
|
368
|
+
require 'time'
|
302
369
|
require 'pulp_container_client'
|
303
370
|
# setup authorization
|
304
371
|
PulpContainerClient.configure do |config|
|
@@ -310,27 +377,44 @@ end
|
|
310
377
|
api_instance = PulpContainerClient::DistributionsContainerApi.new
|
311
378
|
container_container_distribution_href = 'container_container_distribution_href_example' # String |
|
312
379
|
opts = {
|
313
|
-
fields: ['
|
314
|
-
exclude_fields: ['
|
380
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
381
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
315
382
|
}
|
316
383
|
|
317
384
|
begin
|
318
|
-
#List roles
|
385
|
+
# List roles
|
319
386
|
result = api_instance.list_roles(container_container_distribution_href, opts)
|
320
387
|
p result
|
321
388
|
rescue PulpContainerClient::ApiError => e
|
322
|
-
puts "
|
389
|
+
puts "Error when calling DistributionsContainerApi->list_roles: #{e}"
|
323
390
|
end
|
324
391
|
```
|
325
392
|
|
326
|
-
|
393
|
+
#### Using the list_roles_with_http_info variant
|
394
|
+
|
395
|
+
This returns an Array which contains the response data, status code and headers.
|
396
|
+
|
397
|
+
> <Array(<ObjectRolesResponse>, Integer, Hash)> list_roles_with_http_info(container_container_distribution_href, opts)
|
398
|
+
|
399
|
+
```ruby
|
400
|
+
begin
|
401
|
+
# List roles
|
402
|
+
data, status_code, headers = api_instance.list_roles_with_http_info(container_container_distribution_href, opts)
|
403
|
+
p status_code # => 2xx
|
404
|
+
p headers # => { ... }
|
405
|
+
p data # => <ObjectRolesResponse>
|
406
|
+
rescue PulpContainerClient::ApiError => e
|
407
|
+
puts "Error when calling DistributionsContainerApi->list_roles_with_http_info: #{e}"
|
408
|
+
end
|
409
|
+
```
|
327
410
|
|
411
|
+
### Parameters
|
328
412
|
|
329
|
-
Name | Type | Description
|
330
|
-
|
331
|
-
**container_container_distribution_href** | **String
|
332
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
333
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
413
|
+
| Name | Type | Description | Notes |
|
414
|
+
| ---- | ---- | ----------- | ----- |
|
415
|
+
| **container_container_distribution_href** | **String** | | |
|
416
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
417
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
334
418
|
|
335
419
|
### Return type
|
336
420
|
|
@@ -348,16 +432,16 @@ Name | Type | Description | Notes
|
|
348
432
|
|
349
433
|
## my_permissions
|
350
434
|
|
351
|
-
> MyPermissionsResponse my_permissions(container_container_distribution_href, opts)
|
435
|
+
> <MyPermissionsResponse> my_permissions(container_container_distribution_href, opts)
|
352
436
|
|
353
437
|
List user permissions
|
354
438
|
|
355
439
|
List permissions available to the current user on this object.
|
356
440
|
|
357
|
-
###
|
441
|
+
### Examples
|
358
442
|
|
359
443
|
```ruby
|
360
|
-
|
444
|
+
require 'time'
|
361
445
|
require 'pulp_container_client'
|
362
446
|
# setup authorization
|
363
447
|
PulpContainerClient.configure do |config|
|
@@ -369,27 +453,44 @@ end
|
|
369
453
|
api_instance = PulpContainerClient::DistributionsContainerApi.new
|
370
454
|
container_container_distribution_href = 'container_container_distribution_href_example' # String |
|
371
455
|
opts = {
|
372
|
-
fields: ['
|
373
|
-
exclude_fields: ['
|
456
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
457
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
374
458
|
}
|
375
459
|
|
376
460
|
begin
|
377
|
-
#List user permissions
|
461
|
+
# List user permissions
|
378
462
|
result = api_instance.my_permissions(container_container_distribution_href, opts)
|
379
463
|
p result
|
380
464
|
rescue PulpContainerClient::ApiError => e
|
381
|
-
puts "
|
465
|
+
puts "Error when calling DistributionsContainerApi->my_permissions: #{e}"
|
382
466
|
end
|
383
467
|
```
|
384
468
|
|
385
|
-
|
469
|
+
#### Using the my_permissions_with_http_info variant
|
470
|
+
|
471
|
+
This returns an Array which contains the response data, status code and headers.
|
472
|
+
|
473
|
+
> <Array(<MyPermissionsResponse>, Integer, Hash)> my_permissions_with_http_info(container_container_distribution_href, opts)
|
386
474
|
|
475
|
+
```ruby
|
476
|
+
begin
|
477
|
+
# List user permissions
|
478
|
+
data, status_code, headers = api_instance.my_permissions_with_http_info(container_container_distribution_href, opts)
|
479
|
+
p status_code # => 2xx
|
480
|
+
p headers # => { ... }
|
481
|
+
p data # => <MyPermissionsResponse>
|
482
|
+
rescue PulpContainerClient::ApiError => e
|
483
|
+
puts "Error when calling DistributionsContainerApi->my_permissions_with_http_info: #{e}"
|
484
|
+
end
|
485
|
+
```
|
486
|
+
|
487
|
+
### Parameters
|
387
488
|
|
388
|
-
Name | Type | Description
|
389
|
-
|
390
|
-
**container_container_distribution_href** | **String
|
391
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
392
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
489
|
+
| Name | Type | Description | Notes |
|
490
|
+
| ---- | ---- | ----------- | ----- |
|
491
|
+
| **container_container_distribution_href** | **String** | | |
|
492
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
493
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
393
494
|
|
394
495
|
### Return type
|
395
496
|
|
@@ -407,16 +508,16 @@ Name | Type | Description | Notes
|
|
407
508
|
|
408
509
|
## partial_update
|
409
510
|
|
410
|
-
> AsyncOperationResponse partial_update(container_container_distribution_href, patchedcontainer_container_distribution)
|
511
|
+
> <AsyncOperationResponse> partial_update(container_container_distribution_href, patchedcontainer_container_distribution)
|
411
512
|
|
412
513
|
Update a container distribution
|
413
514
|
|
414
515
|
Trigger an asynchronous partial update task
|
415
516
|
|
416
|
-
###
|
517
|
+
### Examples
|
417
518
|
|
418
519
|
```ruby
|
419
|
-
|
520
|
+
require 'time'
|
420
521
|
require 'pulp_container_client'
|
421
522
|
# setup authorization
|
422
523
|
PulpContainerClient.configure do |config|
|
@@ -430,21 +531,38 @@ container_container_distribution_href = 'container_container_distribution_href_e
|
|
430
531
|
patchedcontainer_container_distribution = PulpContainerClient::PatchedcontainerContainerDistribution.new # PatchedcontainerContainerDistribution |
|
431
532
|
|
432
533
|
begin
|
433
|
-
#Update a container distribution
|
534
|
+
# Update a container distribution
|
434
535
|
result = api_instance.partial_update(container_container_distribution_href, patchedcontainer_container_distribution)
|
435
536
|
p result
|
436
537
|
rescue PulpContainerClient::ApiError => e
|
437
|
-
puts "
|
538
|
+
puts "Error when calling DistributionsContainerApi->partial_update: #{e}"
|
438
539
|
end
|
439
540
|
```
|
440
541
|
|
441
|
-
|
542
|
+
#### Using the partial_update_with_http_info variant
|
543
|
+
|
544
|
+
This returns an Array which contains the response data, status code and headers.
|
442
545
|
|
546
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> partial_update_with_http_info(container_container_distribution_href, patchedcontainer_container_distribution)
|
443
547
|
|
444
|
-
|
445
|
-
|
446
|
-
|
447
|
-
|
548
|
+
```ruby
|
549
|
+
begin
|
550
|
+
# Update a container distribution
|
551
|
+
data, status_code, headers = api_instance.partial_update_with_http_info(container_container_distribution_href, patchedcontainer_container_distribution)
|
552
|
+
p status_code # => 2xx
|
553
|
+
p headers # => { ... }
|
554
|
+
p data # => <AsyncOperationResponse>
|
555
|
+
rescue PulpContainerClient::ApiError => e
|
556
|
+
puts "Error when calling DistributionsContainerApi->partial_update_with_http_info: #{e}"
|
557
|
+
end
|
558
|
+
```
|
559
|
+
|
560
|
+
### Parameters
|
561
|
+
|
562
|
+
| Name | Type | Description | Notes |
|
563
|
+
| ---- | ---- | ----------- | ----- |
|
564
|
+
| **container_container_distribution_href** | **String** | | |
|
565
|
+
| **patchedcontainer_container_distribution** | [**PatchedcontainerContainerDistribution**](PatchedcontainerContainerDistribution.md) | | |
|
448
566
|
|
449
567
|
### Return type
|
450
568
|
|
@@ -462,16 +580,16 @@ Name | Type | Description | Notes
|
|
462
580
|
|
463
581
|
## read
|
464
582
|
|
465
|
-
> ContainerContainerDistributionResponse read(container_container_distribution_href, opts)
|
583
|
+
> <ContainerContainerDistributionResponse> read(container_container_distribution_href, opts)
|
466
584
|
|
467
585
|
Inspect a container distribution
|
468
586
|
|
469
587
|
The Container Distribution will serve the latest version of a Repository if ``repository`` is specified. The Container Distribution will serve a specific repository version if ``repository_version``. Note that **either** ``repository`` or ``repository_version`` can be set on a Container Distribution, but not both.
|
470
588
|
|
471
|
-
###
|
589
|
+
### Examples
|
472
590
|
|
473
591
|
```ruby
|
474
|
-
|
592
|
+
require 'time'
|
475
593
|
require 'pulp_container_client'
|
476
594
|
# setup authorization
|
477
595
|
PulpContainerClient.configure do |config|
|
@@ -483,27 +601,44 @@ end
|
|
483
601
|
api_instance = PulpContainerClient::DistributionsContainerApi.new
|
484
602
|
container_container_distribution_href = 'container_container_distribution_href_example' # String |
|
485
603
|
opts = {
|
486
|
-
fields: ['
|
487
|
-
exclude_fields: ['
|
604
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
605
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
488
606
|
}
|
489
607
|
|
490
608
|
begin
|
491
|
-
#Inspect a container distribution
|
609
|
+
# Inspect a container distribution
|
492
610
|
result = api_instance.read(container_container_distribution_href, opts)
|
493
611
|
p result
|
494
612
|
rescue PulpContainerClient::ApiError => e
|
495
|
-
puts "
|
613
|
+
puts "Error when calling DistributionsContainerApi->read: #{e}"
|
496
614
|
end
|
497
615
|
```
|
498
616
|
|
499
|
-
|
617
|
+
#### Using the read_with_http_info variant
|
618
|
+
|
619
|
+
This returns an Array which contains the response data, status code and headers.
|
620
|
+
|
621
|
+
> <Array(<ContainerContainerDistributionResponse>, Integer, Hash)> read_with_http_info(container_container_distribution_href, opts)
|
622
|
+
|
623
|
+
```ruby
|
624
|
+
begin
|
625
|
+
# Inspect a container distribution
|
626
|
+
data, status_code, headers = api_instance.read_with_http_info(container_container_distribution_href, opts)
|
627
|
+
p status_code # => 2xx
|
628
|
+
p headers # => { ... }
|
629
|
+
p data # => <ContainerContainerDistributionResponse>
|
630
|
+
rescue PulpContainerClient::ApiError => e
|
631
|
+
puts "Error when calling DistributionsContainerApi->read_with_http_info: #{e}"
|
632
|
+
end
|
633
|
+
```
|
500
634
|
|
635
|
+
### Parameters
|
501
636
|
|
502
|
-
Name | Type | Description
|
503
|
-
|
504
|
-
**container_container_distribution_href** | **String
|
505
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
506
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
637
|
+
| Name | Type | Description | Notes |
|
638
|
+
| ---- | ---- | ----------- | ----- |
|
639
|
+
| **container_container_distribution_href** | **String** | | |
|
640
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
641
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
507
642
|
|
508
643
|
### Return type
|
509
644
|
|
@@ -521,16 +656,16 @@ Name | Type | Description | Notes
|
|
521
656
|
|
522
657
|
## remove_role
|
523
658
|
|
524
|
-
> NestedRoleResponse remove_role(container_container_distribution_href, nested_role)
|
659
|
+
> <NestedRoleResponse> remove_role(container_container_distribution_href, nested_role)
|
525
660
|
|
526
661
|
Remove a role
|
527
662
|
|
528
663
|
Remove a role for this object from users/groups.
|
529
664
|
|
530
|
-
###
|
665
|
+
### Examples
|
531
666
|
|
532
667
|
```ruby
|
533
|
-
|
668
|
+
require 'time'
|
534
669
|
require 'pulp_container_client'
|
535
670
|
# setup authorization
|
536
671
|
PulpContainerClient.configure do |config|
|
@@ -541,24 +676,41 @@ end
|
|
541
676
|
|
542
677
|
api_instance = PulpContainerClient::DistributionsContainerApi.new
|
543
678
|
container_container_distribution_href = 'container_container_distribution_href_example' # String |
|
544
|
-
nested_role = PulpContainerClient::NestedRole.new # NestedRole |
|
679
|
+
nested_role = PulpContainerClient::NestedRole.new({role: 'role_example'}) # NestedRole |
|
545
680
|
|
546
681
|
begin
|
547
|
-
#Remove a role
|
682
|
+
# Remove a role
|
548
683
|
result = api_instance.remove_role(container_container_distribution_href, nested_role)
|
549
684
|
p result
|
550
685
|
rescue PulpContainerClient::ApiError => e
|
551
|
-
puts "
|
686
|
+
puts "Error when calling DistributionsContainerApi->remove_role: #{e}"
|
552
687
|
end
|
553
688
|
```
|
554
689
|
|
555
|
-
|
690
|
+
#### Using the remove_role_with_http_info variant
|
691
|
+
|
692
|
+
This returns an Array which contains the response data, status code and headers.
|
693
|
+
|
694
|
+
> <Array(<NestedRoleResponse>, Integer, Hash)> remove_role_with_http_info(container_container_distribution_href, nested_role)
|
556
695
|
|
696
|
+
```ruby
|
697
|
+
begin
|
698
|
+
# Remove a role
|
699
|
+
data, status_code, headers = api_instance.remove_role_with_http_info(container_container_distribution_href, nested_role)
|
700
|
+
p status_code # => 2xx
|
701
|
+
p headers # => { ... }
|
702
|
+
p data # => <NestedRoleResponse>
|
703
|
+
rescue PulpContainerClient::ApiError => e
|
704
|
+
puts "Error when calling DistributionsContainerApi->remove_role_with_http_info: #{e}"
|
705
|
+
end
|
706
|
+
```
|
707
|
+
|
708
|
+
### Parameters
|
557
709
|
|
558
|
-
Name | Type | Description
|
559
|
-
|
560
|
-
**container_container_distribution_href** | **String
|
561
|
-
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
710
|
+
| Name | Type | Description | Notes |
|
711
|
+
| ---- | ---- | ----------- | ----- |
|
712
|
+
| **container_container_distribution_href** | **String** | | |
|
713
|
+
| **nested_role** | [**NestedRole**](NestedRole.md) | | |
|
562
714
|
|
563
715
|
### Return type
|
564
716
|
|
@@ -576,16 +728,16 @@ Name | Type | Description | Notes
|
|
576
728
|
|
577
729
|
## set_label
|
578
730
|
|
579
|
-
> SetLabelResponse set_label(container_container_distribution_href, set_label)
|
731
|
+
> <SetLabelResponse> set_label(container_container_distribution_href, set_label)
|
580
732
|
|
581
733
|
Set a label
|
582
734
|
|
583
735
|
Set a single pulp_label on the object to a specific value or null.
|
584
736
|
|
585
|
-
###
|
737
|
+
### Examples
|
586
738
|
|
587
739
|
```ruby
|
588
|
-
|
740
|
+
require 'time'
|
589
741
|
require 'pulp_container_client'
|
590
742
|
# setup authorization
|
591
743
|
PulpContainerClient.configure do |config|
|
@@ -596,24 +748,41 @@ end
|
|
596
748
|
|
597
749
|
api_instance = PulpContainerClient::DistributionsContainerApi.new
|
598
750
|
container_container_distribution_href = 'container_container_distribution_href_example' # String |
|
599
|
-
set_label = PulpContainerClient::SetLabel.new # SetLabel |
|
751
|
+
set_label = PulpContainerClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
|
600
752
|
|
601
753
|
begin
|
602
|
-
#Set a label
|
754
|
+
# Set a label
|
603
755
|
result = api_instance.set_label(container_container_distribution_href, set_label)
|
604
756
|
p result
|
605
757
|
rescue PulpContainerClient::ApiError => e
|
606
|
-
puts "
|
758
|
+
puts "Error when calling DistributionsContainerApi->set_label: #{e}"
|
607
759
|
end
|
608
760
|
```
|
609
761
|
|
610
|
-
|
762
|
+
#### Using the set_label_with_http_info variant
|
763
|
+
|
764
|
+
This returns an Array which contains the response data, status code and headers.
|
611
765
|
|
766
|
+
> <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(container_container_distribution_href, set_label)
|
612
767
|
|
613
|
-
|
614
|
-
|
615
|
-
|
616
|
-
|
768
|
+
```ruby
|
769
|
+
begin
|
770
|
+
# Set a label
|
771
|
+
data, status_code, headers = api_instance.set_label_with_http_info(container_container_distribution_href, set_label)
|
772
|
+
p status_code # => 2xx
|
773
|
+
p headers # => { ... }
|
774
|
+
p data # => <SetLabelResponse>
|
775
|
+
rescue PulpContainerClient::ApiError => e
|
776
|
+
puts "Error when calling DistributionsContainerApi->set_label_with_http_info: #{e}"
|
777
|
+
end
|
778
|
+
```
|
779
|
+
|
780
|
+
### Parameters
|
781
|
+
|
782
|
+
| Name | Type | Description | Notes |
|
783
|
+
| ---- | ---- | ----------- | ----- |
|
784
|
+
| **container_container_distribution_href** | **String** | | |
|
785
|
+
| **set_label** | [**SetLabel**](SetLabel.md) | | |
|
617
786
|
|
618
787
|
### Return type
|
619
788
|
|
@@ -631,16 +800,16 @@ Name | Type | Description | Notes
|
|
631
800
|
|
632
801
|
## unset_label
|
633
802
|
|
634
|
-
> UnsetLabelResponse unset_label(container_container_distribution_href, unset_label)
|
803
|
+
> <UnsetLabelResponse> unset_label(container_container_distribution_href, unset_label)
|
635
804
|
|
636
805
|
Unset a label
|
637
806
|
|
638
807
|
Unset a single pulp_label on the object.
|
639
808
|
|
640
|
-
###
|
809
|
+
### Examples
|
641
810
|
|
642
811
|
```ruby
|
643
|
-
|
812
|
+
require 'time'
|
644
813
|
require 'pulp_container_client'
|
645
814
|
# setup authorization
|
646
815
|
PulpContainerClient.configure do |config|
|
@@ -651,24 +820,41 @@ end
|
|
651
820
|
|
652
821
|
api_instance = PulpContainerClient::DistributionsContainerApi.new
|
653
822
|
container_container_distribution_href = 'container_container_distribution_href_example' # String |
|
654
|
-
unset_label = PulpContainerClient::UnsetLabel.new # UnsetLabel |
|
823
|
+
unset_label = PulpContainerClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
|
655
824
|
|
656
825
|
begin
|
657
|
-
#Unset a label
|
826
|
+
# Unset a label
|
658
827
|
result = api_instance.unset_label(container_container_distribution_href, unset_label)
|
659
828
|
p result
|
660
829
|
rescue PulpContainerClient::ApiError => e
|
661
|
-
puts "
|
830
|
+
puts "Error when calling DistributionsContainerApi->unset_label: #{e}"
|
662
831
|
end
|
663
832
|
```
|
664
833
|
|
665
|
-
|
834
|
+
#### Using the unset_label_with_http_info variant
|
835
|
+
|
836
|
+
This returns an Array which contains the response data, status code and headers.
|
837
|
+
|
838
|
+
> <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(container_container_distribution_href, unset_label)
|
839
|
+
|
840
|
+
```ruby
|
841
|
+
begin
|
842
|
+
# Unset a label
|
843
|
+
data, status_code, headers = api_instance.unset_label_with_http_info(container_container_distribution_href, unset_label)
|
844
|
+
p status_code # => 2xx
|
845
|
+
p headers # => { ... }
|
846
|
+
p data # => <UnsetLabelResponse>
|
847
|
+
rescue PulpContainerClient::ApiError => e
|
848
|
+
puts "Error when calling DistributionsContainerApi->unset_label_with_http_info: #{e}"
|
849
|
+
end
|
850
|
+
```
|
666
851
|
|
852
|
+
### Parameters
|
667
853
|
|
668
|
-
Name | Type | Description
|
669
|
-
|
670
|
-
**container_container_distribution_href** | **String
|
671
|
-
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
|
854
|
+
| Name | Type | Description | Notes |
|
855
|
+
| ---- | ---- | ----------- | ----- |
|
856
|
+
| **container_container_distribution_href** | **String** | | |
|
857
|
+
| **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
|
672
858
|
|
673
859
|
### Return type
|
674
860
|
|
@@ -686,16 +872,16 @@ Name | Type | Description | Notes
|
|
686
872
|
|
687
873
|
## update
|
688
874
|
|
689
|
-
> AsyncOperationResponse update(container_container_distribution_href, container_container_distribution)
|
875
|
+
> <AsyncOperationResponse> update(container_container_distribution_href, container_container_distribution)
|
690
876
|
|
691
877
|
Update a container distribution
|
692
878
|
|
693
879
|
Trigger an asynchronous update task
|
694
880
|
|
695
|
-
###
|
881
|
+
### Examples
|
696
882
|
|
697
883
|
```ruby
|
698
|
-
|
884
|
+
require 'time'
|
699
885
|
require 'pulp_container_client'
|
700
886
|
# setup authorization
|
701
887
|
PulpContainerClient.configure do |config|
|
@@ -706,24 +892,41 @@ end
|
|
706
892
|
|
707
893
|
api_instance = PulpContainerClient::DistributionsContainerApi.new
|
708
894
|
container_container_distribution_href = 'container_container_distribution_href_example' # String |
|
709
|
-
container_container_distribution = PulpContainerClient::ContainerContainerDistribution.new # ContainerContainerDistribution |
|
895
|
+
container_container_distribution = PulpContainerClient::ContainerContainerDistribution.new({base_path: 'base_path_example', name: 'name_example'}) # ContainerContainerDistribution |
|
710
896
|
|
711
897
|
begin
|
712
|
-
#Update a container distribution
|
898
|
+
# Update a container distribution
|
713
899
|
result = api_instance.update(container_container_distribution_href, container_container_distribution)
|
714
900
|
p result
|
715
901
|
rescue PulpContainerClient::ApiError => e
|
716
|
-
puts "
|
902
|
+
puts "Error when calling DistributionsContainerApi->update: #{e}"
|
717
903
|
end
|
718
904
|
```
|
719
905
|
|
720
|
-
|
906
|
+
#### Using the update_with_http_info variant
|
907
|
+
|
908
|
+
This returns an Array which contains the response data, status code and headers.
|
909
|
+
|
910
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> update_with_http_info(container_container_distribution_href, container_container_distribution)
|
721
911
|
|
912
|
+
```ruby
|
913
|
+
begin
|
914
|
+
# Update a container distribution
|
915
|
+
data, status_code, headers = api_instance.update_with_http_info(container_container_distribution_href, container_container_distribution)
|
916
|
+
p status_code # => 2xx
|
917
|
+
p headers # => { ... }
|
918
|
+
p data # => <AsyncOperationResponse>
|
919
|
+
rescue PulpContainerClient::ApiError => e
|
920
|
+
puts "Error when calling DistributionsContainerApi->update_with_http_info: #{e}"
|
921
|
+
end
|
922
|
+
```
|
923
|
+
|
924
|
+
### Parameters
|
722
925
|
|
723
|
-
Name | Type | Description
|
724
|
-
|
725
|
-
**container_container_distribution_href** | **String
|
726
|
-
**container_container_distribution** | [**ContainerContainerDistribution**](ContainerContainerDistribution.md)| |
|
926
|
+
| Name | Type | Description | Notes |
|
927
|
+
| ---- | ---- | ----------- | ----- |
|
928
|
+
| **container_container_distribution_href** | **String** | | |
|
929
|
+
| **container_container_distribution** | [**ContainerContainerDistribution**](ContainerContainerDistribution.md) | | |
|
727
930
|
|
728
931
|
### Return type
|
729
932
|
|