pulp_gem_client 0.6.1 → 0.6.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +11 -8
- data/docs/AsyncOperationResponse.md +8 -7
- data/docs/ContentGemApi.md +118 -66
- data/docs/ContentSummaryResponse.md +12 -11
- data/docs/DistributionsGemApi.md +388 -183
- data/docs/GemGemContentResponse.md +32 -29
- data/docs/GemGemDistribution.md +22 -21
- data/docs/GemGemDistributionResponse.md +34 -29
- data/docs/GemGemPublication.md +10 -9
- data/docs/GemGemPublicationResponse.md +18 -15
- data/docs/GemGemRemote.md +54 -53
- data/docs/GemGemRemoteResponse.md +54 -51
- data/docs/GemGemRemoteResponseHiddenFieldsInner.md +20 -0
- data/docs/GemGemRepository.md +16 -15
- data/docs/GemGemRepositoryResponse.md +28 -25
- data/docs/MyPermissionsResponse.md +8 -7
- data/docs/NestedRole.md +12 -11
- data/docs/NestedRoleResponse.md +12 -11
- data/docs/ObjectRolesResponse.md +8 -7
- data/docs/PaginatedRepositoryVersionResponseList.md +14 -13
- data/docs/PaginatedgemGemContentResponseList.md +14 -13
- data/docs/PaginatedgemGemDistributionResponseList.md +14 -13
- data/docs/PaginatedgemGemPublicationResponseList.md +14 -13
- data/docs/PaginatedgemGemRemoteResponseList.md +14 -13
- data/docs/PaginatedgemGemRepositoryResponseList.md +14 -13
- data/docs/PatchedgemGemDistribution.md +22 -21
- data/docs/PatchedgemGemRemote.md +54 -53
- data/docs/PatchedgemGemRepository.md +16 -15
- data/docs/PolicyEnum.md +4 -5
- data/docs/PublicationsGemApi.md +271 -132
- data/docs/RemotesGemApi.md +392 -185
- data/docs/Repair.md +8 -7
- data/docs/RepositoriesGemApi.md +449 -210
- data/docs/RepositoriesGemVersionsApi.md +155 -83
- data/docs/RepositoryAddRemoveContent.md +12 -11
- data/docs/RepositorySyncURL.md +10 -9
- data/docs/RepositoryVersionResponse.md +22 -19
- 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_gem_client/api/content_gem_api.rb +31 -22
- data/lib/pulp_gem_client/api/distributions_gem_api.rb +94 -58
- data/lib/pulp_gem_client/api/publications_gem_api.rb +81 -58
- data/lib/pulp_gem_client/api/remotes_gem_api.rb +109 -70
- data/lib/pulp_gem_client/api/repositories_gem_api.rb +116 -72
- data/lib/pulp_gem_client/api/repositories_gem_versions_api.rb +50 -37
- data/lib/pulp_gem_client/api_client.rb +137 -102
- data/lib/pulp_gem_client/api_error.rb +2 -1
- data/lib/pulp_gem_client/configuration.rb +162 -21
- data/lib/pulp_gem_client/models/async_operation_response.rb +32 -22
- data/lib/pulp_gem_client/models/content_summary_response.rb +36 -22
- data/lib/pulp_gem_client/models/gem_gem_content_response.rb +45 -25
- data/lib/pulp_gem_client/models/gem_gem_distribution.rb +34 -22
- data/lib/pulp_gem_client/models/gem_gem_distribution_response.rb +57 -25
- data/lib/pulp_gem_client/models/gem_gem_publication.rb +30 -22
- data/lib/pulp_gem_client/models/gem_gem_publication_response.rb +43 -25
- data/lib/pulp_gem_client/models/gem_gem_remote.rb +56 -22
- data/lib/pulp_gem_client/models/gem_gem_remote_response.rb +70 -26
- data/lib/pulp_gem_client/models/{gem_gem_remote_response_hidden_fields.rb → gem_gem_remote_response_hidden_fields_inner.rb} +37 -25
- data/lib/pulp_gem_client/models/gem_gem_repository.rb +32 -22
- data/lib/pulp_gem_client/models/gem_gem_repository_response.rb +45 -25
- data/lib/pulp_gem_client/models/my_permissions_response.rb +32 -22
- data/lib/pulp_gem_client/models/nested_role.rb +32 -22
- data/lib/pulp_gem_client/models/nested_role_response.rb +32 -22
- data/lib/pulp_gem_client/models/object_roles_response.rb +32 -22
- data/lib/pulp_gem_client/models/paginated_repository_version_response_list.rb +34 -22
- data/lib/pulp_gem_client/models/paginatedgem_gem_content_response_list.rb +34 -22
- data/lib/pulp_gem_client/models/paginatedgem_gem_distribution_response_list.rb +34 -22
- data/lib/pulp_gem_client/models/paginatedgem_gem_publication_response_list.rb +34 -22
- data/lib/pulp_gem_client/models/paginatedgem_gem_remote_response_list.rb +34 -22
- data/lib/pulp_gem_client/models/paginatedgem_gem_repository_response_list.rb +34 -22
- data/lib/pulp_gem_client/models/patchedgem_gem_distribution.rb +40 -24
- data/lib/pulp_gem_client/models/patchedgem_gem_remote.rb +62 -24
- data/lib/pulp_gem_client/models/patchedgem_gem_repository.rb +35 -23
- data/lib/pulp_gem_client/models/policy_enum.rb +8 -4
- data/lib/pulp_gem_client/models/repair.rb +30 -22
- data/lib/pulp_gem_client/models/repository_add_remove_content.rb +31 -23
- data/lib/pulp_gem_client/models/repository_sync_url.rb +30 -22
- data/lib/pulp_gem_client/models/repository_version_response.rb +44 -26
- data/lib/pulp_gem_client/models/set_label.rb +34 -22
- data/lib/pulp_gem_client/models/set_label_response.rb +34 -22
- data/lib/pulp_gem_client/models/unset_label.rb +32 -22
- data/lib/pulp_gem_client/models/unset_label_response.rb +32 -22
- data/lib/pulp_gem_client/version.rb +2 -2
- data/lib/pulp_gem_client.rb +2 -3
- data/pulp_gem_client.gemspec +9 -6
- data/spec/api/content_gem_api_spec.rb +9 -8
- data/spec/api/distributions_gem_api_spec.rb +15 -14
- data/spec/api/publications_gem_api_spec.rb +22 -20
- data/spec/api/remotes_gem_api_spec.rb +22 -20
- data/spec/api/repositories_gem_api_spec.rb +19 -18
- data/spec/api/repositories_gem_versions_api_spec.rb +16 -14
- data/spec/models/async_operation_response_spec.rb +7 -12
- data/spec/models/content_summary_response_spec.rb +9 -14
- data/spec/models/gem_gem_content_response_spec.rb +24 -23
- data/spec/models/gem_gem_distribution_response_spec.rb +30 -23
- data/spec/models/gem_gem_distribution_spec.rb +14 -19
- data/spec/models/gem_gem_publication_response_spec.rb +17 -16
- data/spec/models/gem_gem_publication_spec.rb +8 -13
- data/spec/models/{gem_gem_remote_response_hidden_fields_spec.rb → gem_gem_remote_response_hidden_fields_inner_spec.rb} +11 -16
- data/spec/models/gem_gem_remote_response_spec.rb +35 -34
- data/spec/models/gem_gem_remote_spec.rb +30 -35
- data/spec/models/gem_gem_repository_response_spec.rb +22 -21
- data/spec/models/gem_gem_repository_spec.rb +11 -16
- data/spec/models/my_permissions_response_spec.rb +7 -12
- data/spec/models/nested_role_response_spec.rb +9 -14
- data/spec/models/nested_role_spec.rb +9 -14
- data/spec/models/object_roles_response_spec.rb +7 -12
- data/spec/models/paginated_repository_version_response_list_spec.rb +10 -15
- data/spec/models/paginatedgem_gem_content_response_list_spec.rb +10 -15
- data/spec/models/paginatedgem_gem_distribution_response_list_spec.rb +10 -15
- data/spec/models/paginatedgem_gem_publication_response_list_spec.rb +10 -15
- data/spec/models/paginatedgem_gem_remote_response_list_spec.rb +10 -15
- data/spec/models/paginatedgem_gem_repository_response_list_spec.rb +10 -15
- data/spec/models/patchedgem_gem_distribution_spec.rb +14 -19
- data/spec/models/patchedgem_gem_remote_spec.rb +30 -35
- data/spec/models/patchedgem_gem_repository_spec.rb +11 -16
- 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 +19 -18
- 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 +80 -60
- data/docs/GemGemContent.md +0 -21
- data/docs/GemGemRemoteResponseHiddenFields.md +0 -19
- data/lib/pulp_gem_client/models/gem_gem_content.rb +0 -228
- data/spec/api_client_spec.rb +0 -188
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/gem_gem_content_spec.rb +0 -53
data/docs/DistributionsGemApi.md
CHANGED
@@ -1,36 +1,35 @@
|
|
1
1
|
# PulpGemClient::DistributionsGemApi
|
2
2
|
|
3
|
-
All URIs are relative to *http://
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**add_role**](DistributionsGemApi.md#add_role) | **POST** {gem_gem_distribution_href}add_role/ | Add a role
|
8
|
-
[**create**](DistributionsGemApi.md#create) | **POST** /pulp/api/v3/distributions/gem/gem/ | Create a gem distribution
|
9
|
-
[**delete**](DistributionsGemApi.md#delete) | **DELETE** {gem_gem_distribution_href} | Delete a gem distribution
|
10
|
-
[**list**](DistributionsGemApi.md#list) | **GET** /pulp/api/v3/distributions/gem/gem/ | List gem distributions
|
11
|
-
[**list_roles**](DistributionsGemApi.md#list_roles) | **GET** {gem_gem_distribution_href}list_roles/ | List roles
|
12
|
-
[**my_permissions**](DistributionsGemApi.md#my_permissions) | **GET** {gem_gem_distribution_href}my_permissions/ | List user permissions
|
13
|
-
[**partial_update**](DistributionsGemApi.md#partial_update) | **PATCH** {gem_gem_distribution_href} | Update a gem distribution
|
14
|
-
[**read**](DistributionsGemApi.md#read) | **GET** {gem_gem_distribution_href} | Inspect a gem distribution
|
15
|
-
[**remove_role**](DistributionsGemApi.md#remove_role) | **POST** {gem_gem_distribution_href}remove_role/ | Remove a role
|
16
|
-
[**set_label**](DistributionsGemApi.md#set_label) | **POST** {gem_gem_distribution_href}set_label/ | Set a label
|
17
|
-
[**unset_label**](DistributionsGemApi.md#unset_label) | **POST** {gem_gem_distribution_href}unset_label/ | Unset a label
|
18
|
-
[**update**](DistributionsGemApi.md#update) | **PUT** {gem_gem_distribution_href} | Update a gem distribution
|
19
|
-
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**add_role**](DistributionsGemApi.md#add_role) | **POST** {gem_gem_distribution_href}add_role/ | Add a role |
|
8
|
+
| [**create**](DistributionsGemApi.md#create) | **POST** /pulp/api/v3/distributions/gem/gem/ | Create a gem distribution |
|
9
|
+
| [**delete**](DistributionsGemApi.md#delete) | **DELETE** {gem_gem_distribution_href} | Delete a gem distribution |
|
10
|
+
| [**list**](DistributionsGemApi.md#list) | **GET** /pulp/api/v3/distributions/gem/gem/ | List gem distributions |
|
11
|
+
| [**list_roles**](DistributionsGemApi.md#list_roles) | **GET** {gem_gem_distribution_href}list_roles/ | List roles |
|
12
|
+
| [**my_permissions**](DistributionsGemApi.md#my_permissions) | **GET** {gem_gem_distribution_href}my_permissions/ | List user permissions |
|
13
|
+
| [**partial_update**](DistributionsGemApi.md#partial_update) | **PATCH** {gem_gem_distribution_href} | Update a gem distribution |
|
14
|
+
| [**read**](DistributionsGemApi.md#read) | **GET** {gem_gem_distribution_href} | Inspect a gem distribution |
|
15
|
+
| [**remove_role**](DistributionsGemApi.md#remove_role) | **POST** {gem_gem_distribution_href}remove_role/ | Remove a role |
|
16
|
+
| [**set_label**](DistributionsGemApi.md#set_label) | **POST** {gem_gem_distribution_href}set_label/ | Set a label |
|
17
|
+
| [**unset_label**](DistributionsGemApi.md#unset_label) | **POST** {gem_gem_distribution_href}unset_label/ | Unset a label |
|
18
|
+
| [**update**](DistributionsGemApi.md#update) | **PUT** {gem_gem_distribution_href} | Update a gem distribution |
|
20
19
|
|
21
20
|
|
22
21
|
## add_role
|
23
22
|
|
24
|
-
> NestedRoleResponse add_role(gem_gem_distribution_href, nested_role)
|
23
|
+
> <NestedRoleResponse> add_role(gem_gem_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_gem_client'
|
35
34
|
# setup authorization
|
36
35
|
PulpGemClient.configure do |config|
|
@@ -41,24 +40,41 @@ end
|
|
41
40
|
|
42
41
|
api_instance = PulpGemClient::DistributionsGemApi.new
|
43
42
|
gem_gem_distribution_href = 'gem_gem_distribution_href_example' # String |
|
44
|
-
nested_role = PulpGemClient::NestedRole.new # NestedRole |
|
43
|
+
nested_role = PulpGemClient::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(gem_gem_distribution_href, nested_role)
|
49
48
|
p result
|
50
49
|
rescue PulpGemClient::ApiError => e
|
51
|
-
puts "
|
50
|
+
puts "Error when calling DistributionsGemApi->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(gem_gem_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(gem_gem_distribution_href, nested_role)
|
64
|
+
p status_code # => 2xx
|
65
|
+
p headers # => { ... }
|
66
|
+
p data # => <NestedRoleResponse>
|
67
|
+
rescue PulpGemClient::ApiError => e
|
68
|
+
puts "Error when calling DistributionsGemApi->add_role_with_http_info: #{e}"
|
69
|
+
end
|
70
|
+
```
|
56
71
|
|
72
|
+
### Parameters
|
57
73
|
|
58
|
-
Name | Type | Description
|
59
|
-
|
60
|
-
**gem_gem_distribution_href** | **String
|
61
|
-
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
74
|
+
| Name | Type | Description | Notes |
|
75
|
+
| ---- | ---- | ----------- | ----- |
|
76
|
+
| **gem_gem_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(gem_gem_distribution)
|
95
|
+
> <AsyncOperationResponse> create(gem_gem_distribution)
|
80
96
|
|
81
97
|
Create a gem 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_gem_client'
|
90
106
|
# setup authorization
|
91
107
|
PulpGemClient.configure do |config|
|
@@ -95,23 +111,40 @@ PulpGemClient.configure do |config|
|
|
95
111
|
end
|
96
112
|
|
97
113
|
api_instance = PulpGemClient::DistributionsGemApi.new
|
98
|
-
gem_gem_distribution = PulpGemClient::GemGemDistribution.new # GemGemDistribution |
|
114
|
+
gem_gem_distribution = PulpGemClient::GemGemDistribution.new({base_path: 'base_path_example', name: 'name_example'}) # GemGemDistribution |
|
99
115
|
|
100
116
|
begin
|
101
|
-
#Create a gem distribution
|
117
|
+
# Create a gem distribution
|
102
118
|
result = api_instance.create(gem_gem_distribution)
|
103
119
|
p result
|
104
120
|
rescue PulpGemClient::ApiError => e
|
105
|
-
puts "
|
121
|
+
puts "Error when calling DistributionsGemApi->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(gem_gem_distribution)
|
130
|
+
|
131
|
+
```ruby
|
132
|
+
begin
|
133
|
+
# Create a gem distribution
|
134
|
+
data, status_code, headers = api_instance.create_with_http_info(gem_gem_distribution)
|
135
|
+
p status_code # => 2xx
|
136
|
+
p headers # => { ... }
|
137
|
+
p data # => <AsyncOperationResponse>
|
138
|
+
rescue PulpGemClient::ApiError => e
|
139
|
+
puts "Error when calling DistributionsGemApi->create_with_http_info: #{e}"
|
140
|
+
end
|
141
|
+
```
|
142
|
+
|
143
|
+
### Parameters
|
144
|
+
|
145
|
+
| Name | Type | Description | Notes |
|
146
|
+
| ---- | ---- | ----------- | ----- |
|
147
|
+
| **gem_gem_distribution** | [**GemGemDistribution**](GemGemDistribution.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(gem_gem_distribution_href)
|
165
|
+
> <AsyncOperationResponse> delete(gem_gem_distribution_href)
|
133
166
|
|
134
167
|
Delete a gem 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_gem_client'
|
143
176
|
# setup authorization
|
144
177
|
PulpGemClient.configure do |config|
|
@@ -151,20 +184,37 @@ api_instance = PulpGemClient::DistributionsGemApi.new
|
|
151
184
|
gem_gem_distribution_href = 'gem_gem_distribution_href_example' # String |
|
152
185
|
|
153
186
|
begin
|
154
|
-
#Delete a gem distribution
|
187
|
+
# Delete a gem distribution
|
155
188
|
result = api_instance.delete(gem_gem_distribution_href)
|
156
189
|
p result
|
157
190
|
rescue PulpGemClient::ApiError => e
|
158
|
-
puts "
|
191
|
+
puts "Error when calling DistributionsGemApi->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.
|
163
198
|
|
199
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(gem_gem_distribution_href)
|
164
200
|
|
165
|
-
|
166
|
-
|
167
|
-
|
201
|
+
```ruby
|
202
|
+
begin
|
203
|
+
# Delete a gem distribution
|
204
|
+
data, status_code, headers = api_instance.delete_with_http_info(gem_gem_distribution_href)
|
205
|
+
p status_code # => 2xx
|
206
|
+
p headers # => { ... }
|
207
|
+
p data # => <AsyncOperationResponse>
|
208
|
+
rescue PulpGemClient::ApiError => e
|
209
|
+
puts "Error when calling DistributionsGemApi->delete_with_http_info: #{e}"
|
210
|
+
end
|
211
|
+
```
|
212
|
+
|
213
|
+
### Parameters
|
214
|
+
|
215
|
+
| Name | Type | Description | Notes |
|
216
|
+
| ---- | ---- | ----------- | ----- |
|
217
|
+
| **gem_gem_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
|
-
> PaginatedgemGemDistributionResponseList list(opts)
|
235
|
+
> <PaginatedgemGemDistributionResponseList> list(opts)
|
186
236
|
|
187
237
|
List gem distributions
|
188
238
|
|
189
239
|
ViewSet for GemDistributions.
|
190
240
|
|
191
|
-
###
|
241
|
+
### Examples
|
192
242
|
|
193
243
|
```ruby
|
194
|
-
|
244
|
+
require 'time'
|
195
245
|
require 'pulp_gem_client'
|
196
246
|
# setup authorization
|
197
247
|
PulpGemClient.configure do |config|
|
@@ -205,69 +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
|
-
|
222
|
-
|
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.
|
223
274
|
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
224
|
-
q: 'q_example', # String |
|
225
|
-
repository: '
|
226
|
-
repository__in: ['
|
275
|
+
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
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
|
227
278
|
with_content: 'with_content_example', # String | Filter distributions based on the content served by them
|
228
|
-
fields: ['
|
229
|
-
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.
|
230
281
|
}
|
231
282
|
|
232
283
|
begin
|
233
|
-
#List gem distributions
|
284
|
+
# List gem distributions
|
234
285
|
result = api_instance.list(opts)
|
235
286
|
p result
|
236
287
|
rescue PulpGemClient::ApiError => e
|
237
|
-
puts "
|
288
|
+
puts "Error when calling DistributionsGemApi->list: #{e}"
|
238
289
|
end
|
239
290
|
```
|
240
291
|
|
241
|
-
|
292
|
+
#### Using the list_with_http_info variant
|
242
293
|
|
294
|
+
This returns an Array which contains the response data, status code and headers.
|
243
295
|
|
244
|
-
|
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
|
-
**
|
296
|
+
> <Array(<PaginatedgemGemDistributionResponseList>, Integer, Hash)> list_with_http_info(opts)
|
297
|
+
|
298
|
+
```ruby
|
299
|
+
begin
|
300
|
+
# List gem distributions
|
301
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
302
|
+
p status_code # => 2xx
|
303
|
+
p headers # => { ... }
|
304
|
+
p data # => <PaginatedgemGemDistributionResponseList>
|
305
|
+
rescue PulpGemClient::ApiError => e
|
306
|
+
puts "Error when calling DistributionsGemApi->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] |
|
271
340
|
|
272
341
|
### Return type
|
273
342
|
|
@@ -285,16 +354,16 @@ Name | Type | Description | Notes
|
|
285
354
|
|
286
355
|
## list_roles
|
287
356
|
|
288
|
-
> ObjectRolesResponse list_roles(gem_gem_distribution_href, opts)
|
357
|
+
> <ObjectRolesResponse> list_roles(gem_gem_distribution_href, opts)
|
289
358
|
|
290
359
|
List roles
|
291
360
|
|
292
361
|
List roles assigned to this object.
|
293
362
|
|
294
|
-
###
|
363
|
+
### Examples
|
295
364
|
|
296
365
|
```ruby
|
297
|
-
|
366
|
+
require 'time'
|
298
367
|
require 'pulp_gem_client'
|
299
368
|
# setup authorization
|
300
369
|
PulpGemClient.configure do |config|
|
@@ -306,27 +375,44 @@ end
|
|
306
375
|
api_instance = PulpGemClient::DistributionsGemApi.new
|
307
376
|
gem_gem_distribution_href = 'gem_gem_distribution_href_example' # String |
|
308
377
|
opts = {
|
309
|
-
fields: ['
|
310
|
-
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.
|
311
380
|
}
|
312
381
|
|
313
382
|
begin
|
314
|
-
#List roles
|
383
|
+
# List roles
|
315
384
|
result = api_instance.list_roles(gem_gem_distribution_href, opts)
|
316
385
|
p result
|
317
386
|
rescue PulpGemClient::ApiError => e
|
318
|
-
puts "
|
387
|
+
puts "Error when calling DistributionsGemApi->list_roles: #{e}"
|
319
388
|
end
|
320
389
|
```
|
321
390
|
|
322
|
-
|
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(gem_gem_distribution_href, opts)
|
396
|
+
|
397
|
+
```ruby
|
398
|
+
begin
|
399
|
+
# List roles
|
400
|
+
data, status_code, headers = api_instance.list_roles_with_http_info(gem_gem_distribution_href, opts)
|
401
|
+
p status_code # => 2xx
|
402
|
+
p headers # => { ... }
|
403
|
+
p data # => <ObjectRolesResponse>
|
404
|
+
rescue PulpGemClient::ApiError => e
|
405
|
+
puts "Error when calling DistributionsGemApi->list_roles_with_http_info: #{e}"
|
406
|
+
end
|
407
|
+
```
|
323
408
|
|
409
|
+
### Parameters
|
324
410
|
|
325
|
-
Name | Type | Description
|
326
|
-
|
327
|
-
**gem_gem_distribution_href** | **String
|
328
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
329
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
411
|
+
| Name | Type | Description | Notes |
|
412
|
+
| ---- | ---- | ----------- | ----- |
|
413
|
+
| **gem_gem_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] |
|
330
416
|
|
331
417
|
### Return type
|
332
418
|
|
@@ -344,16 +430,16 @@ Name | Type | Description | Notes
|
|
344
430
|
|
345
431
|
## my_permissions
|
346
432
|
|
347
|
-
> MyPermissionsResponse my_permissions(gem_gem_distribution_href, opts)
|
433
|
+
> <MyPermissionsResponse> my_permissions(gem_gem_distribution_href, opts)
|
348
434
|
|
349
435
|
List user permissions
|
350
436
|
|
351
437
|
List permissions available to the current user on this object.
|
352
438
|
|
353
|
-
###
|
439
|
+
### Examples
|
354
440
|
|
355
441
|
```ruby
|
356
|
-
|
442
|
+
require 'time'
|
357
443
|
require 'pulp_gem_client'
|
358
444
|
# setup authorization
|
359
445
|
PulpGemClient.configure do |config|
|
@@ -365,27 +451,44 @@ end
|
|
365
451
|
api_instance = PulpGemClient::DistributionsGemApi.new
|
366
452
|
gem_gem_distribution_href = 'gem_gem_distribution_href_example' # String |
|
367
453
|
opts = {
|
368
|
-
fields: ['
|
369
|
-
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.
|
370
456
|
}
|
371
457
|
|
372
458
|
begin
|
373
|
-
#List user permissions
|
459
|
+
# List user permissions
|
374
460
|
result = api_instance.my_permissions(gem_gem_distribution_href, opts)
|
375
461
|
p result
|
376
462
|
rescue PulpGemClient::ApiError => e
|
377
|
-
puts "
|
463
|
+
puts "Error when calling DistributionsGemApi->my_permissions: #{e}"
|
378
464
|
end
|
379
465
|
```
|
380
466
|
|
381
|
-
|
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(gem_gem_distribution_href, opts)
|
472
|
+
|
473
|
+
```ruby
|
474
|
+
begin
|
475
|
+
# List user permissions
|
476
|
+
data, status_code, headers = api_instance.my_permissions_with_http_info(gem_gem_distribution_href, opts)
|
477
|
+
p status_code # => 2xx
|
478
|
+
p headers # => { ... }
|
479
|
+
p data # => <MyPermissionsResponse>
|
480
|
+
rescue PulpGemClient::ApiError => e
|
481
|
+
puts "Error when calling DistributionsGemApi->my_permissions_with_http_info: #{e}"
|
482
|
+
end
|
483
|
+
```
|
382
484
|
|
485
|
+
### Parameters
|
383
486
|
|
384
|
-
Name | Type | Description
|
385
|
-
|
386
|
-
**gem_gem_distribution_href** | **String
|
387
|
-
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
388
|
-
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
487
|
+
| Name | Type | Description | Notes |
|
488
|
+
| ---- | ---- | ----------- | ----- |
|
489
|
+
| **gem_gem_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] |
|
389
492
|
|
390
493
|
### Return type
|
391
494
|
|
@@ -403,16 +506,16 @@ Name | Type | Description | Notes
|
|
403
506
|
|
404
507
|
## partial_update
|
405
508
|
|
406
|
-
> AsyncOperationResponse partial_update(gem_gem_distribution_href, patchedgem_gem_distribution)
|
509
|
+
> <AsyncOperationResponse> partial_update(gem_gem_distribution_href, patchedgem_gem_distribution)
|
407
510
|
|
408
511
|
Update a gem distribution
|
409
512
|
|
410
513
|
Trigger an asynchronous partial update task
|
411
514
|
|
412
|
-
###
|
515
|
+
### Examples
|
413
516
|
|
414
517
|
```ruby
|
415
|
-
|
518
|
+
require 'time'
|
416
519
|
require 'pulp_gem_client'
|
417
520
|
# setup authorization
|
418
521
|
PulpGemClient.configure do |config|
|
@@ -426,21 +529,38 @@ gem_gem_distribution_href = 'gem_gem_distribution_href_example' # String |
|
|
426
529
|
patchedgem_gem_distribution = PulpGemClient::PatchedgemGemDistribution.new # PatchedgemGemDistribution |
|
427
530
|
|
428
531
|
begin
|
429
|
-
#Update a gem distribution
|
532
|
+
# Update a gem distribution
|
430
533
|
result = api_instance.partial_update(gem_gem_distribution_href, patchedgem_gem_distribution)
|
431
534
|
p result
|
432
535
|
rescue PulpGemClient::ApiError => e
|
433
|
-
puts "
|
536
|
+
puts "Error when calling DistributionsGemApi->partial_update: #{e}"
|
434
537
|
end
|
435
538
|
```
|
436
539
|
|
437
|
-
|
540
|
+
#### Using the partial_update_with_http_info variant
|
541
|
+
|
542
|
+
This returns an Array which contains the response data, status code and headers.
|
543
|
+
|
544
|
+
> <Array(<AsyncOperationResponse>, Integer, Hash)> partial_update_with_http_info(gem_gem_distribution_href, patchedgem_gem_distribution)
|
545
|
+
|
546
|
+
```ruby
|
547
|
+
begin
|
548
|
+
# Update a gem distribution
|
549
|
+
data, status_code, headers = api_instance.partial_update_with_http_info(gem_gem_distribution_href, patchedgem_gem_distribution)
|
550
|
+
p status_code # => 2xx
|
551
|
+
p headers # => { ... }
|
552
|
+
p data # => <AsyncOperationResponse>
|
553
|
+
rescue PulpGemClient::ApiError => e
|
554
|
+
puts "Error when calling DistributionsGemApi->partial_update_with_http_info: #{e}"
|
555
|
+
end
|
556
|
+
```
|
438
557
|
|
558
|
+
### Parameters
|
439
559
|
|
440
|
-
Name | Type | Description
|
441
|
-
|
442
|
-
**gem_gem_distribution_href** | **String
|
443
|
-
**patchedgem_gem_distribution** | [**PatchedgemGemDistribution**](PatchedgemGemDistribution.md)| |
|
560
|
+
| Name | Type | Description | Notes |
|
561
|
+
| ---- | ---- | ----------- | ----- |
|
562
|
+
| **gem_gem_distribution_href** | **String** | | |
|
563
|
+
| **patchedgem_gem_distribution** | [**PatchedgemGemDistribution**](PatchedgemGemDistribution.md) | | |
|
444
564
|
|
445
565
|
### Return type
|
446
566
|
|
@@ -458,16 +578,16 @@ Name | Type | Description | Notes
|
|
458
578
|
|
459
579
|
## read
|
460
580
|
|
461
|
-
> GemGemDistributionResponse read(gem_gem_distribution_href, opts)
|
581
|
+
> <GemGemDistributionResponse> read(gem_gem_distribution_href, opts)
|
462
582
|
|
463
583
|
Inspect a gem distribution
|
464
584
|
|
465
585
|
ViewSet for GemDistributions.
|
466
586
|
|
467
|
-
###
|
587
|
+
### Examples
|
468
588
|
|
469
589
|
```ruby
|
470
|
-
|
590
|
+
require 'time'
|
471
591
|
require 'pulp_gem_client'
|
472
592
|
# setup authorization
|
473
593
|
PulpGemClient.configure do |config|
|
@@ -479,27 +599,44 @@ end
|
|
479
599
|
api_instance = PulpGemClient::DistributionsGemApi.new
|
480
600
|
gem_gem_distribution_href = 'gem_gem_distribution_href_example' # String |
|
481
601
|
opts = {
|
482
|
-
fields: ['
|
483
|
-
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.
|
484
604
|
}
|
485
605
|
|
486
606
|
begin
|
487
|
-
#Inspect a gem distribution
|
607
|
+
# Inspect a gem distribution
|
488
608
|
result = api_instance.read(gem_gem_distribution_href, opts)
|
489
609
|
p result
|
490
610
|
rescue PulpGemClient::ApiError => e
|
491
|
-
puts "
|
611
|
+
puts "Error when calling DistributionsGemApi->read: #{e}"
|
492
612
|
end
|
493
613
|
```
|
494
614
|
|
495
|
-
|
615
|
+
#### Using the read_with_http_info variant
|
496
616
|
|
617
|
+
This returns an Array which contains the response data, status code and headers.
|
497
618
|
|
498
|
-
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
|
619
|
+
> <Array(<GemGemDistributionResponse>, Integer, Hash)> read_with_http_info(gem_gem_distribution_href, opts)
|
620
|
+
|
621
|
+
```ruby
|
622
|
+
begin
|
623
|
+
# Inspect a gem distribution
|
624
|
+
data, status_code, headers = api_instance.read_with_http_info(gem_gem_distribution_href, opts)
|
625
|
+
p status_code # => 2xx
|
626
|
+
p headers # => { ... }
|
627
|
+
p data # => <GemGemDistributionResponse>
|
628
|
+
rescue PulpGemClient::ApiError => e
|
629
|
+
puts "Error when calling DistributionsGemApi->read_with_http_info: #{e}"
|
630
|
+
end
|
631
|
+
```
|
632
|
+
|
633
|
+
### Parameters
|
634
|
+
|
635
|
+
| Name | Type | Description | Notes |
|
636
|
+
| ---- | ---- | ----------- | ----- |
|
637
|
+
| **gem_gem_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] |
|
503
640
|
|
504
641
|
### Return type
|
505
642
|
|
@@ -517,16 +654,16 @@ Name | Type | Description | Notes
|
|
517
654
|
|
518
655
|
## remove_role
|
519
656
|
|
520
|
-
> NestedRoleResponse remove_role(gem_gem_distribution_href, nested_role)
|
657
|
+
> <NestedRoleResponse> remove_role(gem_gem_distribution_href, nested_role)
|
521
658
|
|
522
659
|
Remove a role
|
523
660
|
|
524
661
|
Remove a role for this object from users/groups.
|
525
662
|
|
526
|
-
###
|
663
|
+
### Examples
|
527
664
|
|
528
665
|
```ruby
|
529
|
-
|
666
|
+
require 'time'
|
530
667
|
require 'pulp_gem_client'
|
531
668
|
# setup authorization
|
532
669
|
PulpGemClient.configure do |config|
|
@@ -537,24 +674,41 @@ end
|
|
537
674
|
|
538
675
|
api_instance = PulpGemClient::DistributionsGemApi.new
|
539
676
|
gem_gem_distribution_href = 'gem_gem_distribution_href_example' # String |
|
540
|
-
nested_role = PulpGemClient::NestedRole.new # NestedRole |
|
677
|
+
nested_role = PulpGemClient::NestedRole.new({role: 'role_example'}) # NestedRole |
|
541
678
|
|
542
679
|
begin
|
543
|
-
#Remove a role
|
680
|
+
# Remove a role
|
544
681
|
result = api_instance.remove_role(gem_gem_distribution_href, nested_role)
|
545
682
|
p result
|
546
683
|
rescue PulpGemClient::ApiError => e
|
547
|
-
puts "
|
684
|
+
puts "Error when calling DistributionsGemApi->remove_role: #{e}"
|
548
685
|
end
|
549
686
|
```
|
550
687
|
|
551
|
-
|
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(gem_gem_distribution_href, nested_role)
|
552
693
|
|
694
|
+
```ruby
|
695
|
+
begin
|
696
|
+
# Remove a role
|
697
|
+
data, status_code, headers = api_instance.remove_role_with_http_info(gem_gem_distribution_href, nested_role)
|
698
|
+
p status_code # => 2xx
|
699
|
+
p headers # => { ... }
|
700
|
+
p data # => <NestedRoleResponse>
|
701
|
+
rescue PulpGemClient::ApiError => e
|
702
|
+
puts "Error when calling DistributionsGemApi->remove_role_with_http_info: #{e}"
|
703
|
+
end
|
704
|
+
```
|
705
|
+
|
706
|
+
### Parameters
|
553
707
|
|
554
|
-
Name | Type | Description
|
555
|
-
|
556
|
-
**gem_gem_distribution_href** | **String
|
557
|
-
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
708
|
+
| Name | Type | Description | Notes |
|
709
|
+
| ---- | ---- | ----------- | ----- |
|
710
|
+
| **gem_gem_distribution_href** | **String** | | |
|
711
|
+
| **nested_role** | [**NestedRole**](NestedRole.md) | | |
|
558
712
|
|
559
713
|
### Return type
|
560
714
|
|
@@ -572,16 +726,16 @@ Name | Type | Description | Notes
|
|
572
726
|
|
573
727
|
## set_label
|
574
728
|
|
575
|
-
> SetLabelResponse set_label(gem_gem_distribution_href, set_label)
|
729
|
+
> <SetLabelResponse> set_label(gem_gem_distribution_href, set_label)
|
576
730
|
|
577
731
|
Set a label
|
578
732
|
|
579
733
|
Set a single pulp_label on the object to a specific value or null.
|
580
734
|
|
581
|
-
###
|
735
|
+
### Examples
|
582
736
|
|
583
737
|
```ruby
|
584
|
-
|
738
|
+
require 'time'
|
585
739
|
require 'pulp_gem_client'
|
586
740
|
# setup authorization
|
587
741
|
PulpGemClient.configure do |config|
|
@@ -592,24 +746,41 @@ end
|
|
592
746
|
|
593
747
|
api_instance = PulpGemClient::DistributionsGemApi.new
|
594
748
|
gem_gem_distribution_href = 'gem_gem_distribution_href_example' # String |
|
595
|
-
set_label = PulpGemClient::SetLabel.new # SetLabel |
|
749
|
+
set_label = PulpGemClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
|
596
750
|
|
597
751
|
begin
|
598
|
-
#Set a label
|
752
|
+
# Set a label
|
599
753
|
result = api_instance.set_label(gem_gem_distribution_href, set_label)
|
600
754
|
p result
|
601
755
|
rescue PulpGemClient::ApiError => e
|
602
|
-
puts "
|
756
|
+
puts "Error when calling DistributionsGemApi->set_label: #{e}"
|
603
757
|
end
|
604
758
|
```
|
605
759
|
|
606
|
-
|
760
|
+
#### Using the set_label_with_http_info variant
|
761
|
+
|
762
|
+
This returns an Array which contains the response data, status code and headers.
|
607
763
|
|
764
|
+
> <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(gem_gem_distribution_href, set_label)
|
608
765
|
|
609
|
-
|
610
|
-
|
611
|
-
|
612
|
-
|
766
|
+
```ruby
|
767
|
+
begin
|
768
|
+
# Set a label
|
769
|
+
data, status_code, headers = api_instance.set_label_with_http_info(gem_gem_distribution_href, set_label)
|
770
|
+
p status_code # => 2xx
|
771
|
+
p headers # => { ... }
|
772
|
+
p data # => <SetLabelResponse>
|
773
|
+
rescue PulpGemClient::ApiError => e
|
774
|
+
puts "Error when calling DistributionsGemApi->set_label_with_http_info: #{e}"
|
775
|
+
end
|
776
|
+
```
|
777
|
+
|
778
|
+
### Parameters
|
779
|
+
|
780
|
+
| Name | Type | Description | Notes |
|
781
|
+
| ---- | ---- | ----------- | ----- |
|
782
|
+
| **gem_gem_distribution_href** | **String** | | |
|
783
|
+
| **set_label** | [**SetLabel**](SetLabel.md) | | |
|
613
784
|
|
614
785
|
### Return type
|
615
786
|
|
@@ -627,16 +798,16 @@ Name | Type | Description | Notes
|
|
627
798
|
|
628
799
|
## unset_label
|
629
800
|
|
630
|
-
> UnsetLabelResponse unset_label(gem_gem_distribution_href, unset_label)
|
801
|
+
> <UnsetLabelResponse> unset_label(gem_gem_distribution_href, unset_label)
|
631
802
|
|
632
803
|
Unset a label
|
633
804
|
|
634
805
|
Unset a single pulp_label on the object.
|
635
806
|
|
636
|
-
###
|
807
|
+
### Examples
|
637
808
|
|
638
809
|
```ruby
|
639
|
-
|
810
|
+
require 'time'
|
640
811
|
require 'pulp_gem_client'
|
641
812
|
# setup authorization
|
642
813
|
PulpGemClient.configure do |config|
|
@@ -647,24 +818,41 @@ end
|
|
647
818
|
|
648
819
|
api_instance = PulpGemClient::DistributionsGemApi.new
|
649
820
|
gem_gem_distribution_href = 'gem_gem_distribution_href_example' # String |
|
650
|
-
unset_label = PulpGemClient::UnsetLabel.new # UnsetLabel |
|
821
|
+
unset_label = PulpGemClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
|
651
822
|
|
652
823
|
begin
|
653
|
-
#Unset a label
|
824
|
+
# Unset a label
|
654
825
|
result = api_instance.unset_label(gem_gem_distribution_href, unset_label)
|
655
826
|
p result
|
656
827
|
rescue PulpGemClient::ApiError => e
|
657
|
-
puts "
|
828
|
+
puts "Error when calling DistributionsGemApi->unset_label: #{e}"
|
658
829
|
end
|
659
830
|
```
|
660
831
|
|
661
|
-
|
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(gem_gem_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(gem_gem_distribution_href, unset_label)
|
842
|
+
p status_code # => 2xx
|
843
|
+
p headers # => { ... }
|
844
|
+
p data # => <UnsetLabelResponse>
|
845
|
+
rescue PulpGemClient::ApiError => e
|
846
|
+
puts "Error when calling DistributionsGemApi->unset_label_with_http_info: #{e}"
|
847
|
+
end
|
848
|
+
```
|
662
849
|
|
850
|
+
### Parameters
|
663
851
|
|
664
|
-
Name | Type | Description
|
665
|
-
|
666
|
-
**gem_gem_distribution_href** | **String
|
667
|
-
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
|
852
|
+
| Name | Type | Description | Notes |
|
853
|
+
| ---- | ---- | ----------- | ----- |
|
854
|
+
| **gem_gem_distribution_href** | **String** | | |
|
855
|
+
| **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
|
668
856
|
|
669
857
|
### Return type
|
670
858
|
|
@@ -682,16 +870,16 @@ Name | Type | Description | Notes
|
|
682
870
|
|
683
871
|
## update
|
684
872
|
|
685
|
-
> AsyncOperationResponse update(gem_gem_distribution_href, gem_gem_distribution)
|
873
|
+
> <AsyncOperationResponse> update(gem_gem_distribution_href, gem_gem_distribution)
|
686
874
|
|
687
875
|
Update a gem distribution
|
688
876
|
|
689
877
|
Trigger an asynchronous update task
|
690
878
|
|
691
|
-
###
|
879
|
+
### Examples
|
692
880
|
|
693
881
|
```ruby
|
694
|
-
|
882
|
+
require 'time'
|
695
883
|
require 'pulp_gem_client'
|
696
884
|
# setup authorization
|
697
885
|
PulpGemClient.configure do |config|
|
@@ -702,24 +890,41 @@ end
|
|
702
890
|
|
703
891
|
api_instance = PulpGemClient::DistributionsGemApi.new
|
704
892
|
gem_gem_distribution_href = 'gem_gem_distribution_href_example' # String |
|
705
|
-
gem_gem_distribution = PulpGemClient::GemGemDistribution.new # GemGemDistribution |
|
893
|
+
gem_gem_distribution = PulpGemClient::GemGemDistribution.new({base_path: 'base_path_example', name: 'name_example'}) # GemGemDistribution |
|
706
894
|
|
707
895
|
begin
|
708
|
-
#Update a gem distribution
|
896
|
+
# Update a gem distribution
|
709
897
|
result = api_instance.update(gem_gem_distribution_href, gem_gem_distribution)
|
710
898
|
p result
|
711
899
|
rescue PulpGemClient::ApiError => e
|
712
|
-
puts "
|
900
|
+
puts "Error when calling DistributionsGemApi->update: #{e}"
|
713
901
|
end
|
714
902
|
```
|
715
903
|
|
716
|
-
|
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(gem_gem_distribution_href, gem_gem_distribution)
|
717
909
|
|
910
|
+
```ruby
|
911
|
+
begin
|
912
|
+
# Update a gem distribution
|
913
|
+
data, status_code, headers = api_instance.update_with_http_info(gem_gem_distribution_href, gem_gem_distribution)
|
914
|
+
p status_code # => 2xx
|
915
|
+
p headers # => { ... }
|
916
|
+
p data # => <AsyncOperationResponse>
|
917
|
+
rescue PulpGemClient::ApiError => e
|
918
|
+
puts "Error when calling DistributionsGemApi->update_with_http_info: #{e}"
|
919
|
+
end
|
920
|
+
```
|
921
|
+
|
922
|
+
### Parameters
|
718
923
|
|
719
|
-
Name | Type | Description
|
720
|
-
|
721
|
-
**gem_gem_distribution_href** | **String
|
722
|
-
**gem_gem_distribution** | [**GemGemDistribution**](GemGemDistribution.md)| |
|
924
|
+
| Name | Type | Description | Notes |
|
925
|
+
| ---- | ---- | ----------- | ----- |
|
926
|
+
| **gem_gem_distribution_href** | **String** | | |
|
927
|
+
| **gem_gem_distribution** | [**GemGemDistribution**](GemGemDistribution.md) | | |
|
723
928
|
|
724
929
|
### Return type
|
725
930
|
|