pulp_gem_client 0.1.0

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.
Files changed (113) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +160 -0
  4. data/Rakefile +10 -0
  5. data/docs/AsyncOperationResponse.md +17 -0
  6. data/docs/ContentGemApi.md +210 -0
  7. data/docs/ContentSummaryResponse.md +21 -0
  8. data/docs/DistributionsGemApi.md +382 -0
  9. data/docs/GemGemContent.md +21 -0
  10. data/docs/GemGemContentResponse.md +35 -0
  11. data/docs/GemGemDistribution.md +31 -0
  12. data/docs/GemGemDistributionResponse.md +37 -0
  13. data/docs/GemGemPublication.md +19 -0
  14. data/docs/GemGemPublicationResponse.md +23 -0
  15. data/docs/GemGemRemote.md +63 -0
  16. data/docs/GemGemRemoteResponse.md +61 -0
  17. data/docs/GemGemRemoteResponseHiddenFields.md +19 -0
  18. data/docs/GemGemRepository.md +25 -0
  19. data/docs/GemGemRepositoryResponse.md +33 -0
  20. data/docs/PaginatedRepositoryVersionResponseList.md +23 -0
  21. data/docs/PaginatedgemGemContentResponseList.md +23 -0
  22. data/docs/PaginatedgemGemDistributionResponseList.md +23 -0
  23. data/docs/PaginatedgemGemPublicationResponseList.md +23 -0
  24. data/docs/PaginatedgemGemRemoteResponseList.md +23 -0
  25. data/docs/PaginatedgemGemRepositoryResponseList.md +23 -0
  26. data/docs/PatchedgemGemDistribution.md +31 -0
  27. data/docs/PatchedgemGemRemote.md +63 -0
  28. data/docs/PatchedgemGemRepository.md +25 -0
  29. data/docs/PolicyEnum.md +16 -0
  30. data/docs/PublicationsGemApi.md +263 -0
  31. data/docs/RemotesGemApi.md +380 -0
  32. data/docs/Repair.md +17 -0
  33. data/docs/RepositoriesGemApi.md +502 -0
  34. data/docs/RepositoriesGemVersionsApi.md +273 -0
  35. data/docs/RepositoryAddRemoveContent.md +21 -0
  36. data/docs/RepositorySyncURL.md +19 -0
  37. data/docs/RepositoryVersionResponse.md +27 -0
  38. data/lib/pulp_gem_client/api/content_gem_api.rb +259 -0
  39. data/lib/pulp_gem_client/api/distributions_gem_api.rb +476 -0
  40. data/lib/pulp_gem_client/api/publications_gem_api.rb +325 -0
  41. data/lib/pulp_gem_client/api/remotes_gem_api.rb +473 -0
  42. data/lib/pulp_gem_client/api/repositories_gem_api.rb +628 -0
  43. data/lib/pulp_gem_client/api/repositories_gem_versions_api.rb +346 -0
  44. data/lib/pulp_gem_client/api_client.rb +403 -0
  45. data/lib/pulp_gem_client/api_error.rb +57 -0
  46. data/lib/pulp_gem_client/configuration.rb +251 -0
  47. data/lib/pulp_gem_client/models/async_operation_response.rb +213 -0
  48. data/lib/pulp_gem_client/models/content_summary_response.rb +246 -0
  49. data/lib/pulp_gem_client/models/gem_gem_content.rb +228 -0
  50. data/lib/pulp_gem_client/models/gem_gem_content_response.rb +303 -0
  51. data/lib/pulp_gem_client/models/gem_gem_distribution.rb +333 -0
  52. data/lib/pulp_gem_client/models/gem_gem_distribution_response.rb +324 -0
  53. data/lib/pulp_gem_client/models/gem_gem_publication.rb +217 -0
  54. data/lib/pulp_gem_client/models/gem_gem_publication_response.rb +236 -0
  55. data/lib/pulp_gem_client/models/gem_gem_remote.rb +704 -0
  56. data/lib/pulp_gem_client/models/gem_gem_remote_response.rb +532 -0
  57. data/lib/pulp_gem_client/models/gem_gem_remote_response_hidden_fields.rb +215 -0
  58. data/lib/pulp_gem_client/models/gem_gem_repository.rb +306 -0
  59. data/lib/pulp_gem_client/models/gem_gem_repository_response.rb +309 -0
  60. data/lib/pulp_gem_client/models/paginated_repository_version_response_list.rb +237 -0
  61. data/lib/pulp_gem_client/models/paginatedgem_gem_content_response_list.rb +237 -0
  62. data/lib/pulp_gem_client/models/paginatedgem_gem_distribution_response_list.rb +237 -0
  63. data/lib/pulp_gem_client/models/paginatedgem_gem_publication_response_list.rb +237 -0
  64. data/lib/pulp_gem_client/models/paginatedgem_gem_remote_response_list.rb +237 -0
  65. data/lib/pulp_gem_client/models/paginatedgem_gem_repository_response_list.rb +237 -0
  66. data/lib/pulp_gem_client/models/patchedgem_gem_distribution.rb +315 -0
  67. data/lib/pulp_gem_client/models/patchedgem_gem_remote.rb +686 -0
  68. data/lib/pulp_gem_client/models/patchedgem_gem_repository.rb +297 -0
  69. data/lib/pulp_gem_client/models/policy_enum.rb +37 -0
  70. data/lib/pulp_gem_client/models/repair.rb +209 -0
  71. data/lib/pulp_gem_client/models/repository_add_remove_content.rb +232 -0
  72. data/lib/pulp_gem_client/models/repository_sync_url.rb +220 -0
  73. data/lib/pulp_gem_client/models/repository_version_response.rb +255 -0
  74. data/lib/pulp_gem_client/version.rb +15 -0
  75. data/lib/pulp_gem_client.rb +72 -0
  76. data/pulp_gem_client.gemspec +39 -0
  77. data/spec/api/content_gem_api_spec.rb +88 -0
  78. data/spec/api/distributions_gem_api_spec.rb +130 -0
  79. data/spec/api/publications_gem_api_spec.rb +101 -0
  80. data/spec/api/remotes_gem_api_spec.rb +129 -0
  81. data/spec/api/repositories_gem_api_spec.rb +160 -0
  82. data/spec/api/repositories_gem_versions_api_spec.rb +105 -0
  83. data/spec/api_client_spec.rb +188 -0
  84. data/spec/configuration_spec.rb +42 -0
  85. data/spec/models/async_operation_response_spec.rb +41 -0
  86. data/spec/models/content_summary_response_spec.rb +53 -0
  87. data/spec/models/gem_gem_content_response_spec.rb +95 -0
  88. data/spec/models/gem_gem_content_spec.rb +53 -0
  89. data/spec/models/gem_gem_distribution_response_spec.rb +101 -0
  90. data/spec/models/gem_gem_distribution_spec.rb +83 -0
  91. data/spec/models/gem_gem_publication_response_spec.rb +59 -0
  92. data/spec/models/gem_gem_publication_spec.rb +47 -0
  93. data/spec/models/gem_gem_remote_response_hidden_fields_spec.rb +47 -0
  94. data/spec/models/gem_gem_remote_response_spec.rb +173 -0
  95. data/spec/models/gem_gem_remote_spec.rb +179 -0
  96. data/spec/models/gem_gem_repository_response_spec.rb +89 -0
  97. data/spec/models/gem_gem_repository_spec.rb +65 -0
  98. data/spec/models/paginated_repository_version_response_list_spec.rb +59 -0
  99. data/spec/models/paginatedgem_gem_content_response_list_spec.rb +59 -0
  100. data/spec/models/paginatedgem_gem_distribution_response_list_spec.rb +59 -0
  101. data/spec/models/paginatedgem_gem_publication_response_list_spec.rb +59 -0
  102. data/spec/models/paginatedgem_gem_remote_response_list_spec.rb +59 -0
  103. data/spec/models/paginatedgem_gem_repository_response_list_spec.rb +59 -0
  104. data/spec/models/patchedgem_gem_distribution_spec.rb +83 -0
  105. data/spec/models/patchedgem_gem_remote_spec.rb +179 -0
  106. data/spec/models/patchedgem_gem_repository_spec.rb +65 -0
  107. data/spec/models/policy_enum_spec.rb +35 -0
  108. data/spec/models/repair_spec.rb +41 -0
  109. data/spec/models/repository_add_remove_content_spec.rb +53 -0
  110. data/spec/models/repository_sync_url_spec.rb +47 -0
  111. data/spec/models/repository_version_response_spec.rb +71 -0
  112. data/spec/spec_helper.rb +111 -0
  113. metadata +250 -0
@@ -0,0 +1,263 @@
1
+ # PulpGemClient::PublicationsGemApi
2
+
3
+ All URIs are relative to *https://pulp*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create**](PublicationsGemApi.md#create) | **POST** /pulp/api/v3/publications/gem/gem/ | Create a gem publication
8
+ [**delete**](PublicationsGemApi.md#delete) | **DELETE** {gem_gem_publication_href} | Delete a gem publication
9
+ [**list**](PublicationsGemApi.md#list) | **GET** /pulp/api/v3/publications/gem/gem/ | List gem publications
10
+ [**read**](PublicationsGemApi.md#read) | **GET** {gem_gem_publication_href} | Inspect a gem publication
11
+
12
+
13
+
14
+ ## create
15
+
16
+ > AsyncOperationResponse create(gem_gem_publication)
17
+
18
+ Create a gem publication
19
+
20
+ Trigger an asynchronous task to publish gem content
21
+
22
+ ### Example
23
+
24
+ ```ruby
25
+ # load the gem
26
+ require 'pulp_gem_client'
27
+ # setup authorization
28
+ PulpGemClient.configure do |config|
29
+ # Configure HTTP basic authorization: basicAuth
30
+ config.username = 'YOUR USERNAME'
31
+ config.password = 'YOUR PASSWORD'
32
+ end
33
+
34
+ api_instance = PulpGemClient::PublicationsGemApi.new
35
+ gem_gem_publication = PulpGemClient::GemGemPublication.new # GemGemPublication |
36
+
37
+ begin
38
+ #Create a gem publication
39
+ result = api_instance.create(gem_gem_publication)
40
+ p result
41
+ rescue PulpGemClient::ApiError => e
42
+ puts "Exception when calling PublicationsGemApi->create: #{e}"
43
+ end
44
+ ```
45
+
46
+ ### Parameters
47
+
48
+
49
+ Name | Type | Description | Notes
50
+ ------------- | ------------- | ------------- | -------------
51
+ **gem_gem_publication** | [**GemGemPublication**](GemGemPublication.md)| |
52
+
53
+ ### Return type
54
+
55
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
56
+
57
+ ### Authorization
58
+
59
+ [basicAuth](../README.md#basicAuth)
60
+
61
+ ### HTTP request headers
62
+
63
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
64
+ - **Accept**: application/json
65
+
66
+
67
+ ## delete
68
+
69
+ > delete(gem_gem_publication_href)
70
+
71
+ Delete a gem publication
72
+
73
+ A ViewSet for GemPublication.
74
+
75
+ ### Example
76
+
77
+ ```ruby
78
+ # load the gem
79
+ require 'pulp_gem_client'
80
+ # setup authorization
81
+ PulpGemClient.configure do |config|
82
+ # Configure HTTP basic authorization: basicAuth
83
+ config.username = 'YOUR USERNAME'
84
+ config.password = 'YOUR PASSWORD'
85
+ end
86
+
87
+ api_instance = PulpGemClient::PublicationsGemApi.new
88
+ gem_gem_publication_href = 'gem_gem_publication_href_example' # String |
89
+
90
+ begin
91
+ #Delete a gem publication
92
+ api_instance.delete(gem_gem_publication_href)
93
+ rescue PulpGemClient::ApiError => e
94
+ puts "Exception when calling PublicationsGemApi->delete: #{e}"
95
+ end
96
+ ```
97
+
98
+ ### Parameters
99
+
100
+
101
+ Name | Type | Description | Notes
102
+ ------------- | ------------- | ------------- | -------------
103
+ **gem_gem_publication_href** | **String**| |
104
+
105
+ ### Return type
106
+
107
+ nil (empty response body)
108
+
109
+ ### Authorization
110
+
111
+ [basicAuth](../README.md#basicAuth)
112
+
113
+ ### HTTP request headers
114
+
115
+ - **Content-Type**: Not defined
116
+ - **Accept**: Not defined
117
+
118
+
119
+ ## list
120
+
121
+ > PaginatedgemGemPublicationResponseList list(opts)
122
+
123
+ List gem publications
124
+
125
+ A ViewSet for GemPublication.
126
+
127
+ ### Example
128
+
129
+ ```ruby
130
+ # load the gem
131
+ require 'pulp_gem_client'
132
+ # setup authorization
133
+ PulpGemClient.configure do |config|
134
+ # Configure HTTP basic authorization: basicAuth
135
+ config.username = 'YOUR USERNAME'
136
+ config.password = 'YOUR PASSWORD'
137
+ end
138
+
139
+ api_instance = PulpGemClient::PublicationsGemApi.new
140
+ opts = {
141
+ content: 'content_example', # String | Content Unit referenced by HREF
142
+ content__in: 'content__in_example', # String | Content Unit referenced by HREF
143
+ limit: 56, # Integer | Number of results to return per page.
144
+ offset: 56, # Integer | The initial index from which to return the results.
145
+ 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) * `complete` - Complete * `-complete` - Complete (descending) * `pass_through` - Pass through * `-pass_through` - Pass through (descending) * `pk` - Pk * `-pk` - Pk (descending)
146
+ pulp_created: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created matches value
147
+ pulp_created__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than value
148
+ pulp_created__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than or equal to value
149
+ pulp_created__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than value
150
+ pulp_created__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than or equal to value
151
+ pulp_created__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_created is between two comma separated values
152
+ pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
153
+ pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
154
+ repository: 'repository_example', # String | Repository referenced by HREF
155
+ repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
156
+ fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
157
+ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
158
+ }
159
+
160
+ begin
161
+ #List gem publications
162
+ result = api_instance.list(opts)
163
+ p result
164
+ rescue PulpGemClient::ApiError => e
165
+ puts "Exception when calling PublicationsGemApi->list: #{e}"
166
+ end
167
+ ```
168
+
169
+ ### Parameters
170
+
171
+
172
+ Name | Type | Description | Notes
173
+ ------------- | ------------- | ------------- | -------------
174
+ **content** | **String**| Content Unit referenced by HREF | [optional]
175
+ **content__in** | **String**| Content Unit referenced by HREF | [optional]
176
+ **limit** | **Integer**| Number of results to return per page. | [optional]
177
+ **offset** | **Integer**| The initial index from which to return the results. | [optional]
178
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;complete&#x60; - Complete * &#x60;-complete&#x60; - Complete (descending) * &#x60;pass_through&#x60; - Pass through * &#x60;-pass_through&#x60; - Pass through (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional]
179
+ **pulp_created** | **DateTime**| Filter results where pulp_created matches value | [optional]
180
+ **pulp_created__gt** | **DateTime**| Filter results where pulp_created is greater than value | [optional]
181
+ **pulp_created__gte** | **DateTime**| Filter results where pulp_created is greater than or equal to value | [optional]
182
+ **pulp_created__lt** | **DateTime**| Filter results where pulp_created is less than value | [optional]
183
+ **pulp_created__lte** | **DateTime**| Filter results where pulp_created is less than or equal to value | [optional]
184
+ **pulp_created__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_created is between two comma separated values | [optional]
185
+ **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional]
186
+ **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional]
187
+ **repository** | **String**| Repository referenced by HREF | [optional]
188
+ **repository_version** | [**String**](.md)| Repository Version referenced by HREF | [optional]
189
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
190
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
191
+
192
+ ### Return type
193
+
194
+ [**PaginatedgemGemPublicationResponseList**](PaginatedgemGemPublicationResponseList.md)
195
+
196
+ ### Authorization
197
+
198
+ [basicAuth](../README.md#basicAuth)
199
+
200
+ ### HTTP request headers
201
+
202
+ - **Content-Type**: Not defined
203
+ - **Accept**: application/json
204
+
205
+
206
+ ## read
207
+
208
+ > GemGemPublicationResponse read(gem_gem_publication_href, opts)
209
+
210
+ Inspect a gem publication
211
+
212
+ A ViewSet for GemPublication.
213
+
214
+ ### Example
215
+
216
+ ```ruby
217
+ # load the gem
218
+ require 'pulp_gem_client'
219
+ # setup authorization
220
+ PulpGemClient.configure do |config|
221
+ # Configure HTTP basic authorization: basicAuth
222
+ config.username = 'YOUR USERNAME'
223
+ config.password = 'YOUR PASSWORD'
224
+ end
225
+
226
+ api_instance = PulpGemClient::PublicationsGemApi.new
227
+ gem_gem_publication_href = 'gem_gem_publication_href_example' # String |
228
+ opts = {
229
+ fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
230
+ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
231
+ }
232
+
233
+ begin
234
+ #Inspect a gem publication
235
+ result = api_instance.read(gem_gem_publication_href, opts)
236
+ p result
237
+ rescue PulpGemClient::ApiError => e
238
+ puts "Exception when calling PublicationsGemApi->read: #{e}"
239
+ end
240
+ ```
241
+
242
+ ### Parameters
243
+
244
+
245
+ Name | Type | Description | Notes
246
+ ------------- | ------------- | ------------- | -------------
247
+ **gem_gem_publication_href** | **String**| |
248
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
249
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
250
+
251
+ ### Return type
252
+
253
+ [**GemGemPublicationResponse**](GemGemPublicationResponse.md)
254
+
255
+ ### Authorization
256
+
257
+ [basicAuth](../README.md#basicAuth)
258
+
259
+ ### HTTP request headers
260
+
261
+ - **Content-Type**: Not defined
262
+ - **Accept**: application/json
263
+
@@ -0,0 +1,380 @@
1
+ # PulpGemClient::RemotesGemApi
2
+
3
+ All URIs are relative to *https://pulp*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create**](RemotesGemApi.md#create) | **POST** /pulp/api/v3/remotes/gem/gem/ | Create a gem remote
8
+ [**delete**](RemotesGemApi.md#delete) | **DELETE** {gem_gem_remote_href} | Delete a gem remote
9
+ [**list**](RemotesGemApi.md#list) | **GET** /pulp/api/v3/remotes/gem/gem/ | List gem remotes
10
+ [**partial_update**](RemotesGemApi.md#partial_update) | **PATCH** {gem_gem_remote_href} | Update a gem remote
11
+ [**read**](RemotesGemApi.md#read) | **GET** {gem_gem_remote_href} | Inspect a gem remote
12
+ [**update**](RemotesGemApi.md#update) | **PUT** {gem_gem_remote_href} | Update a gem remote
13
+
14
+
15
+
16
+ ## create
17
+
18
+ > GemGemRemoteResponse create(gem_gem_remote)
19
+
20
+ Create a gem remote
21
+
22
+ A ViewSet for GemRemote.
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::RemotesGemApi.new
37
+ gem_gem_remote = PulpGemClient::GemGemRemote.new # GemGemRemote |
38
+
39
+ begin
40
+ #Create a gem remote
41
+ result = api_instance.create(gem_gem_remote)
42
+ p result
43
+ rescue PulpGemClient::ApiError => e
44
+ puts "Exception when calling RemotesGemApi->create: #{e}"
45
+ end
46
+ ```
47
+
48
+ ### Parameters
49
+
50
+
51
+ Name | Type | Description | Notes
52
+ ------------- | ------------- | ------------- | -------------
53
+ **gem_gem_remote** | [**GemGemRemote**](GemGemRemote.md)| |
54
+
55
+ ### Return type
56
+
57
+ [**GemGemRemoteResponse**](GemGemRemoteResponse.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_remote_href)
72
+
73
+ Delete a gem remote
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::RemotesGemApi.new
90
+ gem_gem_remote_href = 'gem_gem_remote_href_example' # String |
91
+
92
+ begin
93
+ #Delete a gem remote
94
+ result = api_instance.delete(gem_gem_remote_href)
95
+ p result
96
+ rescue PulpGemClient::ApiError => e
97
+ puts "Exception when calling RemotesGemApi->delete: #{e}"
98
+ end
99
+ ```
100
+
101
+ ### Parameters
102
+
103
+
104
+ Name | Type | Description | Notes
105
+ ------------- | ------------- | ------------- | -------------
106
+ **gem_gem_remote_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
+ > PaginatedgemGemRemoteResponseList list(opts)
125
+
126
+ List gem remotes
127
+
128
+ A ViewSet for GemRemote.
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::RemotesGemApi.new
143
+ opts = {
144
+ limit: 56, # Integer | Number of results to return per page.
145
+ name: 'name_example', # String | Filter results where name matches value
146
+ name__contains: 'name__contains_example', # String | Filter results where name contains value
147
+ name__icontains: 'name__icontains_example', # String | Filter results where name contains value
148
+ name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
149
+ name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
150
+ offset: 56, # Integer | The initial index from which to return the results.
151
+ 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) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending)
152
+ pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
153
+ pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
154
+ pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
155
+ pulp_last_updated: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated matches value
156
+ pulp_last_updated__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than value
157
+ pulp_last_updated__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than or equal to value
158
+ pulp_last_updated__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than value
159
+ pulp_last_updated__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than or equal to value
160
+ pulp_last_updated__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_last_updated is between two comma separated values
161
+ fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
162
+ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
163
+ }
164
+
165
+ begin
166
+ #List gem remotes
167
+ result = api_instance.list(opts)
168
+ p result
169
+ rescue PulpGemClient::ApiError => e
170
+ puts "Exception when calling RemotesGemApi->list: #{e}"
171
+ end
172
+ ```
173
+
174
+ ### Parameters
175
+
176
+
177
+ Name | Type | Description | Notes
178
+ ------------- | ------------- | ------------- | -------------
179
+ **limit** | **Integer**| Number of results to return per page. | [optional]
180
+ **name** | **String**| Filter results where name matches value | [optional]
181
+ **name__contains** | **String**| Filter results where name contains value | [optional]
182
+ **name__icontains** | **String**| Filter results where name contains value | [optional]
183
+ **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
184
+ **name__startswith** | **String**| Filter results where name starts with value | [optional]
185
+ **offset** | **Integer**| The initial index from which to return the results. | [optional]
186
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;url&#x60; - Url * &#x60;-url&#x60; - Url (descending) * &#x60;ca_cert&#x60; - Ca cert * &#x60;-ca_cert&#x60; - Ca cert (descending) * &#x60;client_cert&#x60; - Client cert * &#x60;-client_cert&#x60; - Client cert (descending) * &#x60;client_key&#x60; - Client key * &#x60;-client_key&#x60; - Client key (descending) * &#x60;tls_validation&#x60; - Tls validation * &#x60;-tls_validation&#x60; - Tls validation (descending) * &#x60;username&#x60; - Username * &#x60;-username&#x60; - Username (descending) * &#x60;password&#x60; - Password * &#x60;-password&#x60; - Password (descending) * &#x60;proxy_url&#x60; - Proxy url * &#x60;-proxy_url&#x60; - Proxy url (descending) * &#x60;proxy_username&#x60; - Proxy username * &#x60;-proxy_username&#x60; - Proxy username (descending) * &#x60;proxy_password&#x60; - Proxy password * &#x60;-proxy_password&#x60; - Proxy password (descending) * &#x60;download_concurrency&#x60; - Download concurrency * &#x60;-download_concurrency&#x60; - Download concurrency (descending) * &#x60;max_retries&#x60; - Max retries * &#x60;-max_retries&#x60; - Max retries (descending) * &#x60;policy&#x60; - Policy * &#x60;-policy&#x60; - Policy (descending) * &#x60;total_timeout&#x60; - Total timeout * &#x60;-total_timeout&#x60; - Total timeout (descending) * &#x60;connect_timeout&#x60; - Connect timeout * &#x60;-connect_timeout&#x60; - Connect timeout (descending) * &#x60;sock_connect_timeout&#x60; - Sock connect timeout * &#x60;-sock_connect_timeout&#x60; - Sock connect timeout (descending) * &#x60;sock_read_timeout&#x60; - Sock read timeout * &#x60;-sock_read_timeout&#x60; - Sock read timeout (descending) * &#x60;headers&#x60; - Headers * &#x60;-headers&#x60; - Headers (descending) * &#x60;rate_limit&#x60; - Rate limit * &#x60;-rate_limit&#x60; - Rate limit (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional]
187
+ **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional]
188
+ **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional]
189
+ **pulp_label_select** | **String**| Filter labels by search string | [optional]
190
+ **pulp_last_updated** | **DateTime**| Filter results where pulp_last_updated matches value | [optional]
191
+ **pulp_last_updated__gt** | **DateTime**| Filter results where pulp_last_updated is greater than value | [optional]
192
+ **pulp_last_updated__gte** | **DateTime**| Filter results where pulp_last_updated is greater than or equal to value | [optional]
193
+ **pulp_last_updated__lt** | **DateTime**| Filter results where pulp_last_updated is less than value | [optional]
194
+ **pulp_last_updated__lte** | **DateTime**| Filter results where pulp_last_updated is less than or equal to value | [optional]
195
+ **pulp_last_updated__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_last_updated is between two comma separated values | [optional]
196
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
197
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
198
+
199
+ ### Return type
200
+
201
+ [**PaginatedgemGemRemoteResponseList**](PaginatedgemGemRemoteResponseList.md)
202
+
203
+ ### Authorization
204
+
205
+ [basicAuth](../README.md#basicAuth)
206
+
207
+ ### HTTP request headers
208
+
209
+ - **Content-Type**: Not defined
210
+ - **Accept**: application/json
211
+
212
+
213
+ ## partial_update
214
+
215
+ > AsyncOperationResponse partial_update(gem_gem_remote_href, patchedgem_gem_remote)
216
+
217
+ Update a gem remote
218
+
219
+ Trigger an asynchronous partial update task
220
+
221
+ ### Example
222
+
223
+ ```ruby
224
+ # load the gem
225
+ require 'pulp_gem_client'
226
+ # setup authorization
227
+ PulpGemClient.configure do |config|
228
+ # Configure HTTP basic authorization: basicAuth
229
+ config.username = 'YOUR USERNAME'
230
+ config.password = 'YOUR PASSWORD'
231
+ end
232
+
233
+ api_instance = PulpGemClient::RemotesGemApi.new
234
+ gem_gem_remote_href = 'gem_gem_remote_href_example' # String |
235
+ patchedgem_gem_remote = PulpGemClient::PatchedgemGemRemote.new # PatchedgemGemRemote |
236
+
237
+ begin
238
+ #Update a gem remote
239
+ result = api_instance.partial_update(gem_gem_remote_href, patchedgem_gem_remote)
240
+ p result
241
+ rescue PulpGemClient::ApiError => e
242
+ puts "Exception when calling RemotesGemApi->partial_update: #{e}"
243
+ end
244
+ ```
245
+
246
+ ### Parameters
247
+
248
+
249
+ Name | Type | Description | Notes
250
+ ------------- | ------------- | ------------- | -------------
251
+ **gem_gem_remote_href** | **String**| |
252
+ **patchedgem_gem_remote** | [**PatchedgemGemRemote**](PatchedgemGemRemote.md)| |
253
+
254
+ ### Return type
255
+
256
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
257
+
258
+ ### Authorization
259
+
260
+ [basicAuth](../README.md#basicAuth)
261
+
262
+ ### HTTP request headers
263
+
264
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
265
+ - **Accept**: application/json
266
+
267
+
268
+ ## read
269
+
270
+ > GemGemRemoteResponse read(gem_gem_remote_href, opts)
271
+
272
+ Inspect a gem remote
273
+
274
+ A ViewSet for GemRemote.
275
+
276
+ ### Example
277
+
278
+ ```ruby
279
+ # load the gem
280
+ require 'pulp_gem_client'
281
+ # setup authorization
282
+ PulpGemClient.configure do |config|
283
+ # Configure HTTP basic authorization: basicAuth
284
+ config.username = 'YOUR USERNAME'
285
+ config.password = 'YOUR PASSWORD'
286
+ end
287
+
288
+ api_instance = PulpGemClient::RemotesGemApi.new
289
+ gem_gem_remote_href = 'gem_gem_remote_href_example' # String |
290
+ opts = {
291
+ fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
292
+ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
293
+ }
294
+
295
+ begin
296
+ #Inspect a gem remote
297
+ result = api_instance.read(gem_gem_remote_href, opts)
298
+ p result
299
+ rescue PulpGemClient::ApiError => e
300
+ puts "Exception when calling RemotesGemApi->read: #{e}"
301
+ end
302
+ ```
303
+
304
+ ### Parameters
305
+
306
+
307
+ Name | Type | Description | Notes
308
+ ------------- | ------------- | ------------- | -------------
309
+ **gem_gem_remote_href** | **String**| |
310
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
311
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
312
+
313
+ ### Return type
314
+
315
+ [**GemGemRemoteResponse**](GemGemRemoteResponse.md)
316
+
317
+ ### Authorization
318
+
319
+ [basicAuth](../README.md#basicAuth)
320
+
321
+ ### HTTP request headers
322
+
323
+ - **Content-Type**: Not defined
324
+ - **Accept**: application/json
325
+
326
+
327
+ ## update
328
+
329
+ > AsyncOperationResponse update(gem_gem_remote_href, gem_gem_remote)
330
+
331
+ Update a gem remote
332
+
333
+ Trigger an asynchronous update task
334
+
335
+ ### Example
336
+
337
+ ```ruby
338
+ # load the gem
339
+ require 'pulp_gem_client'
340
+ # setup authorization
341
+ PulpGemClient.configure do |config|
342
+ # Configure HTTP basic authorization: basicAuth
343
+ config.username = 'YOUR USERNAME'
344
+ config.password = 'YOUR PASSWORD'
345
+ end
346
+
347
+ api_instance = PulpGemClient::RemotesGemApi.new
348
+ gem_gem_remote_href = 'gem_gem_remote_href_example' # String |
349
+ gem_gem_remote = PulpGemClient::GemGemRemote.new # GemGemRemote |
350
+
351
+ begin
352
+ #Update a gem remote
353
+ result = api_instance.update(gem_gem_remote_href, gem_gem_remote)
354
+ p result
355
+ rescue PulpGemClient::ApiError => e
356
+ puts "Exception when calling RemotesGemApi->update: #{e}"
357
+ end
358
+ ```
359
+
360
+ ### Parameters
361
+
362
+
363
+ Name | Type | Description | Notes
364
+ ------------- | ------------- | ------------- | -------------
365
+ **gem_gem_remote_href** | **String**| |
366
+ **gem_gem_remote** | [**GemGemRemote**](GemGemRemote.md)| |
367
+
368
+ ### Return type
369
+
370
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
371
+
372
+ ### Authorization
373
+
374
+ [basicAuth](../README.md#basicAuth)
375
+
376
+ ### HTTP request headers
377
+
378
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
379
+ - **Accept**: application/json
380
+
data/docs/Repair.md ADDED
@@ -0,0 +1,17 @@
1
+ # PulpGemClient::Repair
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **verify_checksums** | **Boolean** | Will verify that the checksum of all stored files matches what saved in the database. Otherwise only the existence of the files will be checked. Enabled by default | [optional] [default to true]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'PulpGemClient'
13
+
14
+ instance = PulpGemClient::Repair.new(verify_checksums: null)
15
+ ```
16
+
17
+