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/ContentContentApi.md
CHANGED
@@ -2,26 +2,25 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost:24817*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**create**](ContentContentApi.md#create) | **POST** /pulp/api/v3/content/ostree/content/ | Create an ostree content
|
8
|
-
[**list**](ContentContentApi.md#list) | **GET** /pulp/api/v3/content/ostree/content/ | List ostree contents
|
9
|
-
[**read**](ContentContentApi.md#read) | **GET** {ostree_ostree_content_href} | Inspect an ostree content
|
10
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create**](ContentContentApi.md#create) | **POST** /pulp/api/v3/content/ostree/content/ | Create an ostree content |
|
8
|
+
| [**list**](ContentContentApi.md#list) | **GET** /pulp/api/v3/content/ostree/content/ | List ostree contents |
|
9
|
+
| [**read**](ContentContentApi.md#read) | **GET** {ostree_ostree_content_href} | Inspect an ostree content |
|
11
10
|
|
12
11
|
|
13
12
|
## create
|
14
13
|
|
15
|
-
> AsyncOperationResponse create(ostree_ostree_content)
|
14
|
+
> <AsyncOperationResponse> create(ostree_ostree_content)
|
16
15
|
|
17
16
|
Create an ostree content
|
18
17
|
|
19
18
|
Trigger an asynchronous task to create content,optionally create new repository version.
|
20
19
|
|
21
|
-
###
|
20
|
+
### Examples
|
22
21
|
|
23
22
|
```ruby
|
24
|
-
|
23
|
+
require 'time'
|
25
24
|
require 'pulp_ostree_client'
|
26
25
|
# setup authorization
|
27
26
|
PulpOstreeClient.configure do |config|
|
@@ -31,23 +30,40 @@ PulpOstreeClient.configure do |config|
|
|
31
30
|
end
|
32
31
|
|
33
32
|
api_instance = PulpOstreeClient::ContentContentApi.new
|
34
|
-
ostree_ostree_content = PulpOstreeClient::OstreeOstreeContent.new # OstreeOstreeContent |
|
33
|
+
ostree_ostree_content = PulpOstreeClient::OstreeOstreeContent.new({artifact: 'artifact_example', relative_path: 'relative_path_example', digest: 'digest_example'}) # OstreeOstreeContent |
|
35
34
|
|
36
35
|
begin
|
37
|
-
#Create an ostree content
|
36
|
+
# Create an ostree content
|
38
37
|
result = api_instance.create(ostree_ostree_content)
|
39
38
|
p result
|
40
39
|
rescue PulpOstreeClient::ApiError => e
|
41
|
-
puts "
|
40
|
+
puts "Error when calling ContentContentApi->create: #{e}"
|
42
41
|
end
|
43
42
|
```
|
44
43
|
|
45
|
-
|
44
|
+
#### Using the create_with_http_info variant
|
45
|
+
|
46
|
+
This returns an Array which contains the response data, status code and headers.
|
47
|
+
|
48
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> create_with_http_info(ostree_ostree_content)
|
49
|
+
|
50
|
+
```ruby
|
51
|
+
begin
|
52
|
+
# Create an ostree content
|
53
|
+
data, status_code, headers = api_instance.create_with_http_info(ostree_ostree_content)
|
54
|
+
p status_code # => 2xx
|
55
|
+
p headers # => { ... }
|
56
|
+
p data # => <AsyncOperationResponse>
|
57
|
+
rescue PulpOstreeClient::ApiError => e
|
58
|
+
puts "Error when calling ContentContentApi->create_with_http_info: #{e}"
|
59
|
+
end
|
60
|
+
```
|
46
61
|
|
62
|
+
### Parameters
|
47
63
|
|
48
|
-
Name | Type | Description
|
49
|
-
|
50
|
-
**ostree_ostree_content** | [**OstreeOstreeContent**](OstreeOstreeContent.md)| |
|
64
|
+
| Name | Type | Description | Notes |
|
65
|
+
| ---- | ---- | ----------- | ----- |
|
66
|
+
| **ostree_ostree_content** | [**OstreeOstreeContent**](OstreeOstreeContent.md) | | |
|
51
67
|
|
52
68
|
### Return type
|
53
69
|
|
@@ -65,16 +81,16 @@ Name | Type | Description | Notes
|
|
65
81
|
|
66
82
|
## list
|
67
83
|
|
68
|
-
> PaginatedostreeOstreeContentResponseList list(opts)
|
84
|
+
> <PaginatedostreeOstreeContentResponseList> list(opts)
|
69
85
|
|
70
86
|
List ostree contents
|
71
87
|
|
72
88
|
A ViewSet class for uncategorized content units (e.g., static deltas).
|
73
89
|
|
74
|
-
###
|
90
|
+
### Examples
|
75
91
|
|
76
92
|
```ruby
|
77
|
-
|
93
|
+
require 'time'
|
78
94
|
require 'pulp_ostree_client'
|
79
95
|
# setup authorization
|
80
96
|
PulpOstreeClient.configure do |config|
|
@@ -87,46 +103,63 @@ api_instance = PulpOstreeClient::ContentContentApi.new
|
|
87
103
|
opts = {
|
88
104
|
limit: 56, # Integer | Number of results to return per page.
|
89
105
|
offset: 56, # Integer | The initial index from which to return the results.
|
90
|
-
ordering: ['
|
91
|
-
orphaned_for:
|
92
|
-
prn__in: ['
|
93
|
-
pulp_href__in: ['
|
94
|
-
pulp_id__in: ['
|
106
|
+
ordering: ['-pk'], # Array<String> | Ordering * `pk` - Pk * `-pk` - Pk (descending)
|
107
|
+
orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
|
108
|
+
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
109
|
+
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
110
|
+
pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
95
111
|
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
96
112
|
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF/PRN
|
97
113
|
repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF/PRN
|
98
114
|
repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF/PRN
|
99
|
-
fields: ['
|
100
|
-
exclude_fields: ['
|
115
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
116
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
101
117
|
}
|
102
118
|
|
103
119
|
begin
|
104
|
-
#List ostree contents
|
120
|
+
# List ostree contents
|
105
121
|
result = api_instance.list(opts)
|
106
122
|
p result
|
107
123
|
rescue PulpOstreeClient::ApiError => e
|
108
|
-
puts "
|
124
|
+
puts "Error when calling ContentContentApi->list: #{e}"
|
109
125
|
end
|
110
126
|
```
|
111
127
|
|
112
|
-
|
128
|
+
#### Using the list_with_http_info variant
|
113
129
|
|
130
|
+
This returns an Array which contains the response data, status code and headers.
|
114
131
|
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
132
|
+
> <Array(<PaginatedostreeOstreeContentResponseList>, Integer, Hash)> list_with_http_info(opts)
|
133
|
+
|
134
|
+
```ruby
|
135
|
+
begin
|
136
|
+
# List ostree contents
|
137
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
138
|
+
p status_code # => 2xx
|
139
|
+
p headers # => { ... }
|
140
|
+
p data # => <PaginatedostreeOstreeContentResponseList>
|
141
|
+
rescue PulpOstreeClient::ApiError => e
|
142
|
+
puts "Error when calling ContentContentApi->list_with_http_info: #{e}"
|
143
|
+
end
|
144
|
+
```
|
145
|
+
|
146
|
+
### Parameters
|
147
|
+
|
148
|
+
| Name | Type | Description | Notes |
|
149
|
+
| ---- | ---- | ----------- | ----- |
|
150
|
+
| **limit** | **Integer** | Number of results to return per page. | [optional] |
|
151
|
+
| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
|
152
|
+
| **ordering** | [**Array<String>**](String.md) | Ordering * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
153
|
+
| **orphaned_for** | **Float** | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] |
|
154
|
+
| **prn__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
155
|
+
| **pulp_href__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
156
|
+
| **pulp_id__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
157
|
+
| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
|
158
|
+
| **repository_version** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
159
|
+
| **repository_version_added** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
160
|
+
| **repository_version_removed** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
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] |
|
130
163
|
|
131
164
|
### Return type
|
132
165
|
|
@@ -144,16 +177,16 @@ Name | Type | Description | Notes
|
|
144
177
|
|
145
178
|
## read
|
146
179
|
|
147
|
-
> OstreeOstreeContentResponse read(ostree_ostree_content_href, opts)
|
180
|
+
> <OstreeOstreeContentResponse> read(ostree_ostree_content_href, opts)
|
148
181
|
|
149
182
|
Inspect an ostree content
|
150
183
|
|
151
184
|
A ViewSet class for uncategorized content units (e.g., static deltas).
|
152
185
|
|
153
|
-
###
|
186
|
+
### Examples
|
154
187
|
|
155
188
|
```ruby
|
156
|
-
|
189
|
+
require 'time'
|
157
190
|
require 'pulp_ostree_client'
|
158
191
|
# setup authorization
|
159
192
|
PulpOstreeClient.configure do |config|
|
@@ -165,27 +198,44 @@ end
|
|
165
198
|
api_instance = PulpOstreeClient::ContentContentApi.new
|
166
199
|
ostree_ostree_content_href = 'ostree_ostree_content_href_example' # String |
|
167
200
|
opts = {
|
168
|
-
fields: ['
|
169
|
-
exclude_fields: ['
|
201
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
202
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
170
203
|
}
|
171
204
|
|
172
205
|
begin
|
173
|
-
#Inspect an ostree content
|
206
|
+
# Inspect an ostree content
|
174
207
|
result = api_instance.read(ostree_ostree_content_href, opts)
|
175
208
|
p result
|
176
209
|
rescue PulpOstreeClient::ApiError => e
|
177
|
-
puts "
|
210
|
+
puts "Error when calling ContentContentApi->read: #{e}"
|
178
211
|
end
|
179
212
|
```
|
180
213
|
|
181
|
-
|
214
|
+
#### Using the read_with_http_info variant
|
215
|
+
|
216
|
+
This returns an Array which contains the response data, status code and headers.
|
217
|
+
|
218
|
+
> <Array(<OstreeOstreeContentResponse>, Integer, Hash)> read_with_http_info(ostree_ostree_content_href, opts)
|
182
219
|
|
220
|
+
```ruby
|
221
|
+
begin
|
222
|
+
# Inspect an ostree content
|
223
|
+
data, status_code, headers = api_instance.read_with_http_info(ostree_ostree_content_href, opts)
|
224
|
+
p status_code # => 2xx
|
225
|
+
p headers # => { ... }
|
226
|
+
p data # => <OstreeOstreeContentResponse>
|
227
|
+
rescue PulpOstreeClient::ApiError => e
|
228
|
+
puts "Error when calling ContentContentApi->read_with_http_info: #{e}"
|
229
|
+
end
|
230
|
+
```
|
231
|
+
|
232
|
+
### Parameters
|
183
233
|
|
184
|
-
Name | Type | Description
|
185
|
-
|
186
|
-
**ostree_ostree_content_href** | **String
|
187
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
188
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
234
|
+
| Name | Type | Description | Notes |
|
235
|
+
| ---- | ---- | ----------- | ----- |
|
236
|
+
| **ostree_ostree_content_href** | **String** | | |
|
237
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
238
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
189
239
|
|
190
240
|
### Return type
|
191
241
|
|
data/docs/ContentObjectsApi.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**](ContentObjectsApi.md#list) | **GET** /pulp/api/v3/content/ostree/objects/ | List ostree objects
|
8
|
-
[**read**](ContentObjectsApi.md#read) | **GET** {ostree_ostree_object_href} | Inspect an ostree object
|
9
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**list**](ContentObjectsApi.md#list) | **GET** /pulp/api/v3/content/ostree/objects/ | List ostree objects |
|
8
|
+
| [**read**](ContentObjectsApi.md#read) | **GET** {ostree_ostree_object_href} | Inspect an ostree object |
|
10
9
|
|
11
10
|
|
12
11
|
## list
|
13
12
|
|
14
|
-
> PaginatedostreeOstreeObjectResponseList list(opts)
|
13
|
+
> <PaginatedostreeOstreeObjectResponseList> list(opts)
|
15
14
|
|
16
15
|
List ostree objects
|
17
16
|
|
18
17
|
A ViewSet class for OSTree objects (e.g., dirtree, dirmeta, file).
|
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|
|
@@ -34,47 +33,64 @@ opts = {
|
|
34
33
|
checksum: 'checksum_example', # String | Filter results where checksum matches value
|
35
34
|
limit: 56, # Integer | Number of results to return per page.
|
36
35
|
offset: 56, # Integer | The initial index from which to return the results.
|
37
|
-
ordering: ['
|
38
|
-
orphaned_for:
|
39
|
-
prn__in: ['
|
40
|
-
pulp_href__in: ['
|
41
|
-
pulp_id__in: ['
|
36
|
+
ordering: ['-checksum'], # 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) * `typ` - Typ * `-typ` - Typ (descending) * `checksum` - Checksum * `-checksum` - Checksum (descending) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
37
|
+
orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
|
38
|
+
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
39
|
+
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
40
|
+
pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
42
41
|
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
43
42
|
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF/PRN
|
44
43
|
repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF/PRN
|
45
44
|
repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF/PRN
|
46
|
-
fields: ['
|
47
|
-
exclude_fields: ['
|
45
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
46
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
48
47
|
}
|
49
48
|
|
50
49
|
begin
|
51
|
-
#List ostree objects
|
50
|
+
# List ostree objects
|
52
51
|
result = api_instance.list(opts)
|
53
52
|
p result
|
54
53
|
rescue PulpOstreeClient::ApiError => e
|
55
|
-
puts "
|
54
|
+
puts "Error when calling ContentObjectsApi->list: #{e}"
|
56
55
|
end
|
57
56
|
```
|
58
57
|
|
59
|
-
|
58
|
+
#### Using the list_with_http_info variant
|
59
|
+
|
60
|
+
This returns an Array which contains the response data, status code and headers.
|
60
61
|
|
62
|
+
> <Array(<PaginatedostreeOstreeObjectResponseList>, Integer, Hash)> list_with_http_info(opts)
|
63
|
+
|
64
|
+
```ruby
|
65
|
+
begin
|
66
|
+
# List ostree objects
|
67
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
68
|
+
p status_code # => 2xx
|
69
|
+
p headers # => { ... }
|
70
|
+
p data # => <PaginatedostreeOstreeObjectResponseList>
|
71
|
+
rescue PulpOstreeClient::ApiError => e
|
72
|
+
puts "Error when calling ContentObjectsApi->list_with_http_info: #{e}"
|
73
|
+
end
|
74
|
+
```
|
75
|
+
|
76
|
+
### Parameters
|
61
77
|
|
62
|
-
Name | Type | Description
|
63
|
-
|
64
|
-
**checksum** | **String
|
65
|
-
**limit** | **Integer
|
66
|
-
**offset** | **Integer
|
67
|
-
**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) * `typ` - Typ * `-typ` - Typ (descending) * `checksum` - Checksum * `-checksum` - Checksum (descending) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
|
68
|
-
**orphaned_for** | **Float
|
69
|
-
**prn__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
70
|
-
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
71
|
-
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
72
|
-
**q** | **String
|
73
|
-
**repository_version** | **String
|
74
|
-
**repository_version_added** | **String
|
75
|
-
**repository_version_removed** | **String
|
76
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
77
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
78
|
+
| Name | Type | Description | Notes |
|
79
|
+
| ---- | ---- | ----------- | ----- |
|
80
|
+
| **checksum** | **String** | Filter results where checksum matches value | [optional] |
|
81
|
+
| **limit** | **Integer** | Number of results to return per page. | [optional] |
|
82
|
+
| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
|
83
|
+
| **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) * `typ` - Typ * `-typ` - Typ (descending) * `checksum` - Checksum * `-checksum` - Checksum (descending) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
84
|
+
| **orphaned_for** | **Float** | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] |
|
85
|
+
| **prn__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
86
|
+
| **pulp_href__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
87
|
+
| **pulp_id__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
88
|
+
| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
|
89
|
+
| **repository_version** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
90
|
+
| **repository_version_added** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
91
|
+
| **repository_version_removed** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
92
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
93
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
78
94
|
|
79
95
|
### Return type
|
80
96
|
|
@@ -92,16 +108,16 @@ Name | Type | Description | Notes
|
|
92
108
|
|
93
109
|
## read
|
94
110
|
|
95
|
-
> OstreeOstreeObjectResponse read(ostree_ostree_object_href, opts)
|
111
|
+
> <OstreeOstreeObjectResponse> read(ostree_ostree_object_href, opts)
|
96
112
|
|
97
113
|
Inspect an ostree object
|
98
114
|
|
99
115
|
A ViewSet class for OSTree objects (e.g., dirtree, dirmeta, file).
|
100
116
|
|
101
|
-
###
|
117
|
+
### Examples
|
102
118
|
|
103
119
|
```ruby
|
104
|
-
|
120
|
+
require 'time'
|
105
121
|
require 'pulp_ostree_client'
|
106
122
|
# setup authorization
|
107
123
|
PulpOstreeClient.configure do |config|
|
@@ -113,27 +129,44 @@ end
|
|
113
129
|
api_instance = PulpOstreeClient::ContentObjectsApi.new
|
114
130
|
ostree_ostree_object_href = 'ostree_ostree_object_href_example' # String |
|
115
131
|
opts = {
|
116
|
-
fields: ['
|
117
|
-
exclude_fields: ['
|
132
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
133
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
118
134
|
}
|
119
135
|
|
120
136
|
begin
|
121
|
-
#Inspect an ostree object
|
137
|
+
# Inspect an ostree object
|
122
138
|
result = api_instance.read(ostree_ostree_object_href, opts)
|
123
139
|
p result
|
124
140
|
rescue PulpOstreeClient::ApiError => e
|
125
|
-
puts "
|
141
|
+
puts "Error when calling ContentObjectsApi->read: #{e}"
|
126
142
|
end
|
127
143
|
```
|
128
144
|
|
129
|
-
|
145
|
+
#### Using the read_with_http_info variant
|
146
|
+
|
147
|
+
This returns an Array which contains the response data, status code and headers.
|
148
|
+
|
149
|
+
> <Array(<OstreeOstreeObjectResponse>, Integer, Hash)> read_with_http_info(ostree_ostree_object_href, opts)
|
150
|
+
|
151
|
+
```ruby
|
152
|
+
begin
|
153
|
+
# Inspect an ostree object
|
154
|
+
data, status_code, headers = api_instance.read_with_http_info(ostree_ostree_object_href, opts)
|
155
|
+
p status_code # => 2xx
|
156
|
+
p headers # => { ... }
|
157
|
+
p data # => <OstreeOstreeObjectResponse>
|
158
|
+
rescue PulpOstreeClient::ApiError => e
|
159
|
+
puts "Error when calling ContentObjectsApi->read_with_http_info: #{e}"
|
160
|
+
end
|
161
|
+
```
|
130
162
|
|
163
|
+
### Parameters
|
131
164
|
|
132
|
-
Name | Type | Description
|
133
|
-
|
134
|
-
**ostree_ostree_object_href** | **String
|
135
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
136
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
165
|
+
| Name | Type | Description | Notes |
|
166
|
+
| ---- | ---- | ----------- | ----- |
|
167
|
+
| **ostree_ostree_object_href** | **String** | | |
|
168
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
169
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
137
170
|
|
138
171
|
### Return type
|
139
172
|
|