pulp_ostree_client 2.4.5 → 2.4.6
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 +16 -12
- data/docs/AsyncOperationResponse.md +8 -7
- data/docs/ContentCommitsApi.md +80 -47
- data/docs/ContentConfigsApi.md +79 -46
- data/docs/ContentContentApi.md +107 -57
- data/docs/ContentObjectsApi.md +80 -47
- data/docs/ContentRefsApi.md +90 -57
- data/docs/ContentSummariesApi.md +79 -46
- data/docs/ContentSummaryResponse.md +12 -11
- data/docs/DistributionsOstreeApi.md +385 -182
- 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/OstreeImportAll.md +10 -9
- data/docs/OstreeImportCommitsToRef.md +12 -11
- data/docs/OstreeOstreeCommitResponse.md +24 -23
- data/docs/OstreeOstreeConfigResponse.md +18 -17
- data/docs/OstreeOstreeContent.md +14 -13
- data/docs/OstreeOstreeContentResponse.md +20 -19
- data/docs/OstreeOstreeDistribution.md +20 -19
- data/docs/OstreeOstreeDistributionResponse.md +32 -31
- data/docs/OstreeOstreeObjectResponse.md +22 -21
- data/docs/OstreeOstreeRefResponse.md +24 -23
- data/docs/OstreeOstreeRemote.md +54 -53
- data/docs/OstreeOstreeRemoteResponse.md +54 -53
- data/docs/OstreeOstreeRemoteResponseHiddenFieldsInner.md +20 -0
- data/docs/OstreeOstreeRepository.md +18 -17
- data/docs/OstreeOstreeRepositoryResponse.md +30 -29
- data/docs/OstreeOstreeSummaryResponse.md +18 -17
- data/docs/PaginatedRepositoryVersionResponseList.md +14 -13
- data/docs/PaginatedostreeOstreeCommitResponseList.md +14 -13
- data/docs/PaginatedostreeOstreeConfigResponseList.md +14 -13
- data/docs/PaginatedostreeOstreeContentResponseList.md +14 -13
- data/docs/PaginatedostreeOstreeDistributionResponseList.md +14 -13
- data/docs/PaginatedostreeOstreeObjectResponseList.md +14 -13
- data/docs/PaginatedostreeOstreeRefResponseList.md +14 -13
- data/docs/PaginatedostreeOstreeRemoteResponseList.md +14 -13
- data/docs/PaginatedostreeOstreeRepositoryResponseList.md +14 -13
- data/docs/PaginatedostreeOstreeSummaryResponseList.md +14 -13
- data/docs/PatchedostreeOstreeDistribution.md +20 -19
- data/docs/PatchedostreeOstreeRemote.md +54 -53
- data/docs/PatchedostreeOstreeRepository.md +18 -17
- data/docs/PolicyEnum.md +4 -5
- data/docs/RemotesOstreeApi.md +389 -184
- data/docs/Repair.md +8 -7
- data/docs/RepositoriesOstreeApi.md +502 -231
- data/docs/RepositoriesOstreeVersionsApi.md +152 -82
- data/docs/RepositoryAddRemoveContent.md +12 -11
- data/docs/RepositorySyncURL.md +10 -9
- data/docs/RepositoryVersionResponse.md +22 -21
- data/docs/SetLabel.md +10 -9
- data/docs/SetLabelResponse.md +10 -9
- data/docs/UnsetLabel.md +8 -7
- data/docs/UnsetLabelResponse.md +10 -9
- data/lib/pulp_ostree_client/api/content_commits_api.rb +11 -9
- data/lib/pulp_ostree_client/api/content_configs_api.rb +11 -9
- data/lib/pulp_ostree_client/api/content_content_api.rb +20 -14
- data/lib/pulp_ostree_client/api/content_objects_api.rb +11 -9
- data/lib/pulp_ostree_client/api/content_refs_api.rb +11 -9
- data/lib/pulp_ostree_client/api/content_summaries_api.rb +11 -9
- data/lib/pulp_ostree_client/api/distributions_ostree_api.rb +89 -56
- data/lib/pulp_ostree_client/api/remotes_ostree_api.rb +104 -68
- data/lib/pulp_ostree_client/api/repositories_ostree_api.rb +125 -76
- data/lib/pulp_ostree_client/api/repositories_ostree_versions_api.rb +40 -30
- data/lib/pulp_ostree_client/api_client.rb +137 -102
- data/lib/pulp_ostree_client/api_error.rb +2 -1
- data/lib/pulp_ostree_client/configuration.rb +162 -21
- data/lib/pulp_ostree_client/models/async_operation_response.rb +32 -22
- data/lib/pulp_ostree_client/models/content_summary_response.rb +36 -22
- data/lib/pulp_ostree_client/models/my_permissions_response.rb +32 -22
- data/lib/pulp_ostree_client/models/nested_role.rb +32 -22
- data/lib/pulp_ostree_client/models/nested_role_response.rb +32 -22
- data/lib/pulp_ostree_client/models/object_roles_response.rb +32 -22
- data/lib/pulp_ostree_client/models/ostree_import_all.rb +34 -22
- data/lib/pulp_ostree_client/models/ostree_import_commits_to_ref.rb +36 -22
- data/lib/pulp_ostree_client/models/ostree_ostree_commit_response.rb +40 -24
- data/lib/pulp_ostree_client/models/ostree_ostree_config_response.rb +36 -24
- data/lib/pulp_ostree_client/models/ostree_ostree_content.rb +36 -22
- data/lib/pulp_ostree_client/models/ostree_ostree_content_response.rb +38 -24
- data/lib/pulp_ostree_client/models/ostree_ostree_distribution.rb +34 -22
- data/lib/pulp_ostree_client/models/ostree_ostree_distribution_response.rb +36 -24
- data/lib/pulp_ostree_client/models/ostree_ostree_object_response.rb +40 -24
- data/lib/pulp_ostree_client/models/ostree_ostree_ref_response.rb +40 -24
- data/lib/pulp_ostree_client/models/ostree_ostree_remote.rb +61 -23
- data/lib/pulp_ostree_client/models/ostree_ostree_remote_response.rb +64 -26
- data/lib/pulp_ostree_client/models/{ostree_ostree_remote_response_hidden_fields.rb → ostree_ostree_remote_response_hidden_fields_inner.rb} +37 -25
- data/lib/pulp_ostree_client/models/ostree_ostree_repository.rb +32 -22
- data/lib/pulp_ostree_client/models/ostree_ostree_repository_response.rb +34 -24
- data/lib/pulp_ostree_client/models/ostree_ostree_summary_response.rb +36 -24
- data/lib/pulp_ostree_client/models/paginated_repository_version_response_list.rb +34 -22
- data/lib/pulp_ostree_client/models/paginatedostree_ostree_commit_response_list.rb +34 -22
- data/lib/pulp_ostree_client/models/paginatedostree_ostree_config_response_list.rb +34 -22
- data/lib/pulp_ostree_client/models/paginatedostree_ostree_content_response_list.rb +34 -22
- data/lib/pulp_ostree_client/models/paginatedostree_ostree_distribution_response_list.rb +34 -22
- data/lib/pulp_ostree_client/models/paginatedostree_ostree_object_response_list.rb +34 -22
- data/lib/pulp_ostree_client/models/paginatedostree_ostree_ref_response_list.rb +34 -22
- data/lib/pulp_ostree_client/models/paginatedostree_ostree_remote_response_list.rb +34 -22
- data/lib/pulp_ostree_client/models/paginatedostree_ostree_repository_response_list.rb +34 -22
- data/lib/pulp_ostree_client/models/paginatedostree_ostree_summary_response_list.rb +34 -22
- data/lib/pulp_ostree_client/models/patchedostree_ostree_distribution.rb +40 -24
- data/lib/pulp_ostree_client/models/patchedostree_ostree_remote.rb +67 -25
- data/lib/pulp_ostree_client/models/patchedostree_ostree_repository.rb +35 -23
- data/lib/pulp_ostree_client/models/policy_enum.rb +8 -4
- data/lib/pulp_ostree_client/models/repair.rb +30 -22
- data/lib/pulp_ostree_client/models/repository_add_remove_content.rb +30 -22
- data/lib/pulp_ostree_client/models/repository_sync_url.rb +30 -22
- data/lib/pulp_ostree_client/models/repository_version_response.rb +32 -24
- data/lib/pulp_ostree_client/models/set_label.rb +34 -22
- data/lib/pulp_ostree_client/models/set_label_response.rb +34 -22
- data/lib/pulp_ostree_client/models/unset_label.rb +32 -22
- data/lib/pulp_ostree_client/models/unset_label_response.rb +32 -22
- data/lib/pulp_ostree_client/version.rb +2 -2
- data/lib/pulp_ostree_client.rb +2 -2
- data/pulp_ostree_client.gemspec +9 -6
- data/spec/api/content_commits_api_spec.rb +3 -3
- data/spec/api/content_configs_api_spec.rb +3 -3
- data/spec/api/content_content_api_spec.rb +4 -4
- data/spec/api/content_objects_api_spec.rb +3 -3
- data/spec/api/content_refs_api_spec.rb +3 -3
- data/spec/api/content_summaries_api_spec.rb +3 -3
- data/spec/api/distributions_ostree_api_spec.rb +13 -13
- data/spec/api/remotes_ostree_api_spec.rb +20 -19
- data/spec/api/repositories_ostree_api_spec.rb +17 -17
- data/spec/api/repositories_ostree_versions_api_spec.rb +12 -11
- data/spec/models/async_operation_response_spec.rb +7 -12
- data/spec/models/content_summary_response_spec.rb +9 -14
- 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/ostree_import_all_spec.rb +8 -13
- data/spec/models/ostree_import_commits_to_ref_spec.rb +9 -14
- data/spec/models/ostree_ostree_commit_response_spec.rb +15 -20
- data/spec/models/ostree_ostree_config_response_spec.rb +12 -17
- data/spec/models/ostree_ostree_content_response_spec.rb +13 -18
- data/spec/models/ostree_ostree_content_spec.rb +10 -15
- data/spec/models/ostree_ostree_distribution_response_spec.rb +19 -24
- data/spec/models/ostree_ostree_distribution_spec.rb +13 -18
- data/spec/models/ostree_ostree_object_response_spec.rb +14 -19
- data/spec/models/ostree_ostree_ref_response_spec.rb +15 -20
- data/spec/models/{ostree_ostree_remote_response_hidden_fields_spec.rb → ostree_ostree_remote_response_hidden_fields_inner_spec.rb} +11 -16
- data/spec/models/ostree_ostree_remote_response_spec.rb +30 -35
- data/spec/models/ostree_ostree_remote_spec.rb +30 -35
- data/spec/models/ostree_ostree_repository_response_spec.rb +18 -23
- data/spec/models/ostree_ostree_repository_spec.rb +12 -17
- data/spec/models/ostree_ostree_summary_response_spec.rb +12 -17
- data/spec/models/paginated_repository_version_response_list_spec.rb +10 -15
- data/spec/models/paginatedostree_ostree_commit_response_list_spec.rb +10 -15
- data/spec/models/paginatedostree_ostree_config_response_list_spec.rb +10 -15
- data/spec/models/paginatedostree_ostree_content_response_list_spec.rb +10 -15
- data/spec/models/paginatedostree_ostree_distribution_response_list_spec.rb +10 -15
- data/spec/models/paginatedostree_ostree_object_response_list_spec.rb +10 -15
- data/spec/models/paginatedostree_ostree_ref_response_list_spec.rb +10 -15
- data/spec/models/paginatedostree_ostree_remote_response_list_spec.rb +10 -15
- data/spec/models/paginatedostree_ostree_repository_response_list_spec.rb +10 -15
- data/spec/models/paginatedostree_ostree_summary_response_list_spec.rb +10 -15
- data/spec/models/patchedostree_ostree_distribution_spec.rb +13 -18
- data/spec/models/patchedostree_ostree_remote_spec.rb +30 -35
- data/spec/models/patchedostree_ostree_repository_spec.rb +12 -17
- data/spec/models/policy_enum_spec.rb +6 -11
- data/spec/models/repair_spec.rb +7 -12
- data/spec/models/repository_add_remove_content_spec.rb +9 -14
- data/spec/models/repository_sync_url_spec.rb +8 -13
- 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/unset_label_response_spec.rb +8 -13
- data/spec/models/unset_label_spec.rb +7 -12
- data/spec/spec_helper.rb +1 -1
- metadata +84 -60
- data/docs/OstreeOstreeRemoteResponseHiddenFields.md +0 -19
- data/spec/api_client_spec.rb +0 -188
- data/spec/configuration_spec.rb +0 -42
data/docs/ContentRefsApi.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**](ContentRefsApi.md#list) | **GET** /pulp/api/v3/content/ostree/refs/ | List ostree refs
|
8
|
-
[**read**](ContentRefsApi.md#read) | **GET** {ostree_ostree_ref_href} | Inspect an ostree ref
|
9
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**list**](ContentRefsApi.md#list) | **GET** /pulp/api/v3/content/ostree/refs/ | List ostree refs |
|
8
|
+
| [**read**](ContentRefsApi.md#read) | **GET** {ostree_ostree_ref_href} | Inspect an ostree ref |
|
10
9
|
|
11
10
|
|
12
11
|
## list
|
13
12
|
|
14
|
-
> PaginatedostreeOstreeRefResponseList list(opts)
|
13
|
+
> <PaginatedostreeOstreeRefResponseList> list(opts)
|
15
14
|
|
16
15
|
List ostree refs
|
17
16
|
|
18
17
|
A ViewSet class for OSTree head commits.
|
19
18
|
|
20
|
-
###
|
19
|
+
### Examples
|
21
20
|
|
22
21
|
```ruby
|
23
|
-
|
22
|
+
require 'time'
|
24
23
|
require 'pulp_ostree_client'
|
25
24
|
# setup authorization
|
26
25
|
PulpOstreeClient.configure do |config|
|
@@ -37,62 +36,79 @@ opts = {
|
|
37
36
|
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
38
37
|
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
39
38
|
name__iexact: 'name__iexact_example', # String | Filter results where name matches value
|
40
|
-
name__in: ['
|
39
|
+
name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
41
40
|
name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
|
42
41
|
name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
|
43
42
|
name__regex: 'name__regex_example', # String | Filter results where name matches regex value
|
44
43
|
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
45
44
|
offset: 56, # Integer | The initial index from which to return the results.
|
46
|
-
ordering: ['
|
47
|
-
orphaned_for:
|
48
|
-
prn__in: ['
|
49
|
-
pulp_href__in: ['
|
50
|
-
pulp_id__in: ['
|
45
|
+
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) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
46
|
+
orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
|
47
|
+
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
48
|
+
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
49
|
+
pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
51
50
|
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
52
51
|
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF/PRN
|
53
52
|
repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF/PRN
|
54
53
|
repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF/PRN
|
55
|
-
fields: ['
|
56
|
-
exclude_fields: ['
|
54
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
55
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
57
56
|
}
|
58
57
|
|
59
58
|
begin
|
60
|
-
#List ostree refs
|
59
|
+
# List ostree refs
|
61
60
|
result = api_instance.list(opts)
|
62
61
|
p result
|
63
62
|
rescue PulpOstreeClient::ApiError => e
|
64
|
-
puts "
|
63
|
+
puts "Error when calling ContentRefsApi->list: #{e}"
|
65
64
|
end
|
66
65
|
```
|
67
66
|
|
68
|
-
|
67
|
+
#### Using the list_with_http_info variant
|
68
|
+
|
69
|
+
This returns an Array which contains the response data, status code and headers.
|
69
70
|
|
71
|
+
> <Array(<PaginatedostreeOstreeRefResponseList>, Integer, Hash)> list_with_http_info(opts)
|
72
|
+
|
73
|
+
```ruby
|
74
|
+
begin
|
75
|
+
# List ostree refs
|
76
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
77
|
+
p status_code # => 2xx
|
78
|
+
p headers # => { ... }
|
79
|
+
p data # => <PaginatedostreeOstreeRefResponseList>
|
80
|
+
rescue PulpOstreeClient::ApiError => e
|
81
|
+
puts "Error when calling ContentRefsApi->list_with_http_info: #{e}"
|
82
|
+
end
|
83
|
+
```
|
84
|
+
|
85
|
+
### Parameters
|
70
86
|
|
71
|
-
Name | Type | Description
|
72
|
-
|
73
|
-
**checksum** | **String
|
74
|
-
**limit** | **Integer
|
75
|
-
**name** | **String
|
76
|
-
**name__contains** | **String
|
77
|
-
**name__icontains** | **String
|
78
|
-
**name__iexact** | **String
|
79
|
-
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
80
|
-
**name__iregex** | **String
|
81
|
-
**name__istartswith** | **String
|
82
|
-
**name__regex** | **String
|
83
|
-
**name__startswith** | **String
|
84
|
-
**offset** | **Integer
|
85
|
-
**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) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
|
86
|
-
**orphaned_for** | **Float
|
87
|
-
**prn__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
88
|
-
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
89
|
-
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
90
|
-
**q** | **String
|
91
|
-
**repository_version** | **String
|
92
|
-
**repository_version_added** | **String
|
93
|
-
**repository_version_removed** | **String
|
94
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
95
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
87
|
+
| Name | Type | Description | Notes |
|
88
|
+
| ---- | ---- | ----------- | ----- |
|
89
|
+
| **checksum** | **String** | | [optional] |
|
90
|
+
| **limit** | **Integer** | Number of results to return per page. | [optional] |
|
91
|
+
| **name** | **String** | Filter results where name matches value | [optional] |
|
92
|
+
| **name__contains** | **String** | Filter results where name contains value | [optional] |
|
93
|
+
| **name__icontains** | **String** | Filter results where name contains value | [optional] |
|
94
|
+
| **name__iexact** | **String** | Filter results where name matches value | [optional] |
|
95
|
+
| **name__in** | [**Array<String>**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
|
96
|
+
| **name__iregex** | **String** | Filter results where name matches regex value | [optional] |
|
97
|
+
| **name__istartswith** | **String** | Filter results where name starts with value | [optional] |
|
98
|
+
| **name__regex** | **String** | Filter results where name matches regex value | [optional] |
|
99
|
+
| **name__startswith** | **String** | Filter results where name starts with value | [optional] |
|
100
|
+
| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
|
101
|
+
| **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) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
102
|
+
| **orphaned_for** | **Float** | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] |
|
103
|
+
| **prn__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
104
|
+
| **pulp_href__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
105
|
+
| **pulp_id__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
106
|
+
| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
|
107
|
+
| **repository_version** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
108
|
+
| **repository_version_added** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
109
|
+
| **repository_version_removed** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
110
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
111
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
96
112
|
|
97
113
|
### Return type
|
98
114
|
|
@@ -110,16 +126,16 @@ Name | Type | Description | Notes
|
|
110
126
|
|
111
127
|
## read
|
112
128
|
|
113
|
-
> OstreeOstreeRefResponse read(ostree_ostree_ref_href, opts)
|
129
|
+
> <OstreeOstreeRefResponse> read(ostree_ostree_ref_href, opts)
|
114
130
|
|
115
131
|
Inspect an ostree ref
|
116
132
|
|
117
133
|
A ViewSet class for OSTree head commits.
|
118
134
|
|
119
|
-
###
|
135
|
+
### Examples
|
120
136
|
|
121
137
|
```ruby
|
122
|
-
|
138
|
+
require 'time'
|
123
139
|
require 'pulp_ostree_client'
|
124
140
|
# setup authorization
|
125
141
|
PulpOstreeClient.configure do |config|
|
@@ -131,27 +147,44 @@ end
|
|
131
147
|
api_instance = PulpOstreeClient::ContentRefsApi.new
|
132
148
|
ostree_ostree_ref_href = 'ostree_ostree_ref_href_example' # String |
|
133
149
|
opts = {
|
134
|
-
fields: ['
|
135
|
-
exclude_fields: ['
|
150
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
151
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
136
152
|
}
|
137
153
|
|
138
154
|
begin
|
139
|
-
#Inspect an ostree ref
|
155
|
+
# Inspect an ostree ref
|
140
156
|
result = api_instance.read(ostree_ostree_ref_href, opts)
|
141
157
|
p result
|
142
158
|
rescue PulpOstreeClient::ApiError => e
|
143
|
-
puts "
|
159
|
+
puts "Error when calling ContentRefsApi->read: #{e}"
|
144
160
|
end
|
145
161
|
```
|
146
162
|
|
147
|
-
|
163
|
+
#### Using the read_with_http_info variant
|
164
|
+
|
165
|
+
This returns an Array which contains the response data, status code and headers.
|
166
|
+
|
167
|
+
> <Array(<OstreeOstreeRefResponse>, Integer, Hash)> read_with_http_info(ostree_ostree_ref_href, opts)
|
168
|
+
|
169
|
+
```ruby
|
170
|
+
begin
|
171
|
+
# Inspect an ostree ref
|
172
|
+
data, status_code, headers = api_instance.read_with_http_info(ostree_ostree_ref_href, opts)
|
173
|
+
p status_code # => 2xx
|
174
|
+
p headers # => { ... }
|
175
|
+
p data # => <OstreeOstreeRefResponse>
|
176
|
+
rescue PulpOstreeClient::ApiError => e
|
177
|
+
puts "Error when calling ContentRefsApi->read_with_http_info: #{e}"
|
178
|
+
end
|
179
|
+
```
|
148
180
|
|
181
|
+
### Parameters
|
149
182
|
|
150
|
-
Name | Type | Description
|
151
|
-
|
152
|
-
**ostree_ostree_ref_href** | **String
|
153
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
154
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
183
|
+
| Name | Type | Description | Notes |
|
184
|
+
| ---- | ---- | ----------- | ----- |
|
185
|
+
| **ostree_ostree_ref_href** | **String** | | |
|
186
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
187
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
155
188
|
|
156
189
|
### Return type
|
157
190
|
|
data/docs/ContentSummariesApi.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**](ContentSummariesApi.md#list) | **GET** /pulp/api/v3/content/ostree/summaries/ | List ostree summarys
|
8
|
-
[**read**](ContentSummariesApi.md#read) | **GET** {ostree_ostree_summary_href} | Inspect an ostree summary
|
9
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**list**](ContentSummariesApi.md#list) | **GET** /pulp/api/v3/content/ostree/summaries/ | List ostree summarys |
|
8
|
+
| [**read**](ContentSummariesApi.md#read) | **GET** {ostree_ostree_summary_href} | Inspect an ostree summary |
|
10
9
|
|
11
10
|
|
12
11
|
## list
|
13
12
|
|
14
|
-
> PaginatedostreeOstreeSummaryResponseList list(opts)
|
13
|
+
> <PaginatedostreeOstreeSummaryResponseList> list(opts)
|
15
14
|
|
16
15
|
List ostree summarys
|
17
16
|
|
18
17
|
A ViewSet class for OSTree repository summary files.
|
19
18
|
|
20
|
-
###
|
19
|
+
### Examples
|
21
20
|
|
22
21
|
```ruby
|
23
|
-
|
22
|
+
require 'time'
|
24
23
|
require 'pulp_ostree_client'
|
25
24
|
# setup authorization
|
26
25
|
PulpOstreeClient.configure do |config|
|
@@ -33,46 +32,63 @@ api_instance = PulpOstreeClient::ContentSummariesApi.new
|
|
33
32
|
opts = {
|
34
33
|
limit: 56, # Integer | Number of results to return per page.
|
35
34
|
offset: 56, # Integer | The initial index from which to return the results.
|
36
|
-
ordering: ['
|
37
|
-
orphaned_for:
|
38
|
-
prn__in: ['
|
39
|
-
pulp_href__in: ['
|
40
|
-
pulp_id__in: ['
|
35
|
+
ordering: ['-pk'], # Array<String> | Ordering * `pk` - Pk * `-pk` - Pk (descending)
|
36
|
+
orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
|
37
|
+
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
38
|
+
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
39
|
+
pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
41
40
|
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
42
41
|
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF/PRN
|
43
42
|
repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF/PRN
|
44
43
|
repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF/PRN
|
45
|
-
fields: ['
|
46
|
-
exclude_fields: ['
|
44
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
45
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
47
46
|
}
|
48
47
|
|
49
48
|
begin
|
50
|
-
#List ostree summarys
|
49
|
+
# List ostree summarys
|
51
50
|
result = api_instance.list(opts)
|
52
51
|
p result
|
53
52
|
rescue PulpOstreeClient::ApiError => e
|
54
|
-
puts "
|
53
|
+
puts "Error when calling ContentSummariesApi->list: #{e}"
|
55
54
|
end
|
56
55
|
```
|
57
56
|
|
58
|
-
|
57
|
+
#### Using the list_with_http_info variant
|
58
|
+
|
59
|
+
This returns an Array which contains the response data, status code and headers.
|
59
60
|
|
61
|
+
> <Array(<PaginatedostreeOstreeSummaryResponseList>, Integer, Hash)> list_with_http_info(opts)
|
62
|
+
|
63
|
+
```ruby
|
64
|
+
begin
|
65
|
+
# List ostree summarys
|
66
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
67
|
+
p status_code # => 2xx
|
68
|
+
p headers # => { ... }
|
69
|
+
p data # => <PaginatedostreeOstreeSummaryResponseList>
|
70
|
+
rescue PulpOstreeClient::ApiError => e
|
71
|
+
puts "Error when calling ContentSummariesApi->list_with_http_info: #{e}"
|
72
|
+
end
|
73
|
+
```
|
74
|
+
|
75
|
+
### Parameters
|
60
76
|
|
61
|
-
Name | Type | Description
|
62
|
-
|
63
|
-
**limit** | **Integer
|
64
|
-
**offset** | **Integer
|
65
|
-
**ordering** | [**Array<String>**](String.md)| Ordering * `pk` - Pk * `-pk` - Pk (descending) | [optional]
|
66
|
-
**orphaned_for** | **Float
|
67
|
-
**prn__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
68
|
-
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
69
|
-
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
70
|
-
**q** | **String
|
71
|
-
**repository_version** | **String
|
72
|
-
**repository_version_added** | **String
|
73
|
-
**repository_version_removed** | **String
|
74
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
75
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
77
|
+
| Name | Type | Description | Notes |
|
78
|
+
| ---- | ---- | ----------- | ----- |
|
79
|
+
| **limit** | **Integer** | Number of results to return per page. | [optional] |
|
80
|
+
| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
|
81
|
+
| **ordering** | [**Array<String>**](String.md) | Ordering * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
82
|
+
| **orphaned_for** | **Float** | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] |
|
83
|
+
| **prn__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
84
|
+
| **pulp_href__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
85
|
+
| **pulp_id__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
86
|
+
| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
|
87
|
+
| **repository_version** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
88
|
+
| **repository_version_added** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
89
|
+
| **repository_version_removed** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
90
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
91
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
76
92
|
|
77
93
|
### Return type
|
78
94
|
|
@@ -90,16 +106,16 @@ Name | Type | Description | Notes
|
|
90
106
|
|
91
107
|
## read
|
92
108
|
|
93
|
-
> OstreeOstreeSummaryResponse read(ostree_ostree_summary_href, opts)
|
109
|
+
> <OstreeOstreeSummaryResponse> read(ostree_ostree_summary_href, opts)
|
94
110
|
|
95
111
|
Inspect an ostree summary
|
96
112
|
|
97
113
|
A ViewSet class for OSTree repository summary files.
|
98
114
|
|
99
|
-
###
|
115
|
+
### Examples
|
100
116
|
|
101
117
|
```ruby
|
102
|
-
|
118
|
+
require 'time'
|
103
119
|
require 'pulp_ostree_client'
|
104
120
|
# setup authorization
|
105
121
|
PulpOstreeClient.configure do |config|
|
@@ -111,27 +127,44 @@ end
|
|
111
127
|
api_instance = PulpOstreeClient::ContentSummariesApi.new
|
112
128
|
ostree_ostree_summary_href = 'ostree_ostree_summary_href_example' # String |
|
113
129
|
opts = {
|
114
|
-
fields: ['
|
115
|
-
exclude_fields: ['
|
130
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
131
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
116
132
|
}
|
117
133
|
|
118
134
|
begin
|
119
|
-
#Inspect an ostree summary
|
135
|
+
# Inspect an ostree summary
|
120
136
|
result = api_instance.read(ostree_ostree_summary_href, opts)
|
121
137
|
p result
|
122
138
|
rescue PulpOstreeClient::ApiError => e
|
123
|
-
puts "
|
139
|
+
puts "Error when calling ContentSummariesApi->read: #{e}"
|
124
140
|
end
|
125
141
|
```
|
126
142
|
|
127
|
-
|
143
|
+
#### Using the read_with_http_info variant
|
144
|
+
|
145
|
+
This returns an Array which contains the response data, status code and headers.
|
146
|
+
|
147
|
+
> <Array(<OstreeOstreeSummaryResponse>, Integer, Hash)> read_with_http_info(ostree_ostree_summary_href, opts)
|
148
|
+
|
149
|
+
```ruby
|
150
|
+
begin
|
151
|
+
# Inspect an ostree summary
|
152
|
+
data, status_code, headers = api_instance.read_with_http_info(ostree_ostree_summary_href, opts)
|
153
|
+
p status_code # => 2xx
|
154
|
+
p headers # => { ... }
|
155
|
+
p data # => <OstreeOstreeSummaryResponse>
|
156
|
+
rescue PulpOstreeClient::ApiError => e
|
157
|
+
puts "Error when calling ContentSummariesApi->read_with_http_info: #{e}"
|
158
|
+
end
|
159
|
+
```
|
128
160
|
|
161
|
+
### Parameters
|
129
162
|
|
130
|
-
Name | Type | Description
|
131
|
-
|
132
|
-
**ostree_ostree_summary_href** | **String
|
133
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
134
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
163
|
+
| Name | Type | Description | Notes |
|
164
|
+
| ---- | ---- | ----------- | ----- |
|
165
|
+
| **ostree_ostree_summary_href** | **String** | | |
|
166
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
167
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
135
168
|
|
136
169
|
### Return type
|
137
170
|
|
@@ -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_ostree_client'
|
15
15
|
|
16
|
-
instance = PulpOstreeClient::ContentSummaryResponse.new(
|
17
|
-
|
18
|
-
|
16
|
+
instance = PulpOstreeClient::ContentSummaryResponse.new(
|
17
|
+
added: null,
|
18
|
+
removed: null,
|
19
|
+
present: null
|
20
|
+
)
|
19
21
|
```
|
20
22
|
|
21
|
-
|