pulp_container_client 2.22.1 → 2.23.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +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 +86 -74
- 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 +88 -74
- 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 +83 -73
- data/lib/pulp_container_client/models/container_container_push_repository_response.rb +91 -81
- 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 +81 -65
- data/lib/pulp_container_client/models/patchedcontainer_container_pull_through_distribution.rb +81 -65
- 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 +77 -65
- 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 +28 -33
- data/spec/models/container_container_push_repository_spec.rb +15 -20
- 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 +15 -20
- 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,25 +2,24 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost:24817*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**list**](ContentSignaturesApi.md#list) | **GET** /pulp/api/v3/content/container/signatures/ | List manifest signatures
|
8
|
-
[**read**](ContentSignaturesApi.md#read) | **GET** {container_manifest_signature_href} | Inspect a manifest signature
|
9
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**list**](ContentSignaturesApi.md#list) | **GET** /pulp/api/v3/content/container/signatures/ | List manifest signatures |
|
8
|
+
| [**read**](ContentSignaturesApi.md#read) | **GET** {container_manifest_signature_href} | Inspect a manifest signature |
|
10
9
|
|
11
10
|
|
12
11
|
## list
|
13
12
|
|
14
|
-
> PaginatedcontainerManifestSignatureResponseList list(opts)
|
13
|
+
> <PaginatedcontainerManifestSignatureResponseList> list(opts)
|
15
14
|
|
16
15
|
List manifest signatures
|
17
16
|
|
18
17
|
ViewSet for image signatures.
|
19
18
|
|
20
|
-
###
|
19
|
+
### Examples
|
21
20
|
|
22
21
|
```ruby
|
23
|
-
|
22
|
+
require 'time'
|
24
23
|
require 'pulp_container_client'
|
25
24
|
# setup authorization
|
26
25
|
PulpContainerClient.configure do |config|
|
@@ -32,75 +31,92 @@ end
|
|
32
31
|
api_instance = PulpContainerClient::ContentSignaturesApi.new
|
33
32
|
opts = {
|
34
33
|
digest: 'digest_example', # String | Filter results where digest matches value
|
35
|
-
digest__in: ['
|
34
|
+
digest__in: ['inner_example'], # Array<String> | Filter results where digest is in a comma-separated list of values
|
36
35
|
key_id: 'key_id_example', # String | Filter results where key_id matches value
|
37
|
-
key_id__in: ['
|
36
|
+
key_id__in: ['inner_example'], # Array<String> | Filter results where key_id is in a comma-separated list of values
|
38
37
|
limit: 56, # Integer | Number of results to return per page.
|
39
|
-
manifest: ['
|
38
|
+
manifest: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
40
39
|
name: 'name_example', # String | Filter results where name matches value
|
41
40
|
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
42
41
|
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
43
42
|
name__iexact: 'name__iexact_example', # String | Filter results where name matches value
|
44
|
-
name__in: ['
|
43
|
+
name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
45
44
|
name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
|
46
45
|
name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
|
47
46
|
name__regex: 'name__regex_example', # String | Filter results where name matches regex value
|
48
47
|
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
49
48
|
offset: 56, # Integer | The initial index from which to return the results.
|
50
|
-
ordering: ['
|
51
|
-
orphaned_for:
|
52
|
-
prn__in: ['
|
53
|
-
pulp_href__in: ['
|
54
|
-
pulp_id__in: ['
|
49
|
+
ordering: ['-creator'], # 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) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `name` - Name * `-name` - Name (descending) * `digest` - Digest * `-digest` - Digest (descending) * `type` - Type * `-type` - Type (descending) * `key_id` - Key id * `-key_id` - Key id (descending) * `timestamp` - Timestamp * `-timestamp` - Timestamp (descending) * `creator` - Creator * `-creator` - Creator (descending) * `data` - Data * `-data` - Data (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
50
|
+
orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
|
51
|
+
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
52
|
+
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
53
|
+
pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
55
54
|
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
56
55
|
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF/PRN
|
57
56
|
repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF/PRN
|
58
57
|
repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF/PRN
|
59
|
-
fields: ['
|
60
|
-
exclude_fields: ['
|
58
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
59
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
61
60
|
}
|
62
61
|
|
63
62
|
begin
|
64
|
-
#List manifest signatures
|
63
|
+
# List manifest signatures
|
65
64
|
result = api_instance.list(opts)
|
66
65
|
p result
|
67
66
|
rescue PulpContainerClient::ApiError => e
|
68
|
-
puts "
|
67
|
+
puts "Error when calling ContentSignaturesApi->list: #{e}"
|
69
68
|
end
|
70
69
|
```
|
71
70
|
|
72
|
-
|
71
|
+
#### Using the list_with_http_info variant
|
72
|
+
|
73
|
+
This returns an Array which contains the response data, status code and headers.
|
73
74
|
|
75
|
+
> <Array(<PaginatedcontainerManifestSignatureResponseList>, Integer, Hash)> list_with_http_info(opts)
|
76
|
+
|
77
|
+
```ruby
|
78
|
+
begin
|
79
|
+
# List manifest signatures
|
80
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
81
|
+
p status_code # => 2xx
|
82
|
+
p headers # => { ... }
|
83
|
+
p data # => <PaginatedcontainerManifestSignatureResponseList>
|
84
|
+
rescue PulpContainerClient::ApiError => e
|
85
|
+
puts "Error when calling ContentSignaturesApi->list_with_http_info: #{e}"
|
86
|
+
end
|
87
|
+
```
|
88
|
+
|
89
|
+
### Parameters
|
74
90
|
|
75
|
-
Name | Type | Description
|
76
|
-
|
77
|
-
**digest** | **String
|
78
|
-
**digest__in** | [**Array<String>**](String.md)| Filter results where digest is in a comma-separated list of values | [optional]
|
79
|
-
**key_id** | **String
|
80
|
-
**key_id__in** | [**Array<String>**](String.md)| Filter results where key_id is in a comma-separated list of values | [optional]
|
81
|
-
**limit** | **Integer
|
82
|
-
**manifest** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
83
|
-
**name** | **String
|
84
|
-
**name__contains** | **String
|
85
|
-
**name__icontains** | **String
|
86
|
-
**name__iexact** | **String
|
87
|
-
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
88
|
-
**name__iregex** | **String
|
89
|
-
**name__istartswith** | **String
|
90
|
-
**name__regex** | **String
|
91
|
-
**name__startswith** | **String
|
92
|
-
**offset** | **Integer
|
93
|
-
**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) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `name` - Name * `-name` - Name (descending) * `digest` - Digest * `-digest` - Digest (descending) * `type` - Type * `-type` - Type (descending) * `key_id` - Key id * `-key_id` - Key id (descending) * `timestamp` - Timestamp * `-timestamp` - Timestamp (descending) * `creator` - Creator * `-creator` - Creator (descending) * `data` - Data * `-data` - Data (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
|
94
|
-
**orphaned_for** | **Float
|
95
|
-
**prn__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
96
|
-
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
97
|
-
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
98
|
-
**q** | **String
|
99
|
-
**repository_version** | **String
|
100
|
-
**repository_version_added** | **String
|
101
|
-
**repository_version_removed** | **String
|
102
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
103
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
91
|
+
| Name | Type | Description | Notes |
|
92
|
+
| ---- | ---- | ----------- | ----- |
|
93
|
+
| **digest** | **String** | Filter results where digest matches value | [optional] |
|
94
|
+
| **digest__in** | [**Array<String>**](String.md) | Filter results where digest is in a comma-separated list of values | [optional] |
|
95
|
+
| **key_id** | **String** | Filter results where key_id matches value | [optional] |
|
96
|
+
| **key_id__in** | [**Array<String>**](String.md) | Filter results where key_id is in a comma-separated list of values | [optional] |
|
97
|
+
| **limit** | **Integer** | Number of results to return per page. | [optional] |
|
98
|
+
| **manifest** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
99
|
+
| **name** | **String** | Filter results where name matches value | [optional] |
|
100
|
+
| **name__contains** | **String** | Filter results where name contains value | [optional] |
|
101
|
+
| **name__icontains** | **String** | Filter results where name contains value | [optional] |
|
102
|
+
| **name__iexact** | **String** | Filter results where name matches value | [optional] |
|
103
|
+
| **name__in** | [**Array<String>**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
|
104
|
+
| **name__iregex** | **String** | Filter results where name matches regex value | [optional] |
|
105
|
+
| **name__istartswith** | **String** | Filter results where name starts with value | [optional] |
|
106
|
+
| **name__regex** | **String** | Filter results where name matches regex value | [optional] |
|
107
|
+
| **name__startswith** | **String** | Filter results where name starts with value | [optional] |
|
108
|
+
| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
|
109
|
+
| **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) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `name` - Name * `-name` - Name (descending) * `digest` - Digest * `-digest` - Digest (descending) * `type` - Type * `-type` - Type (descending) * `key_id` - Key id * `-key_id` - Key id (descending) * `timestamp` - Timestamp * `-timestamp` - Timestamp (descending) * `creator` - Creator * `-creator` - Creator (descending) * `data` - Data * `-data` - Data (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
110
|
+
| **orphaned_for** | **Float** | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] |
|
111
|
+
| **prn__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
112
|
+
| **pulp_href__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
113
|
+
| **pulp_id__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
114
|
+
| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
|
115
|
+
| **repository_version** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
116
|
+
| **repository_version_added** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
117
|
+
| **repository_version_removed** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
118
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
119
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
104
120
|
|
105
121
|
### Return type
|
106
122
|
|
@@ -118,16 +134,16 @@ Name | Type | Description | Notes
|
|
118
134
|
|
119
135
|
## read
|
120
136
|
|
121
|
-
> ContainerManifestSignatureResponse read(container_manifest_signature_href, opts)
|
137
|
+
> <ContainerManifestSignatureResponse> read(container_manifest_signature_href, opts)
|
122
138
|
|
123
139
|
Inspect a manifest signature
|
124
140
|
|
125
141
|
ViewSet for image signatures.
|
126
142
|
|
127
|
-
###
|
143
|
+
### Examples
|
128
144
|
|
129
145
|
```ruby
|
130
|
-
|
146
|
+
require 'time'
|
131
147
|
require 'pulp_container_client'
|
132
148
|
# setup authorization
|
133
149
|
PulpContainerClient.configure do |config|
|
@@ -139,27 +155,44 @@ end
|
|
139
155
|
api_instance = PulpContainerClient::ContentSignaturesApi.new
|
140
156
|
container_manifest_signature_href = 'container_manifest_signature_href_example' # String |
|
141
157
|
opts = {
|
142
|
-
fields: ['
|
143
|
-
exclude_fields: ['
|
158
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
159
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
144
160
|
}
|
145
161
|
|
146
162
|
begin
|
147
|
-
#Inspect a manifest signature
|
163
|
+
# Inspect a manifest signature
|
148
164
|
result = api_instance.read(container_manifest_signature_href, opts)
|
149
165
|
p result
|
150
166
|
rescue PulpContainerClient::ApiError => e
|
151
|
-
puts "
|
167
|
+
puts "Error when calling ContentSignaturesApi->read: #{e}"
|
152
168
|
end
|
153
169
|
```
|
154
170
|
|
155
|
-
|
171
|
+
#### Using the read_with_http_info variant
|
172
|
+
|
173
|
+
This returns an Array which contains the response data, status code and headers.
|
174
|
+
|
175
|
+
> <Array(<ContainerManifestSignatureResponse>, Integer, Hash)> read_with_http_info(container_manifest_signature_href, opts)
|
176
|
+
|
177
|
+
```ruby
|
178
|
+
begin
|
179
|
+
# Inspect a manifest signature
|
180
|
+
data, status_code, headers = api_instance.read_with_http_info(container_manifest_signature_href, opts)
|
181
|
+
p status_code # => 2xx
|
182
|
+
p headers # => { ... }
|
183
|
+
p data # => <ContainerManifestSignatureResponse>
|
184
|
+
rescue PulpContainerClient::ApiError => e
|
185
|
+
puts "Error when calling ContentSignaturesApi->read_with_http_info: #{e}"
|
186
|
+
end
|
187
|
+
```
|
156
188
|
|
189
|
+
### Parameters
|
157
190
|
|
158
|
-
Name | Type | Description
|
159
|
-
|
160
|
-
**container_manifest_signature_href** | **String
|
161
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
162
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
191
|
+
| Name | Type | Description | Notes |
|
192
|
+
| ---- | ---- | ----------- | ----- |
|
193
|
+
| **container_manifest_signature_href** | **String** | | |
|
194
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
195
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
163
196
|
|
164
197
|
### Return type
|
165
198
|
|
@@ -2,20 +2,21 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**added** | **Hash<String, Object>** | |
|
8
|
-
**removed** | **Hash<String, Object>** | |
|
9
|
-
**present** | **Hash<String, Object>** | |
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **added** | **Hash<String, Object>** | | |
|
8
|
+
| **removed** | **Hash<String, Object>** | | |
|
9
|
+
| **present** | **Hash<String, Object>** | | |
|
10
10
|
|
11
|
-
##
|
11
|
+
## Example
|
12
12
|
|
13
13
|
```ruby
|
14
|
-
require '
|
14
|
+
require 'pulp_container_client'
|
15
15
|
|
16
|
-
instance = PulpContainerClient::ContentSummaryResponse.new(
|
17
|
-
|
18
|
-
|
16
|
+
instance = PulpContainerClient::ContentSummaryResponse.new(
|
17
|
+
added: null,
|
18
|
+
removed: null,
|
19
|
+
present: null
|
20
|
+
)
|
19
21
|
```
|
20
22
|
|
21
|
-
|
data/docs/ContentTagsApi.md
CHANGED
@@ -2,25 +2,24 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost:24817*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**list**](ContentTagsApi.md#list) | **GET** /pulp/api/v3/content/container/tags/ | List tags
|
8
|
-
[**read**](ContentTagsApi.md#read) | **GET** {container_tag_href} | Inspect a tag
|
9
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**list**](ContentTagsApi.md#list) | **GET** /pulp/api/v3/content/container/tags/ | List tags |
|
8
|
+
| [**read**](ContentTagsApi.md#read) | **GET** {container_tag_href} | Inspect a tag |
|
10
9
|
|
11
10
|
|
12
11
|
## list
|
13
12
|
|
14
|
-
> PaginatedcontainerTagResponseList list(opts)
|
13
|
+
> <PaginatedcontainerTagResponseList> list(opts)
|
15
14
|
|
16
15
|
List tags
|
17
16
|
|
18
17
|
ViewSet for Tag.
|
19
18
|
|
20
|
-
###
|
19
|
+
### Examples
|
21
20
|
|
22
21
|
```ruby
|
23
|
-
|
22
|
+
require 'time'
|
24
23
|
require 'pulp_container_client'
|
25
24
|
# setup authorization
|
26
25
|
PulpContainerClient.configure do |config|
|
@@ -31,56 +30,73 @@ end
|
|
31
30
|
|
32
31
|
api_instance = PulpContainerClient::ContentTagsApi.new
|
33
32
|
opts = {
|
34
|
-
digest: ['
|
33
|
+
digest: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
35
34
|
limit: 56, # Integer | Number of results to return per page.
|
36
|
-
media_type: ['
|
35
|
+
media_type: ['application/vnd.docker.distribution.manifest.list.v2+json'], # Array<String> | * `application/vnd.docker.distribution.manifest.v1+json` - application/vnd.docker.distribution.manifest.v1+json * `application/vnd.docker.distribution.manifest.v2+json` - application/vnd.docker.distribution.manifest.v2+json * `application/vnd.docker.distribution.manifest.list.v2+json` - application/vnd.docker.distribution.manifest.list.v2+json * `application/vnd.oci.image.manifest.v1+json` - application/vnd.oci.image.manifest.v1+json * `application/vnd.oci.image.index.v1+json` - application/vnd.oci.image.index.v1+json
|
37
36
|
name: 'name_example', # String | Filter results where name matches value
|
38
|
-
name__in: ['
|
37
|
+
name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
39
38
|
offset: 56, # Integer | The initial index from which to return the results.
|
40
|
-
ordering: ['
|
41
|
-
orphaned_for:
|
42
|
-
prn__in: ['
|
43
|
-
pulp_href__in: ['
|
44
|
-
pulp_id__in: ['
|
39
|
+
ordering: ['-name'], # 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) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `name` - Name * `-name` - Name (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
40
|
+
orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
|
41
|
+
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
42
|
+
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
43
|
+
pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
45
44
|
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
46
45
|
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF/PRN
|
47
46
|
repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF/PRN
|
48
47
|
repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF/PRN
|
49
|
-
fields: ['
|
50
|
-
exclude_fields: ['
|
48
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
49
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
51
50
|
}
|
52
51
|
|
53
52
|
begin
|
54
|
-
#List tags
|
53
|
+
# List tags
|
55
54
|
result = api_instance.list(opts)
|
56
55
|
p result
|
57
56
|
rescue PulpContainerClient::ApiError => e
|
58
|
-
puts "
|
57
|
+
puts "Error when calling ContentTagsApi->list: #{e}"
|
59
58
|
end
|
60
59
|
```
|
61
60
|
|
62
|
-
|
61
|
+
#### Using the list_with_http_info variant
|
62
|
+
|
63
|
+
This returns an Array which contains the response data, status code and headers.
|
63
64
|
|
65
|
+
> <Array(<PaginatedcontainerTagResponseList>, Integer, Hash)> list_with_http_info(opts)
|
66
|
+
|
67
|
+
```ruby
|
68
|
+
begin
|
69
|
+
# List tags
|
70
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
71
|
+
p status_code # => 2xx
|
72
|
+
p headers # => { ... }
|
73
|
+
p data # => <PaginatedcontainerTagResponseList>
|
74
|
+
rescue PulpContainerClient::ApiError => e
|
75
|
+
puts "Error when calling ContentTagsApi->list_with_http_info: #{e}"
|
76
|
+
end
|
77
|
+
```
|
78
|
+
|
79
|
+
### Parameters
|
64
80
|
|
65
|
-
Name | Type | Description
|
66
|
-
|
67
|
-
**digest** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
68
|
-
**limit** | **Integer
|
69
|
-
**media_type** | [**Array<String>**](String.md)| * `application/vnd.docker.distribution.manifest.v1+json` - application/vnd.docker.distribution.manifest.v1+json * `application/vnd.docker.distribution.manifest.v2+json` - application/vnd.docker.distribution.manifest.v2+json * `application/vnd.docker.distribution.manifest.list.v2+json` - application/vnd.docker.distribution.manifest.list.v2+json * `application/vnd.oci.image.manifest.v1+json` - application/vnd.oci.image.manifest.v1+json * `application/vnd.oci.image.index.v1+json` - application/vnd.oci.image.index.v1+json | [optional]
|
70
|
-
**name** | **String
|
71
|
-
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
72
|
-
**offset** | **Integer
|
73
|
-
**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) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `name` - Name * `-name` - Name (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
|
74
|
-
**orphaned_for** | **Float
|
75
|
-
**prn__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
76
|
-
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
77
|
-
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
78
|
-
**q** | **String
|
79
|
-
**repository_version** | **String
|
80
|
-
**repository_version_added** | **String
|
81
|
-
**repository_version_removed** | **String
|
82
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
83
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
81
|
+
| Name | Type | Description | Notes |
|
82
|
+
| ---- | ---- | ----------- | ----- |
|
83
|
+
| **digest** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
84
|
+
| **limit** | **Integer** | Number of results to return per page. | [optional] |
|
85
|
+
| **media_type** | [**Array<String>**](String.md) | * `application/vnd.docker.distribution.manifest.v1+json` - application/vnd.docker.distribution.manifest.v1+json * `application/vnd.docker.distribution.manifest.v2+json` - application/vnd.docker.distribution.manifest.v2+json * `application/vnd.docker.distribution.manifest.list.v2+json` - application/vnd.docker.distribution.manifest.list.v2+json * `application/vnd.oci.image.manifest.v1+json` - application/vnd.oci.image.manifest.v1+json * `application/vnd.oci.image.index.v1+json` - application/vnd.oci.image.index.v1+json | [optional] |
|
86
|
+
| **name** | **String** | Filter results where name matches value | [optional] |
|
87
|
+
| **name__in** | [**Array<String>**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
|
88
|
+
| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
|
89
|
+
| **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) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `name` - Name * `-name` - Name (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
90
|
+
| **orphaned_for** | **Float** | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] |
|
91
|
+
| **prn__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
92
|
+
| **pulp_href__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
93
|
+
| **pulp_id__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
94
|
+
| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
|
95
|
+
| **repository_version** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
96
|
+
| **repository_version_added** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
97
|
+
| **repository_version_removed** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
98
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
99
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
84
100
|
|
85
101
|
### Return type
|
86
102
|
|
@@ -98,16 +114,16 @@ Name | Type | Description | Notes
|
|
98
114
|
|
99
115
|
## read
|
100
116
|
|
101
|
-
> ContainerTagResponse read(container_tag_href, opts)
|
117
|
+
> <ContainerTagResponse> read(container_tag_href, opts)
|
102
118
|
|
103
119
|
Inspect a tag
|
104
120
|
|
105
121
|
ViewSet for Tag.
|
106
122
|
|
107
|
-
###
|
123
|
+
### Examples
|
108
124
|
|
109
125
|
```ruby
|
110
|
-
|
126
|
+
require 'time'
|
111
127
|
require 'pulp_container_client'
|
112
128
|
# setup authorization
|
113
129
|
PulpContainerClient.configure do |config|
|
@@ -119,27 +135,44 @@ end
|
|
119
135
|
api_instance = PulpContainerClient::ContentTagsApi.new
|
120
136
|
container_tag_href = 'container_tag_href_example' # String |
|
121
137
|
opts = {
|
122
|
-
fields: ['
|
123
|
-
exclude_fields: ['
|
138
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
139
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
124
140
|
}
|
125
141
|
|
126
142
|
begin
|
127
|
-
#Inspect a tag
|
143
|
+
# Inspect a tag
|
128
144
|
result = api_instance.read(container_tag_href, opts)
|
129
145
|
p result
|
130
146
|
rescue PulpContainerClient::ApiError => e
|
131
|
-
puts "
|
147
|
+
puts "Error when calling ContentTagsApi->read: #{e}"
|
132
148
|
end
|
133
149
|
```
|
134
150
|
|
135
|
-
|
151
|
+
#### Using the read_with_http_info variant
|
152
|
+
|
153
|
+
This returns an Array which contains the response data, status code and headers.
|
154
|
+
|
155
|
+
> <Array(<ContainerTagResponse>, Integer, Hash)> read_with_http_info(container_tag_href, opts)
|
156
|
+
|
157
|
+
```ruby
|
158
|
+
begin
|
159
|
+
# Inspect a tag
|
160
|
+
data, status_code, headers = api_instance.read_with_http_info(container_tag_href, opts)
|
161
|
+
p status_code # => 2xx
|
162
|
+
p headers # => { ... }
|
163
|
+
p data # => <ContainerTagResponse>
|
164
|
+
rescue PulpContainerClient::ApiError => e
|
165
|
+
puts "Error when calling ContentTagsApi->read_with_http_info: #{e}"
|
166
|
+
end
|
167
|
+
```
|
136
168
|
|
169
|
+
### Parameters
|
137
170
|
|
138
|
-
Name | Type | Description
|
139
|
-
|
140
|
-
**container_tag_href** | **String
|
141
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
142
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
171
|
+
| Name | Type | Description | Notes |
|
172
|
+
| ---- | ---- | ----------- | ----- |
|
173
|
+
| **container_tag_href** | **String** | | |
|
174
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
175
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
143
176
|
|
144
177
|
### Return type
|
145
178
|
|