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
@@ -2,35 +2,34 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost:24817*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**add_role**](DistributionsOstreeApi.md#add_role) | **POST** {ostree_ostree_distribution_href}add_role/ | Add a role
|
8
|
-
[**create**](DistributionsOstreeApi.md#create) | **POST** /pulp/api/v3/distributions/ostree/ostree/ | Create an ostree distribution
|
9
|
-
[**delete**](DistributionsOstreeApi.md#delete) | **DELETE** {ostree_ostree_distribution_href} | Delete an ostree distribution
|
10
|
-
[**list**](DistributionsOstreeApi.md#list) | **GET** /pulp/api/v3/distributions/ostree/ostree/ | List ostree distributions
|
11
|
-
[**list_roles**](DistributionsOstreeApi.md#list_roles) | **GET** {ostree_ostree_distribution_href}list_roles/ | List roles
|
12
|
-
[**my_permissions**](DistributionsOstreeApi.md#my_permissions) | **GET** {ostree_ostree_distribution_href}my_permissions/ | List user permissions
|
13
|
-
[**partial_update**](DistributionsOstreeApi.md#partial_update) | **PATCH** {ostree_ostree_distribution_href} | Update an ostree distribution
|
14
|
-
[**read**](DistributionsOstreeApi.md#read) | **GET** {ostree_ostree_distribution_href} | Inspect an ostree distribution
|
15
|
-
[**remove_role**](DistributionsOstreeApi.md#remove_role) | **POST** {ostree_ostree_distribution_href}remove_role/ | Remove a role
|
16
|
-
[**set_label**](DistributionsOstreeApi.md#set_label) | **POST** {ostree_ostree_distribution_href}set_label/ | Set a label
|
17
|
-
[**unset_label**](DistributionsOstreeApi.md#unset_label) | **POST** {ostree_ostree_distribution_href}unset_label/ | Unset a label
|
18
|
-
[**update**](DistributionsOstreeApi.md#update) | **PUT** {ostree_ostree_distribution_href} | Update an ostree distribution
|
19
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**add_role**](DistributionsOstreeApi.md#add_role) | **POST** {ostree_ostree_distribution_href}add_role/ | Add a role |
|
8
|
+
| [**create**](DistributionsOstreeApi.md#create) | **POST** /pulp/api/v3/distributions/ostree/ostree/ | Create an ostree distribution |
|
9
|
+
| [**delete**](DistributionsOstreeApi.md#delete) | **DELETE** {ostree_ostree_distribution_href} | Delete an ostree distribution |
|
10
|
+
| [**list**](DistributionsOstreeApi.md#list) | **GET** /pulp/api/v3/distributions/ostree/ostree/ | List ostree distributions |
|
11
|
+
| [**list_roles**](DistributionsOstreeApi.md#list_roles) | **GET** {ostree_ostree_distribution_href}list_roles/ | List roles |
|
12
|
+
| [**my_permissions**](DistributionsOstreeApi.md#my_permissions) | **GET** {ostree_ostree_distribution_href}my_permissions/ | List user permissions |
|
13
|
+
| [**partial_update**](DistributionsOstreeApi.md#partial_update) | **PATCH** {ostree_ostree_distribution_href} | Update an ostree distribution |
|
14
|
+
| [**read**](DistributionsOstreeApi.md#read) | **GET** {ostree_ostree_distribution_href} | Inspect an ostree distribution |
|
15
|
+
| [**remove_role**](DistributionsOstreeApi.md#remove_role) | **POST** {ostree_ostree_distribution_href}remove_role/ | Remove a role |
|
16
|
+
| [**set_label**](DistributionsOstreeApi.md#set_label) | **POST** {ostree_ostree_distribution_href}set_label/ | Set a label |
|
17
|
+
| [**unset_label**](DistributionsOstreeApi.md#unset_label) | **POST** {ostree_ostree_distribution_href}unset_label/ | Unset a label |
|
18
|
+
| [**update**](DistributionsOstreeApi.md#update) | **PUT** {ostree_ostree_distribution_href} | Update an ostree distribution |
|
20
19
|
|
21
20
|
|
22
21
|
## add_role
|
23
22
|
|
24
|
-
> NestedRoleResponse add_role(ostree_ostree_distribution_href, nested_role)
|
23
|
+
> <NestedRoleResponse> add_role(ostree_ostree_distribution_href, nested_role)
|
25
24
|
|
26
25
|
Add a role
|
27
26
|
|
28
27
|
Add a role for this object to users/groups.
|
29
28
|
|
30
|
-
###
|
29
|
+
### Examples
|
31
30
|
|
32
31
|
```ruby
|
33
|
-
|
32
|
+
require 'time'
|
34
33
|
require 'pulp_ostree_client'
|
35
34
|
# setup authorization
|
36
35
|
PulpOstreeClient.configure do |config|
|
@@ -41,24 +40,41 @@ end
|
|
41
40
|
|
42
41
|
api_instance = PulpOstreeClient::DistributionsOstreeApi.new
|
43
42
|
ostree_ostree_distribution_href = 'ostree_ostree_distribution_href_example' # String |
|
44
|
-
nested_role = PulpOstreeClient::NestedRole.new # NestedRole |
|
43
|
+
nested_role = PulpOstreeClient::NestedRole.new({role: 'role_example'}) # NestedRole |
|
45
44
|
|
46
45
|
begin
|
47
|
-
#Add a role
|
46
|
+
# Add a role
|
48
47
|
result = api_instance.add_role(ostree_ostree_distribution_href, nested_role)
|
49
48
|
p result
|
50
49
|
rescue PulpOstreeClient::ApiError => e
|
51
|
-
puts "
|
50
|
+
puts "Error when calling DistributionsOstreeApi->add_role: #{e}"
|
52
51
|
end
|
53
52
|
```
|
54
53
|
|
55
|
-
|
54
|
+
#### Using the add_role_with_http_info variant
|
55
|
+
|
56
|
+
This returns an Array which contains the response data, status code and headers.
|
57
|
+
|
58
|
+
> <Array(<NestedRoleResponse>, Integer, Hash)> add_role_with_http_info(ostree_ostree_distribution_href, nested_role)
|
59
|
+
|
60
|
+
```ruby
|
61
|
+
begin
|
62
|
+
# Add a role
|
63
|
+
data, status_code, headers = api_instance.add_role_with_http_info(ostree_ostree_distribution_href, nested_role)
|
64
|
+
p status_code # => 2xx
|
65
|
+
p headers # => { ... }
|
66
|
+
p data # => <NestedRoleResponse>
|
67
|
+
rescue PulpOstreeClient::ApiError => e
|
68
|
+
puts "Error when calling DistributionsOstreeApi->add_role_with_http_info: #{e}"
|
69
|
+
end
|
70
|
+
```
|
56
71
|
|
72
|
+
### Parameters
|
57
73
|
|
58
|
-
Name | Type | Description
|
59
|
-
|
60
|
-
**ostree_ostree_distribution_href** | **String
|
61
|
-
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
74
|
+
| Name | Type | Description | Notes |
|
75
|
+
| ---- | ---- | ----------- | ----- |
|
76
|
+
| **ostree_ostree_distribution_href** | **String** | | |
|
77
|
+
| **nested_role** | [**NestedRole**](NestedRole.md) | | |
|
62
78
|
|
63
79
|
### Return type
|
64
80
|
|
@@ -76,16 +92,16 @@ Name | Type | Description | Notes
|
|
76
92
|
|
77
93
|
## create
|
78
94
|
|
79
|
-
> AsyncOperationResponse create(ostree_ostree_distribution)
|
95
|
+
> <AsyncOperationResponse> create(ostree_ostree_distribution)
|
80
96
|
|
81
97
|
Create an ostree distribution
|
82
98
|
|
83
99
|
Trigger an asynchronous create task
|
84
100
|
|
85
|
-
###
|
101
|
+
### Examples
|
86
102
|
|
87
103
|
```ruby
|
88
|
-
|
104
|
+
require 'time'
|
89
105
|
require 'pulp_ostree_client'
|
90
106
|
# setup authorization
|
91
107
|
PulpOstreeClient.configure do |config|
|
@@ -95,23 +111,40 @@ PulpOstreeClient.configure do |config|
|
|
95
111
|
end
|
96
112
|
|
97
113
|
api_instance = PulpOstreeClient::DistributionsOstreeApi.new
|
98
|
-
ostree_ostree_distribution = PulpOstreeClient::OstreeOstreeDistribution.new # OstreeOstreeDistribution |
|
114
|
+
ostree_ostree_distribution = PulpOstreeClient::OstreeOstreeDistribution.new({base_path: 'base_path_example', name: 'name_example'}) # OstreeOstreeDistribution |
|
99
115
|
|
100
116
|
begin
|
101
|
-
#Create an ostree distribution
|
117
|
+
# Create an ostree distribution
|
102
118
|
result = api_instance.create(ostree_ostree_distribution)
|
103
119
|
p result
|
104
120
|
rescue PulpOstreeClient::ApiError => e
|
105
|
-
puts "
|
121
|
+
puts "Error when calling DistributionsOstreeApi->create: #{e}"
|
106
122
|
end
|
107
123
|
```
|
108
124
|
|
109
|
-
|
125
|
+
#### Using the create_with_http_info variant
|
110
126
|
|
127
|
+
This returns an Array which contains the response data, status code and headers.
|
111
128
|
|
112
|
-
|
113
|
-
|
114
|
-
|
129
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> create_with_http_info(ostree_ostree_distribution)
|
130
|
+
|
131
|
+
```ruby
|
132
|
+
begin
|
133
|
+
# Create an ostree distribution
|
134
|
+
data, status_code, headers = api_instance.create_with_http_info(ostree_ostree_distribution)
|
135
|
+
p status_code # => 2xx
|
136
|
+
p headers # => { ... }
|
137
|
+
p data # => <AsyncOperationResponse>
|
138
|
+
rescue PulpOstreeClient::ApiError => e
|
139
|
+
puts "Error when calling DistributionsOstreeApi->create_with_http_info: #{e}"
|
140
|
+
end
|
141
|
+
```
|
142
|
+
|
143
|
+
### Parameters
|
144
|
+
|
145
|
+
| Name | Type | Description | Notes |
|
146
|
+
| ---- | ---- | ----------- | ----- |
|
147
|
+
| **ostree_ostree_distribution** | [**OstreeOstreeDistribution**](OstreeOstreeDistribution.md) | | |
|
115
148
|
|
116
149
|
### Return type
|
117
150
|
|
@@ -129,16 +162,16 @@ Name | Type | Description | Notes
|
|
129
162
|
|
130
163
|
## delete
|
131
164
|
|
132
|
-
> AsyncOperationResponse delete(ostree_ostree_distribution_href)
|
165
|
+
> <AsyncOperationResponse> delete(ostree_ostree_distribution_href)
|
133
166
|
|
134
167
|
Delete an ostree distribution
|
135
168
|
|
136
169
|
Trigger an asynchronous delete task
|
137
170
|
|
138
|
-
###
|
171
|
+
### Examples
|
139
172
|
|
140
173
|
```ruby
|
141
|
-
|
174
|
+
require 'time'
|
142
175
|
require 'pulp_ostree_client'
|
143
176
|
# setup authorization
|
144
177
|
PulpOstreeClient.configure do |config|
|
@@ -151,20 +184,37 @@ api_instance = PulpOstreeClient::DistributionsOstreeApi.new
|
|
151
184
|
ostree_ostree_distribution_href = 'ostree_ostree_distribution_href_example' # String |
|
152
185
|
|
153
186
|
begin
|
154
|
-
#Delete an ostree distribution
|
187
|
+
# Delete an ostree distribution
|
155
188
|
result = api_instance.delete(ostree_ostree_distribution_href)
|
156
189
|
p result
|
157
190
|
rescue PulpOstreeClient::ApiError => e
|
158
|
-
puts "
|
191
|
+
puts "Error when calling DistributionsOstreeApi->delete: #{e}"
|
159
192
|
end
|
160
193
|
```
|
161
194
|
|
162
|
-
|
195
|
+
#### Using the delete_with_http_info variant
|
196
|
+
|
197
|
+
This returns an Array which contains the response data, status code and headers.
|
198
|
+
|
199
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(ostree_ostree_distribution_href)
|
163
200
|
|
201
|
+
```ruby
|
202
|
+
begin
|
203
|
+
# Delete an ostree distribution
|
204
|
+
data, status_code, headers = api_instance.delete_with_http_info(ostree_ostree_distribution_href)
|
205
|
+
p status_code # => 2xx
|
206
|
+
p headers # => { ... }
|
207
|
+
p data # => <AsyncOperationResponse>
|
208
|
+
rescue PulpOstreeClient::ApiError => e
|
209
|
+
puts "Error when calling DistributionsOstreeApi->delete_with_http_info: #{e}"
|
210
|
+
end
|
211
|
+
```
|
212
|
+
|
213
|
+
### Parameters
|
164
214
|
|
165
|
-
Name | Type | Description
|
166
|
-
|
167
|
-
**ostree_ostree_distribution_href** | **String
|
215
|
+
| Name | Type | Description | Notes |
|
216
|
+
| ---- | ---- | ----------- | ----- |
|
217
|
+
| **ostree_ostree_distribution_href** | **String** | | |
|
168
218
|
|
169
219
|
### Return type
|
170
220
|
|
@@ -182,16 +232,16 @@ Name | Type | Description | Notes
|
|
182
232
|
|
183
233
|
## list
|
184
234
|
|
185
|
-
> PaginatedostreeOstreeDistributionResponseList list(opts)
|
235
|
+
> <PaginatedostreeOstreeDistributionResponseList> list(opts)
|
186
236
|
|
187
237
|
List ostree distributions
|
188
238
|
|
189
239
|
A ViewSet class for OSTree distributions.
|
190
240
|
|
191
|
-
###
|
241
|
+
### Examples
|
192
242
|
|
193
243
|
```ruby
|
194
|
-
|
244
|
+
require 'time'
|
195
245
|
require 'pulp_ostree_client'
|
196
246
|
# setup authorization
|
197
247
|
PulpOstreeClient.configure do |config|
|
@@ -205,71 +255,88 @@ opts = {
|
|
205
255
|
base_path: 'base_path_example', # String | Filter results where base_path matches value
|
206
256
|
base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
|
207
257
|
base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
|
208
|
-
base_path__in: ['
|
258
|
+
base_path__in: ['inner_example'], # Array<String> | Filter results where base_path is in a comma-separated list of values
|
209
259
|
limit: 56, # Integer | Number of results to return per page.
|
210
260
|
name: 'name_example', # String | Filter results where name matches value
|
211
261
|
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
212
262
|
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
213
263
|
name__iexact: 'name__iexact_example', # String | Filter results where name matches value
|
214
|
-
name__in: ['
|
264
|
+
name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
215
265
|
name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
|
216
266
|
name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
|
217
267
|
name__regex: 'name__regex_example', # String | Filter results where name matches regex value
|
218
268
|
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
219
269
|
offset: 56, # Integer | The initial index from which to return the results.
|
220
|
-
ordering: ['
|
221
|
-
prn__in: ['
|
222
|
-
pulp_href__in: ['
|
223
|
-
pulp_id__in: ['
|
270
|
+
ordering: ['-base_path'], # Array<String> | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
271
|
+
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
272
|
+
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
273
|
+
pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
224
274
|
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
225
275
|
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
226
|
-
repository: '
|
227
|
-
repository__in: ['
|
276
|
+
repository: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Filter results where repository matches value
|
277
|
+
repository__in: ['inner_example'], # Array<String> | Filter results where repository is in a comma-separated list of values
|
228
278
|
with_content: 'with_content_example', # String | Filter distributions based on the content served by them
|
229
|
-
fields: ['
|
230
|
-
exclude_fields: ['
|
279
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
280
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
231
281
|
}
|
232
282
|
|
233
283
|
begin
|
234
|
-
#List ostree distributions
|
284
|
+
# List ostree distributions
|
235
285
|
result = api_instance.list(opts)
|
236
286
|
p result
|
237
287
|
rescue PulpOstreeClient::ApiError => e
|
238
|
-
puts "
|
288
|
+
puts "Error when calling DistributionsOstreeApi->list: #{e}"
|
239
289
|
end
|
240
290
|
```
|
241
291
|
|
242
|
-
|
292
|
+
#### Using the list_with_http_info variant
|
293
|
+
|
294
|
+
This returns an Array which contains the response data, status code and headers.
|
243
295
|
|
296
|
+
> <Array(<PaginatedostreeOstreeDistributionResponseList>, Integer, Hash)> list_with_http_info(opts)
|
244
297
|
|
245
|
-
|
246
|
-
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
**
|
262
|
-
**
|
263
|
-
**
|
264
|
-
**
|
265
|
-
**
|
266
|
-
**
|
267
|
-
**
|
268
|
-
**
|
269
|
-
**
|
270
|
-
**
|
271
|
-
**
|
272
|
-
**
|
298
|
+
```ruby
|
299
|
+
begin
|
300
|
+
# List ostree distributions
|
301
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
302
|
+
p status_code # => 2xx
|
303
|
+
p headers # => { ... }
|
304
|
+
p data # => <PaginatedostreeOstreeDistributionResponseList>
|
305
|
+
rescue PulpOstreeClient::ApiError => e
|
306
|
+
puts "Error when calling DistributionsOstreeApi->list_with_http_info: #{e}"
|
307
|
+
end
|
308
|
+
```
|
309
|
+
|
310
|
+
### Parameters
|
311
|
+
|
312
|
+
| Name | Type | Description | Notes |
|
313
|
+
| ---- | ---- | ----------- | ----- |
|
314
|
+
| **base_path** | **String** | Filter results where base_path matches value | [optional] |
|
315
|
+
| **base_path__contains** | **String** | Filter results where base_path contains value | [optional] |
|
316
|
+
| **base_path__icontains** | **String** | Filter results where base_path contains value | [optional] |
|
317
|
+
| **base_path__in** | [**Array<String>**](String.md) | Filter results where base_path is in a comma-separated list of values | [optional] |
|
318
|
+
| **limit** | **Integer** | Number of results to return per page. | [optional] |
|
319
|
+
| **name** | **String** | Filter results where name matches value | [optional] |
|
320
|
+
| **name__contains** | **String** | Filter results where name contains value | [optional] |
|
321
|
+
| **name__icontains** | **String** | Filter results where name contains value | [optional] |
|
322
|
+
| **name__iexact** | **String** | Filter results where name matches value | [optional] |
|
323
|
+
| **name__in** | [**Array<String>**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
|
324
|
+
| **name__iregex** | **String** | Filter results where name matches regex value | [optional] |
|
325
|
+
| **name__istartswith** | **String** | Filter results where name starts with value | [optional] |
|
326
|
+
| **name__regex** | **String** | Filter results where name matches regex value | [optional] |
|
327
|
+
| **name__startswith** | **String** | Filter results where name starts with value | [optional] |
|
328
|
+
| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
|
329
|
+
| **ordering** | [**Array<String>**](String.md) | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
330
|
+
| **prn__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
331
|
+
| **pulp_href__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
332
|
+
| **pulp_id__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
333
|
+
| **pulp_label_select** | **String** | Filter labels by search string | [optional] |
|
334
|
+
| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
|
335
|
+
| **repository** | **String** | Filter results where repository matches value | [optional] |
|
336
|
+
| **repository__in** | [**Array<String>**](String.md) | Filter results where repository is in a comma-separated list of values | [optional] |
|
337
|
+
| **with_content** | **String** | Filter distributions based on the content served by them | [optional] |
|
338
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
339
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
273
340
|
|
274
341
|
### Return type
|
275
342
|
|
@@ -287,16 +354,16 @@ Name | Type | Description | Notes
|
|
287
354
|
|
288
355
|
## list_roles
|
289
356
|
|
290
|
-
> ObjectRolesResponse list_roles(ostree_ostree_distribution_href, opts)
|
357
|
+
> <ObjectRolesResponse> list_roles(ostree_ostree_distribution_href, opts)
|
291
358
|
|
292
359
|
List roles
|
293
360
|
|
294
361
|
List roles assigned to this object.
|
295
362
|
|
296
|
-
###
|
363
|
+
### Examples
|
297
364
|
|
298
365
|
```ruby
|
299
|
-
|
366
|
+
require 'time'
|
300
367
|
require 'pulp_ostree_client'
|
301
368
|
# setup authorization
|
302
369
|
PulpOstreeClient.configure do |config|
|
@@ -308,27 +375,44 @@ end
|
|
308
375
|
api_instance = PulpOstreeClient::DistributionsOstreeApi.new
|
309
376
|
ostree_ostree_distribution_href = 'ostree_ostree_distribution_href_example' # String |
|
310
377
|
opts = {
|
311
|
-
fields: ['
|
312
|
-
exclude_fields: ['
|
378
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
379
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
313
380
|
}
|
314
381
|
|
315
382
|
begin
|
316
|
-
#List roles
|
383
|
+
# List roles
|
317
384
|
result = api_instance.list_roles(ostree_ostree_distribution_href, opts)
|
318
385
|
p result
|
319
386
|
rescue PulpOstreeClient::ApiError => e
|
320
|
-
puts "
|
387
|
+
puts "Error when calling DistributionsOstreeApi->list_roles: #{e}"
|
321
388
|
end
|
322
389
|
```
|
323
390
|
|
324
|
-
|
391
|
+
#### Using the list_roles_with_http_info variant
|
392
|
+
|
393
|
+
This returns an Array which contains the response data, status code and headers.
|
394
|
+
|
395
|
+
> <Array(<ObjectRolesResponse>, Integer, Hash)> list_roles_with_http_info(ostree_ostree_distribution_href, opts)
|
396
|
+
|
397
|
+
```ruby
|
398
|
+
begin
|
399
|
+
# List roles
|
400
|
+
data, status_code, headers = api_instance.list_roles_with_http_info(ostree_ostree_distribution_href, opts)
|
401
|
+
p status_code # => 2xx
|
402
|
+
p headers # => { ... }
|
403
|
+
p data # => <ObjectRolesResponse>
|
404
|
+
rescue PulpOstreeClient::ApiError => e
|
405
|
+
puts "Error when calling DistributionsOstreeApi->list_roles_with_http_info: #{e}"
|
406
|
+
end
|
407
|
+
```
|
325
408
|
|
409
|
+
### Parameters
|
326
410
|
|
327
|
-
Name | Type | Description
|
328
|
-
|
329
|
-
**ostree_ostree_distribution_href** | **String
|
330
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
331
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
411
|
+
| Name | Type | Description | Notes |
|
412
|
+
| ---- | ---- | ----------- | ----- |
|
413
|
+
| **ostree_ostree_distribution_href** | **String** | | |
|
414
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
415
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
332
416
|
|
333
417
|
### Return type
|
334
418
|
|
@@ -346,16 +430,16 @@ Name | Type | Description | Notes
|
|
346
430
|
|
347
431
|
## my_permissions
|
348
432
|
|
349
|
-
> MyPermissionsResponse my_permissions(ostree_ostree_distribution_href, opts)
|
433
|
+
> <MyPermissionsResponse> my_permissions(ostree_ostree_distribution_href, opts)
|
350
434
|
|
351
435
|
List user permissions
|
352
436
|
|
353
437
|
List permissions available to the current user on this object.
|
354
438
|
|
355
|
-
###
|
439
|
+
### Examples
|
356
440
|
|
357
441
|
```ruby
|
358
|
-
|
442
|
+
require 'time'
|
359
443
|
require 'pulp_ostree_client'
|
360
444
|
# setup authorization
|
361
445
|
PulpOstreeClient.configure do |config|
|
@@ -367,27 +451,44 @@ end
|
|
367
451
|
api_instance = PulpOstreeClient::DistributionsOstreeApi.new
|
368
452
|
ostree_ostree_distribution_href = 'ostree_ostree_distribution_href_example' # String |
|
369
453
|
opts = {
|
370
|
-
fields: ['
|
371
|
-
exclude_fields: ['
|
454
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
455
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
372
456
|
}
|
373
457
|
|
374
458
|
begin
|
375
|
-
#List user permissions
|
459
|
+
# List user permissions
|
376
460
|
result = api_instance.my_permissions(ostree_ostree_distribution_href, opts)
|
377
461
|
p result
|
378
462
|
rescue PulpOstreeClient::ApiError => e
|
379
|
-
puts "
|
463
|
+
puts "Error when calling DistributionsOstreeApi->my_permissions: #{e}"
|
380
464
|
end
|
381
465
|
```
|
382
466
|
|
383
|
-
|
467
|
+
#### Using the my_permissions_with_http_info variant
|
468
|
+
|
469
|
+
This returns an Array which contains the response data, status code and headers.
|
470
|
+
|
471
|
+
> <Array(<MyPermissionsResponse>, Integer, Hash)> my_permissions_with_http_info(ostree_ostree_distribution_href, opts)
|
384
472
|
|
473
|
+
```ruby
|
474
|
+
begin
|
475
|
+
# List user permissions
|
476
|
+
data, status_code, headers = api_instance.my_permissions_with_http_info(ostree_ostree_distribution_href, opts)
|
477
|
+
p status_code # => 2xx
|
478
|
+
p headers # => { ... }
|
479
|
+
p data # => <MyPermissionsResponse>
|
480
|
+
rescue PulpOstreeClient::ApiError => e
|
481
|
+
puts "Error when calling DistributionsOstreeApi->my_permissions_with_http_info: #{e}"
|
482
|
+
end
|
483
|
+
```
|
484
|
+
|
485
|
+
### Parameters
|
385
486
|
|
386
|
-
Name | Type | Description
|
387
|
-
|
388
|
-
**ostree_ostree_distribution_href** | **String
|
389
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
390
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
487
|
+
| Name | Type | Description | Notes |
|
488
|
+
| ---- | ---- | ----------- | ----- |
|
489
|
+
| **ostree_ostree_distribution_href** | **String** | | |
|
490
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
491
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
391
492
|
|
392
493
|
### Return type
|
393
494
|
|
@@ -405,16 +506,16 @@ Name | Type | Description | Notes
|
|
405
506
|
|
406
507
|
## partial_update
|
407
508
|
|
408
|
-
> AsyncOperationResponse partial_update(ostree_ostree_distribution_href, patchedostree_ostree_distribution)
|
509
|
+
> <AsyncOperationResponse> partial_update(ostree_ostree_distribution_href, patchedostree_ostree_distribution)
|
409
510
|
|
410
511
|
Update an ostree distribution
|
411
512
|
|
412
513
|
Trigger an asynchronous partial update task
|
413
514
|
|
414
|
-
###
|
515
|
+
### Examples
|
415
516
|
|
416
517
|
```ruby
|
417
|
-
|
518
|
+
require 'time'
|
418
519
|
require 'pulp_ostree_client'
|
419
520
|
# setup authorization
|
420
521
|
PulpOstreeClient.configure do |config|
|
@@ -428,21 +529,38 @@ ostree_ostree_distribution_href = 'ostree_ostree_distribution_href_example' # St
|
|
428
529
|
patchedostree_ostree_distribution = PulpOstreeClient::PatchedostreeOstreeDistribution.new # PatchedostreeOstreeDistribution |
|
429
530
|
|
430
531
|
begin
|
431
|
-
#Update an ostree distribution
|
532
|
+
# Update an ostree distribution
|
432
533
|
result = api_instance.partial_update(ostree_ostree_distribution_href, patchedostree_ostree_distribution)
|
433
534
|
p result
|
434
535
|
rescue PulpOstreeClient::ApiError => e
|
435
|
-
puts "
|
536
|
+
puts "Error when calling DistributionsOstreeApi->partial_update: #{e}"
|
436
537
|
end
|
437
538
|
```
|
438
539
|
|
439
|
-
|
540
|
+
#### Using the partial_update_with_http_info variant
|
541
|
+
|
542
|
+
This returns an Array which contains the response data, status code and headers.
|
440
543
|
|
544
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> partial_update_with_http_info(ostree_ostree_distribution_href, patchedostree_ostree_distribution)
|
441
545
|
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
546
|
+
```ruby
|
547
|
+
begin
|
548
|
+
# Update an ostree distribution
|
549
|
+
data, status_code, headers = api_instance.partial_update_with_http_info(ostree_ostree_distribution_href, patchedostree_ostree_distribution)
|
550
|
+
p status_code # => 2xx
|
551
|
+
p headers # => { ... }
|
552
|
+
p data # => <AsyncOperationResponse>
|
553
|
+
rescue PulpOstreeClient::ApiError => e
|
554
|
+
puts "Error when calling DistributionsOstreeApi->partial_update_with_http_info: #{e}"
|
555
|
+
end
|
556
|
+
```
|
557
|
+
|
558
|
+
### Parameters
|
559
|
+
|
560
|
+
| Name | Type | Description | Notes |
|
561
|
+
| ---- | ---- | ----------- | ----- |
|
562
|
+
| **ostree_ostree_distribution_href** | **String** | | |
|
563
|
+
| **patchedostree_ostree_distribution** | [**PatchedostreeOstreeDistribution**](PatchedostreeOstreeDistribution.md) | | |
|
446
564
|
|
447
565
|
### Return type
|
448
566
|
|
@@ -460,16 +578,16 @@ Name | Type | Description | Notes
|
|
460
578
|
|
461
579
|
## read
|
462
580
|
|
463
|
-
> OstreeOstreeDistributionResponse read(ostree_ostree_distribution_href, opts)
|
581
|
+
> <OstreeOstreeDistributionResponse> read(ostree_ostree_distribution_href, opts)
|
464
582
|
|
465
583
|
Inspect an ostree distribution
|
466
584
|
|
467
585
|
A ViewSet class for OSTree distributions.
|
468
586
|
|
469
|
-
###
|
587
|
+
### Examples
|
470
588
|
|
471
589
|
```ruby
|
472
|
-
|
590
|
+
require 'time'
|
473
591
|
require 'pulp_ostree_client'
|
474
592
|
# setup authorization
|
475
593
|
PulpOstreeClient.configure do |config|
|
@@ -481,27 +599,44 @@ end
|
|
481
599
|
api_instance = PulpOstreeClient::DistributionsOstreeApi.new
|
482
600
|
ostree_ostree_distribution_href = 'ostree_ostree_distribution_href_example' # String |
|
483
601
|
opts = {
|
484
|
-
fields: ['
|
485
|
-
exclude_fields: ['
|
602
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
603
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
486
604
|
}
|
487
605
|
|
488
606
|
begin
|
489
|
-
#Inspect an ostree distribution
|
607
|
+
# Inspect an ostree distribution
|
490
608
|
result = api_instance.read(ostree_ostree_distribution_href, opts)
|
491
609
|
p result
|
492
610
|
rescue PulpOstreeClient::ApiError => e
|
493
|
-
puts "
|
611
|
+
puts "Error when calling DistributionsOstreeApi->read: #{e}"
|
494
612
|
end
|
495
613
|
```
|
496
614
|
|
497
|
-
|
615
|
+
#### Using the read_with_http_info variant
|
616
|
+
|
617
|
+
This returns an Array which contains the response data, status code and headers.
|
618
|
+
|
619
|
+
> <Array(<OstreeOstreeDistributionResponse>, Integer, Hash)> read_with_http_info(ostree_ostree_distribution_href, opts)
|
620
|
+
|
621
|
+
```ruby
|
622
|
+
begin
|
623
|
+
# Inspect an ostree distribution
|
624
|
+
data, status_code, headers = api_instance.read_with_http_info(ostree_ostree_distribution_href, opts)
|
625
|
+
p status_code # => 2xx
|
626
|
+
p headers # => { ... }
|
627
|
+
p data # => <OstreeOstreeDistributionResponse>
|
628
|
+
rescue PulpOstreeClient::ApiError => e
|
629
|
+
puts "Error when calling DistributionsOstreeApi->read_with_http_info: #{e}"
|
630
|
+
end
|
631
|
+
```
|
498
632
|
|
633
|
+
### Parameters
|
499
634
|
|
500
|
-
Name | Type | Description
|
501
|
-
|
502
|
-
**ostree_ostree_distribution_href** | **String
|
503
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
504
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
635
|
+
| Name | Type | Description | Notes |
|
636
|
+
| ---- | ---- | ----------- | ----- |
|
637
|
+
| **ostree_ostree_distribution_href** | **String** | | |
|
638
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
639
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
505
640
|
|
506
641
|
### Return type
|
507
642
|
|
@@ -519,16 +654,16 @@ Name | Type | Description | Notes
|
|
519
654
|
|
520
655
|
## remove_role
|
521
656
|
|
522
|
-
> NestedRoleResponse remove_role(ostree_ostree_distribution_href, nested_role)
|
657
|
+
> <NestedRoleResponse> remove_role(ostree_ostree_distribution_href, nested_role)
|
523
658
|
|
524
659
|
Remove a role
|
525
660
|
|
526
661
|
Remove a role for this object from users/groups.
|
527
662
|
|
528
|
-
###
|
663
|
+
### Examples
|
529
664
|
|
530
665
|
```ruby
|
531
|
-
|
666
|
+
require 'time'
|
532
667
|
require 'pulp_ostree_client'
|
533
668
|
# setup authorization
|
534
669
|
PulpOstreeClient.configure do |config|
|
@@ -539,24 +674,41 @@ end
|
|
539
674
|
|
540
675
|
api_instance = PulpOstreeClient::DistributionsOstreeApi.new
|
541
676
|
ostree_ostree_distribution_href = 'ostree_ostree_distribution_href_example' # String |
|
542
|
-
nested_role = PulpOstreeClient::NestedRole.new # NestedRole |
|
677
|
+
nested_role = PulpOstreeClient::NestedRole.new({role: 'role_example'}) # NestedRole |
|
543
678
|
|
544
679
|
begin
|
545
|
-
#Remove a role
|
680
|
+
# Remove a role
|
546
681
|
result = api_instance.remove_role(ostree_ostree_distribution_href, nested_role)
|
547
682
|
p result
|
548
683
|
rescue PulpOstreeClient::ApiError => e
|
549
|
-
puts "
|
684
|
+
puts "Error when calling DistributionsOstreeApi->remove_role: #{e}"
|
550
685
|
end
|
551
686
|
```
|
552
687
|
|
553
|
-
|
688
|
+
#### Using the remove_role_with_http_info variant
|
689
|
+
|
690
|
+
This returns an Array which contains the response data, status code and headers.
|
691
|
+
|
692
|
+
> <Array(<NestedRoleResponse>, Integer, Hash)> remove_role_with_http_info(ostree_ostree_distribution_href, nested_role)
|
554
693
|
|
694
|
+
```ruby
|
695
|
+
begin
|
696
|
+
# Remove a role
|
697
|
+
data, status_code, headers = api_instance.remove_role_with_http_info(ostree_ostree_distribution_href, nested_role)
|
698
|
+
p status_code # => 2xx
|
699
|
+
p headers # => { ... }
|
700
|
+
p data # => <NestedRoleResponse>
|
701
|
+
rescue PulpOstreeClient::ApiError => e
|
702
|
+
puts "Error when calling DistributionsOstreeApi->remove_role_with_http_info: #{e}"
|
703
|
+
end
|
704
|
+
```
|
705
|
+
|
706
|
+
### Parameters
|
555
707
|
|
556
|
-
Name | Type | Description
|
557
|
-
|
558
|
-
**ostree_ostree_distribution_href** | **String
|
559
|
-
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
708
|
+
| Name | Type | Description | Notes |
|
709
|
+
| ---- | ---- | ----------- | ----- |
|
710
|
+
| **ostree_ostree_distribution_href** | **String** | | |
|
711
|
+
| **nested_role** | [**NestedRole**](NestedRole.md) | | |
|
560
712
|
|
561
713
|
### Return type
|
562
714
|
|
@@ -574,16 +726,16 @@ Name | Type | Description | Notes
|
|
574
726
|
|
575
727
|
## set_label
|
576
728
|
|
577
|
-
> SetLabelResponse set_label(ostree_ostree_distribution_href, set_label)
|
729
|
+
> <SetLabelResponse> set_label(ostree_ostree_distribution_href, set_label)
|
578
730
|
|
579
731
|
Set a label
|
580
732
|
|
581
733
|
Set a single pulp_label on the object to a specific value or null.
|
582
734
|
|
583
|
-
###
|
735
|
+
### Examples
|
584
736
|
|
585
737
|
```ruby
|
586
|
-
|
738
|
+
require 'time'
|
587
739
|
require 'pulp_ostree_client'
|
588
740
|
# setup authorization
|
589
741
|
PulpOstreeClient.configure do |config|
|
@@ -594,24 +746,41 @@ end
|
|
594
746
|
|
595
747
|
api_instance = PulpOstreeClient::DistributionsOstreeApi.new
|
596
748
|
ostree_ostree_distribution_href = 'ostree_ostree_distribution_href_example' # String |
|
597
|
-
set_label = PulpOstreeClient::SetLabel.new # SetLabel |
|
749
|
+
set_label = PulpOstreeClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
|
598
750
|
|
599
751
|
begin
|
600
|
-
#Set a label
|
752
|
+
# Set a label
|
601
753
|
result = api_instance.set_label(ostree_ostree_distribution_href, set_label)
|
602
754
|
p result
|
603
755
|
rescue PulpOstreeClient::ApiError => e
|
604
|
-
puts "
|
756
|
+
puts "Error when calling DistributionsOstreeApi->set_label: #{e}"
|
605
757
|
end
|
606
758
|
```
|
607
759
|
|
608
|
-
|
760
|
+
#### Using the set_label_with_http_info variant
|
761
|
+
|
762
|
+
This returns an Array which contains the response data, status code and headers.
|
609
763
|
|
764
|
+
> <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(ostree_ostree_distribution_href, set_label)
|
610
765
|
|
611
|
-
|
612
|
-
|
613
|
-
|
614
|
-
|
766
|
+
```ruby
|
767
|
+
begin
|
768
|
+
# Set a label
|
769
|
+
data, status_code, headers = api_instance.set_label_with_http_info(ostree_ostree_distribution_href, set_label)
|
770
|
+
p status_code # => 2xx
|
771
|
+
p headers # => { ... }
|
772
|
+
p data # => <SetLabelResponse>
|
773
|
+
rescue PulpOstreeClient::ApiError => e
|
774
|
+
puts "Error when calling DistributionsOstreeApi->set_label_with_http_info: #{e}"
|
775
|
+
end
|
776
|
+
```
|
777
|
+
|
778
|
+
### Parameters
|
779
|
+
|
780
|
+
| Name | Type | Description | Notes |
|
781
|
+
| ---- | ---- | ----------- | ----- |
|
782
|
+
| **ostree_ostree_distribution_href** | **String** | | |
|
783
|
+
| **set_label** | [**SetLabel**](SetLabel.md) | | |
|
615
784
|
|
616
785
|
### Return type
|
617
786
|
|
@@ -629,16 +798,16 @@ Name | Type | Description | Notes
|
|
629
798
|
|
630
799
|
## unset_label
|
631
800
|
|
632
|
-
> UnsetLabelResponse unset_label(ostree_ostree_distribution_href, unset_label)
|
801
|
+
> <UnsetLabelResponse> unset_label(ostree_ostree_distribution_href, unset_label)
|
633
802
|
|
634
803
|
Unset a label
|
635
804
|
|
636
805
|
Unset a single pulp_label on the object.
|
637
806
|
|
638
|
-
###
|
807
|
+
### Examples
|
639
808
|
|
640
809
|
```ruby
|
641
|
-
|
810
|
+
require 'time'
|
642
811
|
require 'pulp_ostree_client'
|
643
812
|
# setup authorization
|
644
813
|
PulpOstreeClient.configure do |config|
|
@@ -649,24 +818,41 @@ end
|
|
649
818
|
|
650
819
|
api_instance = PulpOstreeClient::DistributionsOstreeApi.new
|
651
820
|
ostree_ostree_distribution_href = 'ostree_ostree_distribution_href_example' # String |
|
652
|
-
unset_label = PulpOstreeClient::UnsetLabel.new # UnsetLabel |
|
821
|
+
unset_label = PulpOstreeClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
|
653
822
|
|
654
823
|
begin
|
655
|
-
#Unset a label
|
824
|
+
# Unset a label
|
656
825
|
result = api_instance.unset_label(ostree_ostree_distribution_href, unset_label)
|
657
826
|
p result
|
658
827
|
rescue PulpOstreeClient::ApiError => e
|
659
|
-
puts "
|
828
|
+
puts "Error when calling DistributionsOstreeApi->unset_label: #{e}"
|
660
829
|
end
|
661
830
|
```
|
662
831
|
|
663
|
-
|
832
|
+
#### Using the unset_label_with_http_info variant
|
833
|
+
|
834
|
+
This returns an Array which contains the response data, status code and headers.
|
835
|
+
|
836
|
+
> <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(ostree_ostree_distribution_href, unset_label)
|
837
|
+
|
838
|
+
```ruby
|
839
|
+
begin
|
840
|
+
# Unset a label
|
841
|
+
data, status_code, headers = api_instance.unset_label_with_http_info(ostree_ostree_distribution_href, unset_label)
|
842
|
+
p status_code # => 2xx
|
843
|
+
p headers # => { ... }
|
844
|
+
p data # => <UnsetLabelResponse>
|
845
|
+
rescue PulpOstreeClient::ApiError => e
|
846
|
+
puts "Error when calling DistributionsOstreeApi->unset_label_with_http_info: #{e}"
|
847
|
+
end
|
848
|
+
```
|
664
849
|
|
850
|
+
### Parameters
|
665
851
|
|
666
|
-
Name | Type | Description
|
667
|
-
|
668
|
-
**ostree_ostree_distribution_href** | **String
|
669
|
-
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
|
852
|
+
| Name | Type | Description | Notes |
|
853
|
+
| ---- | ---- | ----------- | ----- |
|
854
|
+
| **ostree_ostree_distribution_href** | **String** | | |
|
855
|
+
| **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
|
670
856
|
|
671
857
|
### Return type
|
672
858
|
|
@@ -684,16 +870,16 @@ Name | Type | Description | Notes
|
|
684
870
|
|
685
871
|
## update
|
686
872
|
|
687
|
-
> AsyncOperationResponse update(ostree_ostree_distribution_href, ostree_ostree_distribution)
|
873
|
+
> <AsyncOperationResponse> update(ostree_ostree_distribution_href, ostree_ostree_distribution)
|
688
874
|
|
689
875
|
Update an ostree distribution
|
690
876
|
|
691
877
|
Trigger an asynchronous update task
|
692
878
|
|
693
|
-
###
|
879
|
+
### Examples
|
694
880
|
|
695
881
|
```ruby
|
696
|
-
|
882
|
+
require 'time'
|
697
883
|
require 'pulp_ostree_client'
|
698
884
|
# setup authorization
|
699
885
|
PulpOstreeClient.configure do |config|
|
@@ -704,24 +890,41 @@ end
|
|
704
890
|
|
705
891
|
api_instance = PulpOstreeClient::DistributionsOstreeApi.new
|
706
892
|
ostree_ostree_distribution_href = 'ostree_ostree_distribution_href_example' # String |
|
707
|
-
ostree_ostree_distribution = PulpOstreeClient::OstreeOstreeDistribution.new # OstreeOstreeDistribution |
|
893
|
+
ostree_ostree_distribution = PulpOstreeClient::OstreeOstreeDistribution.new({base_path: 'base_path_example', name: 'name_example'}) # OstreeOstreeDistribution |
|
708
894
|
|
709
895
|
begin
|
710
|
-
#Update an ostree distribution
|
896
|
+
# Update an ostree distribution
|
711
897
|
result = api_instance.update(ostree_ostree_distribution_href, ostree_ostree_distribution)
|
712
898
|
p result
|
713
899
|
rescue PulpOstreeClient::ApiError => e
|
714
|
-
puts "
|
900
|
+
puts "Error when calling DistributionsOstreeApi->update: #{e}"
|
715
901
|
end
|
716
902
|
```
|
717
903
|
|
718
|
-
|
904
|
+
#### Using the update_with_http_info variant
|
905
|
+
|
906
|
+
This returns an Array which contains the response data, status code and headers.
|
907
|
+
|
908
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> update_with_http_info(ostree_ostree_distribution_href, ostree_ostree_distribution)
|
719
909
|
|
910
|
+
```ruby
|
911
|
+
begin
|
912
|
+
# Update an ostree distribution
|
913
|
+
data, status_code, headers = api_instance.update_with_http_info(ostree_ostree_distribution_href, ostree_ostree_distribution)
|
914
|
+
p status_code # => 2xx
|
915
|
+
p headers # => { ... }
|
916
|
+
p data # => <AsyncOperationResponse>
|
917
|
+
rescue PulpOstreeClient::ApiError => e
|
918
|
+
puts "Error when calling DistributionsOstreeApi->update_with_http_info: #{e}"
|
919
|
+
end
|
920
|
+
```
|
921
|
+
|
922
|
+
### Parameters
|
720
923
|
|
721
|
-
Name | Type | Description
|
722
|
-
|
723
|
-
**ostree_ostree_distribution_href** | **String
|
724
|
-
**ostree_ostree_distribution** | [**OstreeOstreeDistribution**](OstreeOstreeDistribution.md)| |
|
924
|
+
| Name | Type | Description | Notes |
|
925
|
+
| ---- | ---- | ----------- | ----- |
|
926
|
+
| **ostree_ostree_distribution_href** | **String** | | |
|
927
|
+
| **ostree_ostree_distribution** | [**OstreeOstreeDistribution**](OstreeOstreeDistribution.md) | | |
|
725
928
|
|
726
929
|
### Return type
|
727
930
|
|