pulp_gem_client 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +160 -0
- data/Rakefile +10 -0
- data/docs/AsyncOperationResponse.md +17 -0
- data/docs/ContentGemApi.md +210 -0
- data/docs/ContentSummaryResponse.md +21 -0
- data/docs/DistributionsGemApi.md +382 -0
- data/docs/GemGemContent.md +21 -0
- data/docs/GemGemContentResponse.md +35 -0
- data/docs/GemGemDistribution.md +31 -0
- data/docs/GemGemDistributionResponse.md +37 -0
- data/docs/GemGemPublication.md +19 -0
- data/docs/GemGemPublicationResponse.md +23 -0
- data/docs/GemGemRemote.md +63 -0
- data/docs/GemGemRemoteResponse.md +61 -0
- data/docs/GemGemRemoteResponseHiddenFields.md +19 -0
- data/docs/GemGemRepository.md +25 -0
- data/docs/GemGemRepositoryResponse.md +33 -0
- data/docs/PaginatedRepositoryVersionResponseList.md +23 -0
- data/docs/PaginatedgemGemContentResponseList.md +23 -0
- data/docs/PaginatedgemGemDistributionResponseList.md +23 -0
- data/docs/PaginatedgemGemPublicationResponseList.md +23 -0
- data/docs/PaginatedgemGemRemoteResponseList.md +23 -0
- data/docs/PaginatedgemGemRepositoryResponseList.md +23 -0
- data/docs/PatchedgemGemDistribution.md +31 -0
- data/docs/PatchedgemGemRemote.md +63 -0
- data/docs/PatchedgemGemRepository.md +25 -0
- data/docs/PolicyEnum.md +16 -0
- data/docs/PublicationsGemApi.md +263 -0
- data/docs/RemotesGemApi.md +380 -0
- data/docs/Repair.md +17 -0
- data/docs/RepositoriesGemApi.md +502 -0
- data/docs/RepositoriesGemVersionsApi.md +273 -0
- data/docs/RepositoryAddRemoveContent.md +21 -0
- data/docs/RepositorySyncURL.md +19 -0
- data/docs/RepositoryVersionResponse.md +27 -0
- data/lib/pulp_gem_client/api/content_gem_api.rb +259 -0
- data/lib/pulp_gem_client/api/distributions_gem_api.rb +476 -0
- data/lib/pulp_gem_client/api/publications_gem_api.rb +325 -0
- data/lib/pulp_gem_client/api/remotes_gem_api.rb +473 -0
- data/lib/pulp_gem_client/api/repositories_gem_api.rb +628 -0
- data/lib/pulp_gem_client/api/repositories_gem_versions_api.rb +346 -0
- data/lib/pulp_gem_client/api_client.rb +403 -0
- data/lib/pulp_gem_client/api_error.rb +57 -0
- data/lib/pulp_gem_client/configuration.rb +251 -0
- data/lib/pulp_gem_client/models/async_operation_response.rb +213 -0
- data/lib/pulp_gem_client/models/content_summary_response.rb +246 -0
- data/lib/pulp_gem_client/models/gem_gem_content.rb +228 -0
- data/lib/pulp_gem_client/models/gem_gem_content_response.rb +303 -0
- data/lib/pulp_gem_client/models/gem_gem_distribution.rb +333 -0
- data/lib/pulp_gem_client/models/gem_gem_distribution_response.rb +324 -0
- data/lib/pulp_gem_client/models/gem_gem_publication.rb +217 -0
- data/lib/pulp_gem_client/models/gem_gem_publication_response.rb +236 -0
- data/lib/pulp_gem_client/models/gem_gem_remote.rb +704 -0
- data/lib/pulp_gem_client/models/gem_gem_remote_response.rb +532 -0
- data/lib/pulp_gem_client/models/gem_gem_remote_response_hidden_fields.rb +215 -0
- data/lib/pulp_gem_client/models/gem_gem_repository.rb +306 -0
- data/lib/pulp_gem_client/models/gem_gem_repository_response.rb +309 -0
- data/lib/pulp_gem_client/models/paginated_repository_version_response_list.rb +237 -0
- data/lib/pulp_gem_client/models/paginatedgem_gem_content_response_list.rb +237 -0
- data/lib/pulp_gem_client/models/paginatedgem_gem_distribution_response_list.rb +237 -0
- data/lib/pulp_gem_client/models/paginatedgem_gem_publication_response_list.rb +237 -0
- data/lib/pulp_gem_client/models/paginatedgem_gem_remote_response_list.rb +237 -0
- data/lib/pulp_gem_client/models/paginatedgem_gem_repository_response_list.rb +237 -0
- data/lib/pulp_gem_client/models/patchedgem_gem_distribution.rb +315 -0
- data/lib/pulp_gem_client/models/patchedgem_gem_remote.rb +686 -0
- data/lib/pulp_gem_client/models/patchedgem_gem_repository.rb +297 -0
- data/lib/pulp_gem_client/models/policy_enum.rb +37 -0
- data/lib/pulp_gem_client/models/repair.rb +209 -0
- data/lib/pulp_gem_client/models/repository_add_remove_content.rb +232 -0
- data/lib/pulp_gem_client/models/repository_sync_url.rb +220 -0
- data/lib/pulp_gem_client/models/repository_version_response.rb +255 -0
- data/lib/pulp_gem_client/version.rb +15 -0
- data/lib/pulp_gem_client.rb +72 -0
- data/pulp_gem_client.gemspec +39 -0
- data/spec/api/content_gem_api_spec.rb +88 -0
- data/spec/api/distributions_gem_api_spec.rb +130 -0
- data/spec/api/publications_gem_api_spec.rb +101 -0
- data/spec/api/remotes_gem_api_spec.rb +129 -0
- data/spec/api/repositories_gem_api_spec.rb +160 -0
- data/spec/api/repositories_gem_versions_api_spec.rb +105 -0
- data/spec/api_client_spec.rb +188 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/async_operation_response_spec.rb +41 -0
- data/spec/models/content_summary_response_spec.rb +53 -0
- data/spec/models/gem_gem_content_response_spec.rb +95 -0
- data/spec/models/gem_gem_content_spec.rb +53 -0
- data/spec/models/gem_gem_distribution_response_spec.rb +101 -0
- data/spec/models/gem_gem_distribution_spec.rb +83 -0
- data/spec/models/gem_gem_publication_response_spec.rb +59 -0
- data/spec/models/gem_gem_publication_spec.rb +47 -0
- data/spec/models/gem_gem_remote_response_hidden_fields_spec.rb +47 -0
- data/spec/models/gem_gem_remote_response_spec.rb +173 -0
- data/spec/models/gem_gem_remote_spec.rb +179 -0
- data/spec/models/gem_gem_repository_response_spec.rb +89 -0
- data/spec/models/gem_gem_repository_spec.rb +65 -0
- data/spec/models/paginated_repository_version_response_list_spec.rb +59 -0
- data/spec/models/paginatedgem_gem_content_response_list_spec.rb +59 -0
- data/spec/models/paginatedgem_gem_distribution_response_list_spec.rb +59 -0
- data/spec/models/paginatedgem_gem_publication_response_list_spec.rb +59 -0
- data/spec/models/paginatedgem_gem_remote_response_list_spec.rb +59 -0
- data/spec/models/paginatedgem_gem_repository_response_list_spec.rb +59 -0
- data/spec/models/patchedgem_gem_distribution_spec.rb +83 -0
- data/spec/models/patchedgem_gem_remote_spec.rb +179 -0
- data/spec/models/patchedgem_gem_repository_spec.rb +65 -0
- data/spec/models/policy_enum_spec.rb +35 -0
- data/spec/models/repair_spec.rb +41 -0
- data/spec/models/repository_add_remove_content_spec.rb +53 -0
- data/spec/models/repository_sync_url_spec.rb +47 -0
- data/spec/models/repository_version_response_spec.rb +71 -0
- data/spec/spec_helper.rb +111 -0
- metadata +250 -0
@@ -0,0 +1,382 @@
|
|
1
|
+
# PulpGemClient::DistributionsGemApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pulp*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create**](DistributionsGemApi.md#create) | **POST** /pulp/api/v3/distributions/gem/gem/ | Create a gem distribution
|
8
|
+
[**delete**](DistributionsGemApi.md#delete) | **DELETE** {gem_gem_distribution_href} | Delete a gem distribution
|
9
|
+
[**list**](DistributionsGemApi.md#list) | **GET** /pulp/api/v3/distributions/gem/gem/ | List gem distributions
|
10
|
+
[**partial_update**](DistributionsGemApi.md#partial_update) | **PATCH** {gem_gem_distribution_href} | Update a gem distribution
|
11
|
+
[**read**](DistributionsGemApi.md#read) | **GET** {gem_gem_distribution_href} | Inspect a gem distribution
|
12
|
+
[**update**](DistributionsGemApi.md#update) | **PUT** {gem_gem_distribution_href} | Update a gem distribution
|
13
|
+
|
14
|
+
|
15
|
+
|
16
|
+
## create
|
17
|
+
|
18
|
+
> AsyncOperationResponse create(gem_gem_distribution)
|
19
|
+
|
20
|
+
Create a gem distribution
|
21
|
+
|
22
|
+
Trigger an asynchronous create task
|
23
|
+
|
24
|
+
### Example
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
# load the gem
|
28
|
+
require 'pulp_gem_client'
|
29
|
+
# setup authorization
|
30
|
+
PulpGemClient.configure do |config|
|
31
|
+
# Configure HTTP basic authorization: basicAuth
|
32
|
+
config.username = 'YOUR USERNAME'
|
33
|
+
config.password = 'YOUR PASSWORD'
|
34
|
+
end
|
35
|
+
|
36
|
+
api_instance = PulpGemClient::DistributionsGemApi.new
|
37
|
+
gem_gem_distribution = PulpGemClient::GemGemDistribution.new # GemGemDistribution |
|
38
|
+
|
39
|
+
begin
|
40
|
+
#Create a gem distribution
|
41
|
+
result = api_instance.create(gem_gem_distribution)
|
42
|
+
p result
|
43
|
+
rescue PulpGemClient::ApiError => e
|
44
|
+
puts "Exception when calling DistributionsGemApi->create: #{e}"
|
45
|
+
end
|
46
|
+
```
|
47
|
+
|
48
|
+
### Parameters
|
49
|
+
|
50
|
+
|
51
|
+
Name | Type | Description | Notes
|
52
|
+
------------- | ------------- | ------------- | -------------
|
53
|
+
**gem_gem_distribution** | [**GemGemDistribution**](GemGemDistribution.md)| |
|
54
|
+
|
55
|
+
### Return type
|
56
|
+
|
57
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
58
|
+
|
59
|
+
### Authorization
|
60
|
+
|
61
|
+
[basicAuth](../README.md#basicAuth)
|
62
|
+
|
63
|
+
### HTTP request headers
|
64
|
+
|
65
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
66
|
+
- **Accept**: application/json
|
67
|
+
|
68
|
+
|
69
|
+
## delete
|
70
|
+
|
71
|
+
> AsyncOperationResponse delete(gem_gem_distribution_href)
|
72
|
+
|
73
|
+
Delete a gem distribution
|
74
|
+
|
75
|
+
Trigger an asynchronous delete task
|
76
|
+
|
77
|
+
### Example
|
78
|
+
|
79
|
+
```ruby
|
80
|
+
# load the gem
|
81
|
+
require 'pulp_gem_client'
|
82
|
+
# setup authorization
|
83
|
+
PulpGemClient.configure do |config|
|
84
|
+
# Configure HTTP basic authorization: basicAuth
|
85
|
+
config.username = 'YOUR USERNAME'
|
86
|
+
config.password = 'YOUR PASSWORD'
|
87
|
+
end
|
88
|
+
|
89
|
+
api_instance = PulpGemClient::DistributionsGemApi.new
|
90
|
+
gem_gem_distribution_href = 'gem_gem_distribution_href_example' # String |
|
91
|
+
|
92
|
+
begin
|
93
|
+
#Delete a gem distribution
|
94
|
+
result = api_instance.delete(gem_gem_distribution_href)
|
95
|
+
p result
|
96
|
+
rescue PulpGemClient::ApiError => e
|
97
|
+
puts "Exception when calling DistributionsGemApi->delete: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
### Parameters
|
102
|
+
|
103
|
+
|
104
|
+
Name | Type | Description | Notes
|
105
|
+
------------- | ------------- | ------------- | -------------
|
106
|
+
**gem_gem_distribution_href** | **String**| |
|
107
|
+
|
108
|
+
### Return type
|
109
|
+
|
110
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
111
|
+
|
112
|
+
### Authorization
|
113
|
+
|
114
|
+
[basicAuth](../README.md#basicAuth)
|
115
|
+
|
116
|
+
### HTTP request headers
|
117
|
+
|
118
|
+
- **Content-Type**: Not defined
|
119
|
+
- **Accept**: application/json
|
120
|
+
|
121
|
+
|
122
|
+
## list
|
123
|
+
|
124
|
+
> PaginatedgemGemDistributionResponseList list(opts)
|
125
|
+
|
126
|
+
List gem distributions
|
127
|
+
|
128
|
+
ViewSet for GemDistributions.
|
129
|
+
|
130
|
+
### Example
|
131
|
+
|
132
|
+
```ruby
|
133
|
+
# load the gem
|
134
|
+
require 'pulp_gem_client'
|
135
|
+
# setup authorization
|
136
|
+
PulpGemClient.configure do |config|
|
137
|
+
# Configure HTTP basic authorization: basicAuth
|
138
|
+
config.username = 'YOUR USERNAME'
|
139
|
+
config.password = 'YOUR PASSWORD'
|
140
|
+
end
|
141
|
+
|
142
|
+
api_instance = PulpGemClient::DistributionsGemApi.new
|
143
|
+
opts = {
|
144
|
+
base_path: 'base_path_example', # String | Filter results where base_path matches value
|
145
|
+
base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
|
146
|
+
base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
|
147
|
+
base_path__in: ['base_path__in_example'], # Array<String> | Filter results where base_path is in a comma-separated list of values
|
148
|
+
limit: 56, # Integer | Number of results to return per page.
|
149
|
+
name: 'name_example', # String | Filter results where name matches value
|
150
|
+
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
151
|
+
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
152
|
+
name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
153
|
+
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
154
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
155
|
+
ordering: ['ordering_example'], # 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)
|
156
|
+
pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
|
157
|
+
pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
|
158
|
+
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
159
|
+
repository: 'repository_example', # String | Filter results where repository matches value
|
160
|
+
repository__in: ['repository__in_example'], # Array<String> | Filter results where repository is in a comma-separated list of values
|
161
|
+
with_content: 'with_content_example', # String | Filter distributions based on the content served by them
|
162
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
163
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
164
|
+
}
|
165
|
+
|
166
|
+
begin
|
167
|
+
#List gem distributions
|
168
|
+
result = api_instance.list(opts)
|
169
|
+
p result
|
170
|
+
rescue PulpGemClient::ApiError => e
|
171
|
+
puts "Exception when calling DistributionsGemApi->list: #{e}"
|
172
|
+
end
|
173
|
+
```
|
174
|
+
|
175
|
+
### Parameters
|
176
|
+
|
177
|
+
|
178
|
+
Name | Type | Description | Notes
|
179
|
+
------------- | ------------- | ------------- | -------------
|
180
|
+
**base_path** | **String**| Filter results where base_path matches value | [optional]
|
181
|
+
**base_path__contains** | **String**| Filter results where base_path contains value | [optional]
|
182
|
+
**base_path__icontains** | **String**| Filter results where base_path contains value | [optional]
|
183
|
+
**base_path__in** | [**Array<String>**](String.md)| Filter results where base_path is in a comma-separated list of values | [optional]
|
184
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
185
|
+
**name** | **String**| Filter results where name matches value | [optional]
|
186
|
+
**name__contains** | **String**| Filter results where name contains value | [optional]
|
187
|
+
**name__icontains** | **String**| Filter results where name contains value | [optional]
|
188
|
+
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
189
|
+
**name__startswith** | **String**| Filter results where name starts with value | [optional]
|
190
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
191
|
+
**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]
|
192
|
+
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
193
|
+
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
194
|
+
**pulp_label_select** | **String**| Filter labels by search string | [optional]
|
195
|
+
**repository** | **String**| Filter results where repository matches value | [optional]
|
196
|
+
**repository__in** | [**Array<String>**](String.md)| Filter results where repository is in a comma-separated list of values | [optional]
|
197
|
+
**with_content** | **String**| Filter distributions based on the content served by them | [optional]
|
198
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
199
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
200
|
+
|
201
|
+
### Return type
|
202
|
+
|
203
|
+
[**PaginatedgemGemDistributionResponseList**](PaginatedgemGemDistributionResponseList.md)
|
204
|
+
|
205
|
+
### Authorization
|
206
|
+
|
207
|
+
[basicAuth](../README.md#basicAuth)
|
208
|
+
|
209
|
+
### HTTP request headers
|
210
|
+
|
211
|
+
- **Content-Type**: Not defined
|
212
|
+
- **Accept**: application/json
|
213
|
+
|
214
|
+
|
215
|
+
## partial_update
|
216
|
+
|
217
|
+
> AsyncOperationResponse partial_update(gem_gem_distribution_href, patchedgem_gem_distribution)
|
218
|
+
|
219
|
+
Update a gem distribution
|
220
|
+
|
221
|
+
Trigger an asynchronous partial update task
|
222
|
+
|
223
|
+
### Example
|
224
|
+
|
225
|
+
```ruby
|
226
|
+
# load the gem
|
227
|
+
require 'pulp_gem_client'
|
228
|
+
# setup authorization
|
229
|
+
PulpGemClient.configure do |config|
|
230
|
+
# Configure HTTP basic authorization: basicAuth
|
231
|
+
config.username = 'YOUR USERNAME'
|
232
|
+
config.password = 'YOUR PASSWORD'
|
233
|
+
end
|
234
|
+
|
235
|
+
api_instance = PulpGemClient::DistributionsGemApi.new
|
236
|
+
gem_gem_distribution_href = 'gem_gem_distribution_href_example' # String |
|
237
|
+
patchedgem_gem_distribution = PulpGemClient::PatchedgemGemDistribution.new # PatchedgemGemDistribution |
|
238
|
+
|
239
|
+
begin
|
240
|
+
#Update a gem distribution
|
241
|
+
result = api_instance.partial_update(gem_gem_distribution_href, patchedgem_gem_distribution)
|
242
|
+
p result
|
243
|
+
rescue PulpGemClient::ApiError => e
|
244
|
+
puts "Exception when calling DistributionsGemApi->partial_update: #{e}"
|
245
|
+
end
|
246
|
+
```
|
247
|
+
|
248
|
+
### Parameters
|
249
|
+
|
250
|
+
|
251
|
+
Name | Type | Description | Notes
|
252
|
+
------------- | ------------- | ------------- | -------------
|
253
|
+
**gem_gem_distribution_href** | **String**| |
|
254
|
+
**patchedgem_gem_distribution** | [**PatchedgemGemDistribution**](PatchedgemGemDistribution.md)| |
|
255
|
+
|
256
|
+
### Return type
|
257
|
+
|
258
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
259
|
+
|
260
|
+
### Authorization
|
261
|
+
|
262
|
+
[basicAuth](../README.md#basicAuth)
|
263
|
+
|
264
|
+
### HTTP request headers
|
265
|
+
|
266
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
267
|
+
- **Accept**: application/json
|
268
|
+
|
269
|
+
|
270
|
+
## read
|
271
|
+
|
272
|
+
> GemGemDistributionResponse read(gem_gem_distribution_href, opts)
|
273
|
+
|
274
|
+
Inspect a gem distribution
|
275
|
+
|
276
|
+
ViewSet for GemDistributions.
|
277
|
+
|
278
|
+
### Example
|
279
|
+
|
280
|
+
```ruby
|
281
|
+
# load the gem
|
282
|
+
require 'pulp_gem_client'
|
283
|
+
# setup authorization
|
284
|
+
PulpGemClient.configure do |config|
|
285
|
+
# Configure HTTP basic authorization: basicAuth
|
286
|
+
config.username = 'YOUR USERNAME'
|
287
|
+
config.password = 'YOUR PASSWORD'
|
288
|
+
end
|
289
|
+
|
290
|
+
api_instance = PulpGemClient::DistributionsGemApi.new
|
291
|
+
gem_gem_distribution_href = 'gem_gem_distribution_href_example' # String |
|
292
|
+
opts = {
|
293
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
294
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
295
|
+
}
|
296
|
+
|
297
|
+
begin
|
298
|
+
#Inspect a gem distribution
|
299
|
+
result = api_instance.read(gem_gem_distribution_href, opts)
|
300
|
+
p result
|
301
|
+
rescue PulpGemClient::ApiError => e
|
302
|
+
puts "Exception when calling DistributionsGemApi->read: #{e}"
|
303
|
+
end
|
304
|
+
```
|
305
|
+
|
306
|
+
### Parameters
|
307
|
+
|
308
|
+
|
309
|
+
Name | Type | Description | Notes
|
310
|
+
------------- | ------------- | ------------- | -------------
|
311
|
+
**gem_gem_distribution_href** | **String**| |
|
312
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
313
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
314
|
+
|
315
|
+
### Return type
|
316
|
+
|
317
|
+
[**GemGemDistributionResponse**](GemGemDistributionResponse.md)
|
318
|
+
|
319
|
+
### Authorization
|
320
|
+
|
321
|
+
[basicAuth](../README.md#basicAuth)
|
322
|
+
|
323
|
+
### HTTP request headers
|
324
|
+
|
325
|
+
- **Content-Type**: Not defined
|
326
|
+
- **Accept**: application/json
|
327
|
+
|
328
|
+
|
329
|
+
## update
|
330
|
+
|
331
|
+
> AsyncOperationResponse update(gem_gem_distribution_href, gem_gem_distribution)
|
332
|
+
|
333
|
+
Update a gem distribution
|
334
|
+
|
335
|
+
Trigger an asynchronous update task
|
336
|
+
|
337
|
+
### Example
|
338
|
+
|
339
|
+
```ruby
|
340
|
+
# load the gem
|
341
|
+
require 'pulp_gem_client'
|
342
|
+
# setup authorization
|
343
|
+
PulpGemClient.configure do |config|
|
344
|
+
# Configure HTTP basic authorization: basicAuth
|
345
|
+
config.username = 'YOUR USERNAME'
|
346
|
+
config.password = 'YOUR PASSWORD'
|
347
|
+
end
|
348
|
+
|
349
|
+
api_instance = PulpGemClient::DistributionsGemApi.new
|
350
|
+
gem_gem_distribution_href = 'gem_gem_distribution_href_example' # String |
|
351
|
+
gem_gem_distribution = PulpGemClient::GemGemDistribution.new # GemGemDistribution |
|
352
|
+
|
353
|
+
begin
|
354
|
+
#Update a gem distribution
|
355
|
+
result = api_instance.update(gem_gem_distribution_href, gem_gem_distribution)
|
356
|
+
p result
|
357
|
+
rescue PulpGemClient::ApiError => e
|
358
|
+
puts "Exception when calling DistributionsGemApi->update: #{e}"
|
359
|
+
end
|
360
|
+
```
|
361
|
+
|
362
|
+
### Parameters
|
363
|
+
|
364
|
+
|
365
|
+
Name | Type | Description | Notes
|
366
|
+
------------- | ------------- | ------------- | -------------
|
367
|
+
**gem_gem_distribution_href** | **String**| |
|
368
|
+
**gem_gem_distribution** | [**GemGemDistribution**](GemGemDistribution.md)| |
|
369
|
+
|
370
|
+
### Return type
|
371
|
+
|
372
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
373
|
+
|
374
|
+
### Authorization
|
375
|
+
|
376
|
+
[basicAuth](../README.md#basicAuth)
|
377
|
+
|
378
|
+
### HTTP request headers
|
379
|
+
|
380
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
381
|
+
- **Accept**: application/json
|
382
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# PulpGemClient::GemGemContent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**artifact** | **String** | Artifact file representing the physical content | [optional]
|
8
|
+
**file** | **File** | An uploaded file that should be turned into the artifact of the content unit. | [optional]
|
9
|
+
**repository** | **String** | A URI of a repository the new content unit should be associated with. | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'PulpGemClient'
|
15
|
+
|
16
|
+
instance = PulpGemClient::GemGemContent.new(artifact: null,
|
17
|
+
file: null,
|
18
|
+
repository: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,35 @@
|
|
1
|
+
# PulpGemClient::GemGemContentResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**pulp_href** | **String** | | [optional] [readonly]
|
8
|
+
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
9
|
+
**artifacts** | [**Object**](.md) | A dict mapping relative paths inside the Content to the correspondingArtifact URLs. E.g.: {'relative/path': '/artifacts/1/' | [readonly]
|
10
|
+
**checksum** | **String** | SHA256 checksum of the gem | [optional] [readonly]
|
11
|
+
**name** | **String** | Name of the gem | [optional] [readonly]
|
12
|
+
**version** | **String** | Version of the gem | [optional] [readonly]
|
13
|
+
**prerelease** | **Boolean** | Whether the gem is a prerelease | [optional] [readonly]
|
14
|
+
**dependencies** | **Hash<String, String>** | | [optional] [readonly]
|
15
|
+
**required_ruby_version** | **String** | Required ruby version of the gem | [optional] [readonly]
|
16
|
+
**required_rubygems_version** | **String** | Required rubygems version of the gem | [optional] [readonly]
|
17
|
+
|
18
|
+
## Code Sample
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'PulpGemClient'
|
22
|
+
|
23
|
+
instance = PulpGemClient::GemGemContentResponse.new(pulp_href: null,
|
24
|
+
pulp_created: null,
|
25
|
+
artifacts: null,
|
26
|
+
checksum: null,
|
27
|
+
name: null,
|
28
|
+
version: null,
|
29
|
+
prerelease: null,
|
30
|
+
dependencies: null,
|
31
|
+
required_ruby_version: null,
|
32
|
+
required_rubygems_version: null)
|
33
|
+
```
|
34
|
+
|
35
|
+
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# PulpGemClient::GemGemDistribution
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |
|
8
|
+
**content_guard** | **String** | An optional content-guard. | [optional]
|
9
|
+
**hidden** | **Boolean** | Whether this distribution should be shown in the content app. | [optional] [default to false]
|
10
|
+
**pulp_labels** | **Hash<String, String>** | | [optional]
|
11
|
+
**name** | **String** | A unique name. Ex, `rawhide` and `stable`. |
|
12
|
+
**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
|
13
|
+
**publication** | **String** | Publication to be served | [optional]
|
14
|
+
**remote** | **String** | Remote that can be used to fetch content when using pull-through caching. | [optional]
|
15
|
+
|
16
|
+
## Code Sample
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'PulpGemClient'
|
20
|
+
|
21
|
+
instance = PulpGemClient::GemGemDistribution.new(base_path: null,
|
22
|
+
content_guard: null,
|
23
|
+
hidden: null,
|
24
|
+
pulp_labels: null,
|
25
|
+
name: null,
|
26
|
+
repository: null,
|
27
|
+
publication: null,
|
28
|
+
remote: null)
|
29
|
+
```
|
30
|
+
|
31
|
+
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# PulpGemClient::GemGemDistributionResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**pulp_href** | **String** | | [optional] [readonly]
|
8
|
+
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
9
|
+
**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |
|
10
|
+
**base_url** | **String** | The URL for accessing the publication as defined by this distribution. | [optional] [readonly]
|
11
|
+
**content_guard** | **String** | An optional content-guard. | [optional]
|
12
|
+
**hidden** | **Boolean** | Whether this distribution should be shown in the content app. | [optional] [default to false]
|
13
|
+
**pulp_labels** | **Hash<String, String>** | | [optional]
|
14
|
+
**name** | **String** | A unique name. Ex, `rawhide` and `stable`. |
|
15
|
+
**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
|
16
|
+
**publication** | **String** | Publication to be served | [optional]
|
17
|
+
**remote** | **String** | Remote that can be used to fetch content when using pull-through caching. | [optional]
|
18
|
+
|
19
|
+
## Code Sample
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'PulpGemClient'
|
23
|
+
|
24
|
+
instance = PulpGemClient::GemGemDistributionResponse.new(pulp_href: null,
|
25
|
+
pulp_created: null,
|
26
|
+
base_path: null,
|
27
|
+
base_url: null,
|
28
|
+
content_guard: null,
|
29
|
+
hidden: null,
|
30
|
+
pulp_labels: null,
|
31
|
+
name: null,
|
32
|
+
repository: null,
|
33
|
+
publication: null,
|
34
|
+
remote: null)
|
35
|
+
```
|
36
|
+
|
37
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# PulpGemClient::GemGemPublication
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**repository_version** | **String** | | [optional]
|
8
|
+
**repository** | **String** | A URI of the repository to be published. | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'PulpGemClient'
|
14
|
+
|
15
|
+
instance = PulpGemClient::GemGemPublication.new(repository_version: null,
|
16
|
+
repository: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpGemClient::GemGemPublicationResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**pulp_href** | **String** | | [optional] [readonly]
|
8
|
+
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
9
|
+
**repository_version** | **String** | | [optional]
|
10
|
+
**repository** | **String** | A URI of the repository to be published. | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpGemClient'
|
16
|
+
|
17
|
+
instance = PulpGemClient::GemGemPublicationResponse.new(pulp_href: null,
|
18
|
+
pulp_created: null,
|
19
|
+
repository_version: null,
|
20
|
+
repository: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,63 @@
|
|
1
|
+
# PulpGemClient::GemGemRemote
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | A unique name for this remote. |
|
8
|
+
**url** | **String** | The URL of an external content source. |
|
9
|
+
**ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
|
10
|
+
**client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional]
|
11
|
+
**client_key** | **String** | A PEM encoded private key used for authentication. | [optional]
|
12
|
+
**tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional]
|
13
|
+
**proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional]
|
14
|
+
**proxy_username** | **String** | The username to authenticte to the proxy. | [optional]
|
15
|
+
**proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional]
|
16
|
+
**username** | **String** | The username to be used for authentication when syncing. | [optional]
|
17
|
+
**password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional]
|
18
|
+
**pulp_labels** | **Hash<String, String>** | | [optional]
|
19
|
+
**download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
|
20
|
+
**max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional]
|
21
|
+
**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional]
|
22
|
+
**total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
|
23
|
+
**connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
|
24
|
+
**sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
|
25
|
+
**sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
|
26
|
+
**headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional]
|
27
|
+
**rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional]
|
28
|
+
**prereleases** | **Boolean** | | [optional] [default to false]
|
29
|
+
**includes** | **Hash<String, String>** | | [optional]
|
30
|
+
**excludes** | **Hash<String, String>** | | [optional]
|
31
|
+
|
32
|
+
## Code Sample
|
33
|
+
|
34
|
+
```ruby
|
35
|
+
require 'PulpGemClient'
|
36
|
+
|
37
|
+
instance = PulpGemClient::GemGemRemote.new(name: null,
|
38
|
+
url: null,
|
39
|
+
ca_cert: null,
|
40
|
+
client_cert: null,
|
41
|
+
client_key: null,
|
42
|
+
tls_validation: null,
|
43
|
+
proxy_url: null,
|
44
|
+
proxy_username: null,
|
45
|
+
proxy_password: null,
|
46
|
+
username: null,
|
47
|
+
password: null,
|
48
|
+
pulp_labels: null,
|
49
|
+
download_concurrency: null,
|
50
|
+
max_retries: null,
|
51
|
+
policy: null,
|
52
|
+
total_timeout: null,
|
53
|
+
connect_timeout: null,
|
54
|
+
sock_connect_timeout: null,
|
55
|
+
sock_read_timeout: null,
|
56
|
+
headers: null,
|
57
|
+
rate_limit: null,
|
58
|
+
prereleases: null,
|
59
|
+
includes: null,
|
60
|
+
excludes: null)
|
61
|
+
```
|
62
|
+
|
63
|
+
|