pulp_file_client 1.14.4 → 1.14.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +36 -25
- data/docs/AcsFileApi.md +23 -9
- data/docs/ContentFilesApi.md +3 -1
- data/docs/DistributionsFileApi.md +135 -9
- data/docs/PublicationsFileApi.md +15 -9
- data/docs/RemotesFileApi.md +135 -9
- data/docs/RepositoriesFileApi.md +135 -9
- data/docs/RepositoriesFileVersionsApi.md +3 -1
- data/docs/SetLabel.md +19 -0
- data/docs/SetLabelResponse.md +19 -0
- data/docs/UnsetLabel.md +17 -0
- data/docs/UnsetLabelResponse.md +19 -0
- data/lib/pulp_file_client/api/acs_file_api.rb +23 -0
- data/lib/pulp_file_client/api/content_files_api.rb +3 -0
- data/lib/pulp_file_client/api/distributions_file_api.rb +163 -0
- data/lib/pulp_file_client/api/publications_file_api.rb +11 -0
- data/lib/pulp_file_client/api/remotes_file_api.rb +163 -0
- data/lib/pulp_file_client/api/repositories_file_api.rb +163 -0
- data/lib/pulp_file_client/api/repositories_file_versions_api.rb +3 -0
- data/lib/pulp_file_client/configuration.rb +2 -2
- data/lib/pulp_file_client/models/set_label.rb +252 -0
- data/lib/pulp_file_client/models/set_label_response.rb +243 -0
- data/lib/pulp_file_client/models/unset_label.rb +242 -0
- data/lib/pulp_file_client/models/unset_label_response.rb +242 -0
- data/lib/pulp_file_client/version.rb +1 -1
- data/lib/pulp_file_client.rb +4 -0
- data/spec/api/acs_file_api_spec.rb +9 -0
- data/spec/api/content_files_api_spec.rb +1 -0
- data/spec/api/distributions_file_api_spec.rb +35 -0
- data/spec/api/publications_file_api_spec.rb +5 -0
- data/spec/api/remotes_file_api_spec.rb +35 -0
- data/spec/api/repositories_file_api_spec.rb +35 -0
- data/spec/api/repositories_file_versions_api_spec.rb +1 -0
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/set_label_response_spec.rb +47 -0
- data/spec/models/set_label_spec.rb +47 -0
- data/spec/models/unset_label_response_spec.rb +47 -0
- data/spec/models/unset_label_spec.rb +41 -0
- metadata +49 -33
data/docs/PublicationsFileApi.md
CHANGED
@@ -1,17 +1,17 @@
|
|
1
1
|
# PulpFileClient::PublicationsFileApi
|
2
2
|
|
3
|
-
All URIs are relative to *
|
3
|
+
All URIs are relative to *http://pulp*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**add_role**](PublicationsFileApi.md#add_role) | **POST** {file_file_publication_href}add_role/ |
|
7
|
+
[**add_role**](PublicationsFileApi.md#add_role) | **POST** {file_file_publication_href}add_role/ | Add a role
|
8
8
|
[**create**](PublicationsFileApi.md#create) | **POST** /pulp/api/v3/publications/file/file/ | Create a file publication
|
9
9
|
[**delete**](PublicationsFileApi.md#delete) | **DELETE** {file_file_publication_href} | Delete a file publication
|
10
10
|
[**list**](PublicationsFileApi.md#list) | **GET** /pulp/api/v3/publications/file/file/ | List file publications
|
11
|
-
[**list_roles**](PublicationsFileApi.md#list_roles) | **GET** {file_file_publication_href}list_roles/ |
|
12
|
-
[**my_permissions**](PublicationsFileApi.md#my_permissions) | **GET** {file_file_publication_href}my_permissions/ |
|
11
|
+
[**list_roles**](PublicationsFileApi.md#list_roles) | **GET** {file_file_publication_href}list_roles/ | List roles
|
12
|
+
[**my_permissions**](PublicationsFileApi.md#my_permissions) | **GET** {file_file_publication_href}my_permissions/ | List user permissions
|
13
13
|
[**read**](PublicationsFileApi.md#read) | **GET** {file_file_publication_href} | Inspect a file publication
|
14
|
-
[**remove_role**](PublicationsFileApi.md#remove_role) | **POST** {file_file_publication_href}remove_role/ |
|
14
|
+
[**remove_role**](PublicationsFileApi.md#remove_role) | **POST** {file_file_publication_href}remove_role/ | Remove a role
|
15
15
|
|
16
16
|
|
17
17
|
|
@@ -19,7 +19,7 @@ Method | HTTP request | Description
|
|
19
19
|
|
20
20
|
> NestedRoleResponse add_role(file_file_publication_href, nested_role)
|
21
21
|
|
22
|
-
|
22
|
+
Add a role
|
23
23
|
|
24
24
|
Add a role for this object to users/groups.
|
25
25
|
|
@@ -40,6 +40,7 @@ file_file_publication_href = 'file_file_publication_href_example' # String |
|
|
40
40
|
nested_role = PulpFileClient::NestedRole.new # NestedRole |
|
41
41
|
|
42
42
|
begin
|
43
|
+
#Add a role
|
43
44
|
result = api_instance.add_role(file_file_publication_href, nested_role)
|
44
45
|
p result
|
45
46
|
rescue PulpFileClient::ApiError => e
|
@@ -209,6 +210,7 @@ opts = {
|
|
209
210
|
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
|
210
211
|
pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
|
211
212
|
pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
|
213
|
+
q: 'q_example', # String |
|
212
214
|
repository: 'repository_example', # String | Repository referenced by HREF
|
213
215
|
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
|
214
216
|
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
@@ -242,6 +244,7 @@ Name | Type | Description | Notes
|
|
242
244
|
**pulp_created__range** | [**Array<DateTime>**](DateTime.md)| Filter results where pulp_created is between two comma separated values | [optional]
|
243
245
|
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
244
246
|
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
247
|
+
**q** | **String**| | [optional]
|
245
248
|
**repository** | **String**| Repository referenced by HREF | [optional]
|
246
249
|
**repository_version** | [**String**](.md)| Repository Version referenced by HREF | [optional]
|
247
250
|
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
@@ -265,7 +268,7 @@ Name | Type | Description | Notes
|
|
265
268
|
|
266
269
|
> ObjectRolesResponse list_roles(file_file_publication_href, opts)
|
267
270
|
|
268
|
-
|
271
|
+
List roles
|
269
272
|
|
270
273
|
List roles assigned to this object.
|
271
274
|
|
@@ -289,6 +292,7 @@ opts = {
|
|
289
292
|
}
|
290
293
|
|
291
294
|
begin
|
295
|
+
#List roles
|
292
296
|
result = api_instance.list_roles(file_file_publication_href, opts)
|
293
297
|
p result
|
294
298
|
rescue PulpFileClient::ApiError => e
|
@@ -323,7 +327,7 @@ Name | Type | Description | Notes
|
|
323
327
|
|
324
328
|
> MyPermissionsResponse my_permissions(file_file_publication_href, opts)
|
325
329
|
|
326
|
-
|
330
|
+
List user permissions
|
327
331
|
|
328
332
|
List permissions available to the current user on this object.
|
329
333
|
|
@@ -347,6 +351,7 @@ opts = {
|
|
347
351
|
}
|
348
352
|
|
349
353
|
begin
|
354
|
+
#List user permissions
|
350
355
|
result = api_instance.my_permissions(file_file_publication_href, opts)
|
351
356
|
p result
|
352
357
|
rescue PulpFileClient::ApiError => e
|
@@ -440,7 +445,7 @@ Name | Type | Description | Notes
|
|
440
445
|
|
441
446
|
> NestedRoleResponse remove_role(file_file_publication_href, nested_role)
|
442
447
|
|
443
|
-
|
448
|
+
Remove a role
|
444
449
|
|
445
450
|
Remove a role for this object from users/groups.
|
446
451
|
|
@@ -461,6 +466,7 @@ file_file_publication_href = 'file_file_publication_href_example' # String |
|
|
461
466
|
nested_role = PulpFileClient::NestedRole.new # NestedRole |
|
462
467
|
|
463
468
|
begin
|
469
|
+
#Remove a role
|
464
470
|
result = api_instance.remove_role(file_file_publication_href, nested_role)
|
465
471
|
p result
|
466
472
|
rescue PulpFileClient::ApiError => e
|
data/docs/RemotesFileApi.md
CHANGED
@@ -1,18 +1,20 @@
|
|
1
1
|
# PulpFileClient::RemotesFileApi
|
2
2
|
|
3
|
-
All URIs are relative to *
|
3
|
+
All URIs are relative to *http://pulp*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**add_role**](RemotesFileApi.md#add_role) | **POST** {file_file_remote_href}add_role/ |
|
7
|
+
[**add_role**](RemotesFileApi.md#add_role) | **POST** {file_file_remote_href}add_role/ | Add a role
|
8
8
|
[**create**](RemotesFileApi.md#create) | **POST** /pulp/api/v3/remotes/file/file/ | Create a file remote
|
9
9
|
[**delete**](RemotesFileApi.md#delete) | **DELETE** {file_file_remote_href} | Delete a file remote
|
10
10
|
[**list**](RemotesFileApi.md#list) | **GET** /pulp/api/v3/remotes/file/file/ | List file remotes
|
11
|
-
[**list_roles**](RemotesFileApi.md#list_roles) | **GET** {file_file_remote_href}list_roles/ |
|
12
|
-
[**my_permissions**](RemotesFileApi.md#my_permissions) | **GET** {file_file_remote_href}my_permissions/ |
|
11
|
+
[**list_roles**](RemotesFileApi.md#list_roles) | **GET** {file_file_remote_href}list_roles/ | List roles
|
12
|
+
[**my_permissions**](RemotesFileApi.md#my_permissions) | **GET** {file_file_remote_href}my_permissions/ | List user permissions
|
13
13
|
[**partial_update**](RemotesFileApi.md#partial_update) | **PATCH** {file_file_remote_href} | Update a file remote
|
14
14
|
[**read**](RemotesFileApi.md#read) | **GET** {file_file_remote_href} | Inspect a file remote
|
15
|
-
[**remove_role**](RemotesFileApi.md#remove_role) | **POST** {file_file_remote_href}remove_role/ |
|
15
|
+
[**remove_role**](RemotesFileApi.md#remove_role) | **POST** {file_file_remote_href}remove_role/ | Remove a role
|
16
|
+
[**set_label**](RemotesFileApi.md#set_label) | **POST** {file_file_remote_href}set_label/ | Set a label
|
17
|
+
[**unset_label**](RemotesFileApi.md#unset_label) | **POST** {file_file_remote_href}unset_label/ | Unset a label
|
16
18
|
[**update**](RemotesFileApi.md#update) | **PUT** {file_file_remote_href} | Update a file remote
|
17
19
|
|
18
20
|
|
@@ -21,7 +23,7 @@ Method | HTTP request | Description
|
|
21
23
|
|
22
24
|
> NestedRoleResponse add_role(file_file_remote_href, nested_role)
|
23
25
|
|
24
|
-
|
26
|
+
Add a role
|
25
27
|
|
26
28
|
Add a role for this object to users/groups.
|
27
29
|
|
@@ -42,6 +44,7 @@ file_file_remote_href = 'file_file_remote_href_example' # String |
|
|
42
44
|
nested_role = PulpFileClient::NestedRole.new # NestedRole |
|
43
45
|
|
44
46
|
begin
|
47
|
+
#Add a role
|
45
48
|
result = api_instance.add_role(file_file_remote_href, nested_role)
|
46
49
|
p result
|
47
50
|
rescue PulpFileClient::ApiError => e
|
@@ -203,7 +206,11 @@ opts = {
|
|
203
206
|
name: 'name_example', # String | Filter results where name matches value
|
204
207
|
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
205
208
|
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
209
|
+
name__iexact: 'name__iexact_example', # String | Filter results where name matches value
|
206
210
|
name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
211
|
+
name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
|
212
|
+
name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
|
213
|
+
name__regex: 'name__regex_example', # String | Filter results where name matches regex value
|
207
214
|
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
208
215
|
offset: 56, # Integer | The initial index from which to return the results.
|
209
216
|
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)
|
@@ -216,6 +223,7 @@ opts = {
|
|
216
223
|
pulp_last_updated__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than value
|
217
224
|
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
|
218
225
|
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
|
226
|
+
q: 'q_example', # String |
|
219
227
|
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
220
228
|
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
221
229
|
}
|
@@ -238,7 +246,11 @@ Name | Type | Description | Notes
|
|
238
246
|
**name** | **String**| Filter results where name matches value | [optional]
|
239
247
|
**name__contains** | **String**| Filter results where name contains value | [optional]
|
240
248
|
**name__icontains** | **String**| Filter results where name contains value | [optional]
|
249
|
+
**name__iexact** | **String**| Filter results where name matches value | [optional]
|
241
250
|
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
251
|
+
**name__iregex** | **String**| Filter results where name matches regex value | [optional]
|
252
|
+
**name__istartswith** | **String**| Filter results where name starts with value | [optional]
|
253
|
+
**name__regex** | **String**| Filter results where name matches regex value | [optional]
|
242
254
|
**name__startswith** | **String**| Filter results where name starts with value | [optional]
|
243
255
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
244
256
|
**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) * `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) | [optional]
|
@@ -251,6 +263,7 @@ Name | Type | Description | Notes
|
|
251
263
|
**pulp_last_updated__lt** | **DateTime**| Filter results where pulp_last_updated is less than value | [optional]
|
252
264
|
**pulp_last_updated__lte** | **DateTime**| Filter results where pulp_last_updated is less than or equal to value | [optional]
|
253
265
|
**pulp_last_updated__range** | [**Array<DateTime>**](DateTime.md)| Filter results where pulp_last_updated is between two comma separated values | [optional]
|
266
|
+
**q** | **String**| | [optional]
|
254
267
|
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
255
268
|
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
256
269
|
|
@@ -272,7 +285,7 @@ Name | Type | Description | Notes
|
|
272
285
|
|
273
286
|
> ObjectRolesResponse list_roles(file_file_remote_href, opts)
|
274
287
|
|
275
|
-
|
288
|
+
List roles
|
276
289
|
|
277
290
|
List roles assigned to this object.
|
278
291
|
|
@@ -296,6 +309,7 @@ opts = {
|
|
296
309
|
}
|
297
310
|
|
298
311
|
begin
|
312
|
+
#List roles
|
299
313
|
result = api_instance.list_roles(file_file_remote_href, opts)
|
300
314
|
p result
|
301
315
|
rescue PulpFileClient::ApiError => e
|
@@ -330,7 +344,7 @@ Name | Type | Description | Notes
|
|
330
344
|
|
331
345
|
> MyPermissionsResponse my_permissions(file_file_remote_href, opts)
|
332
346
|
|
333
|
-
|
347
|
+
List user permissions
|
334
348
|
|
335
349
|
List permissions available to the current user on this object.
|
336
350
|
|
@@ -354,6 +368,7 @@ opts = {
|
|
354
368
|
}
|
355
369
|
|
356
370
|
begin
|
371
|
+
#List user permissions
|
357
372
|
result = api_instance.my_permissions(file_file_remote_href, opts)
|
358
373
|
p result
|
359
374
|
rescue PulpFileClient::ApiError => e
|
@@ -502,7 +517,7 @@ Name | Type | Description | Notes
|
|
502
517
|
|
503
518
|
> NestedRoleResponse remove_role(file_file_remote_href, nested_role)
|
504
519
|
|
505
|
-
|
520
|
+
Remove a role
|
506
521
|
|
507
522
|
Remove a role for this object from users/groups.
|
508
523
|
|
@@ -523,6 +538,7 @@ file_file_remote_href = 'file_file_remote_href_example' # String |
|
|
523
538
|
nested_role = PulpFileClient::NestedRole.new # NestedRole |
|
524
539
|
|
525
540
|
begin
|
541
|
+
#Remove a role
|
526
542
|
result = api_instance.remove_role(file_file_remote_href, nested_role)
|
527
543
|
p result
|
528
544
|
rescue PulpFileClient::ApiError => e
|
@@ -552,6 +568,116 @@ Name | Type | Description | Notes
|
|
552
568
|
- **Accept**: application/json
|
553
569
|
|
554
570
|
|
571
|
+
## set_label
|
572
|
+
|
573
|
+
> SetLabelResponse set_label(file_file_remote_href, set_label)
|
574
|
+
|
575
|
+
Set a label
|
576
|
+
|
577
|
+
Set a single pulp_label on the object to a specific value or null.
|
578
|
+
|
579
|
+
### Example
|
580
|
+
|
581
|
+
```ruby
|
582
|
+
# load the gem
|
583
|
+
require 'pulp_file_client'
|
584
|
+
# setup authorization
|
585
|
+
PulpFileClient.configure do |config|
|
586
|
+
# Configure HTTP basic authorization: basicAuth
|
587
|
+
config.username = 'YOUR USERNAME'
|
588
|
+
config.password = 'YOUR PASSWORD'
|
589
|
+
end
|
590
|
+
|
591
|
+
api_instance = PulpFileClient::RemotesFileApi.new
|
592
|
+
file_file_remote_href = 'file_file_remote_href_example' # String |
|
593
|
+
set_label = PulpFileClient::SetLabel.new # SetLabel |
|
594
|
+
|
595
|
+
begin
|
596
|
+
#Set a label
|
597
|
+
result = api_instance.set_label(file_file_remote_href, set_label)
|
598
|
+
p result
|
599
|
+
rescue PulpFileClient::ApiError => e
|
600
|
+
puts "Exception when calling RemotesFileApi->set_label: #{e}"
|
601
|
+
end
|
602
|
+
```
|
603
|
+
|
604
|
+
### Parameters
|
605
|
+
|
606
|
+
|
607
|
+
Name | Type | Description | Notes
|
608
|
+
------------- | ------------- | ------------- | -------------
|
609
|
+
**file_file_remote_href** | **String**| |
|
610
|
+
**set_label** | [**SetLabel**](SetLabel.md)| |
|
611
|
+
|
612
|
+
### Return type
|
613
|
+
|
614
|
+
[**SetLabelResponse**](SetLabelResponse.md)
|
615
|
+
|
616
|
+
### Authorization
|
617
|
+
|
618
|
+
[basicAuth](../README.md#basicAuth)
|
619
|
+
|
620
|
+
### HTTP request headers
|
621
|
+
|
622
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
623
|
+
- **Accept**: application/json
|
624
|
+
|
625
|
+
|
626
|
+
## unset_label
|
627
|
+
|
628
|
+
> UnsetLabelResponse unset_label(file_file_remote_href, unset_label)
|
629
|
+
|
630
|
+
Unset a label
|
631
|
+
|
632
|
+
Unset a single pulp_label on the object.
|
633
|
+
|
634
|
+
### Example
|
635
|
+
|
636
|
+
```ruby
|
637
|
+
# load the gem
|
638
|
+
require 'pulp_file_client'
|
639
|
+
# setup authorization
|
640
|
+
PulpFileClient.configure do |config|
|
641
|
+
# Configure HTTP basic authorization: basicAuth
|
642
|
+
config.username = 'YOUR USERNAME'
|
643
|
+
config.password = 'YOUR PASSWORD'
|
644
|
+
end
|
645
|
+
|
646
|
+
api_instance = PulpFileClient::RemotesFileApi.new
|
647
|
+
file_file_remote_href = 'file_file_remote_href_example' # String |
|
648
|
+
unset_label = PulpFileClient::UnsetLabel.new # UnsetLabel |
|
649
|
+
|
650
|
+
begin
|
651
|
+
#Unset a label
|
652
|
+
result = api_instance.unset_label(file_file_remote_href, unset_label)
|
653
|
+
p result
|
654
|
+
rescue PulpFileClient::ApiError => e
|
655
|
+
puts "Exception when calling RemotesFileApi->unset_label: #{e}"
|
656
|
+
end
|
657
|
+
```
|
658
|
+
|
659
|
+
### Parameters
|
660
|
+
|
661
|
+
|
662
|
+
Name | Type | Description | Notes
|
663
|
+
------------- | ------------- | ------------- | -------------
|
664
|
+
**file_file_remote_href** | **String**| |
|
665
|
+
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
|
666
|
+
|
667
|
+
### Return type
|
668
|
+
|
669
|
+
[**UnsetLabelResponse**](UnsetLabelResponse.md)
|
670
|
+
|
671
|
+
### Authorization
|
672
|
+
|
673
|
+
[basicAuth](../README.md#basicAuth)
|
674
|
+
|
675
|
+
### HTTP request headers
|
676
|
+
|
677
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
678
|
+
- **Accept**: application/json
|
679
|
+
|
680
|
+
|
555
681
|
## update
|
556
682
|
|
557
683
|
> AsyncOperationResponse update(file_file_remote_href, file_file_remote)
|
data/docs/RepositoriesFileApi.md
CHANGED
@@ -1,20 +1,22 @@
|
|
1
1
|
# PulpFileClient::RepositoriesFileApi
|
2
2
|
|
3
|
-
All URIs are relative to *
|
3
|
+
All URIs are relative to *http://pulp*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**add_role**](RepositoriesFileApi.md#add_role) | **POST** {file_file_repository_href}add_role/ |
|
7
|
+
[**add_role**](RepositoriesFileApi.md#add_role) | **POST** {file_file_repository_href}add_role/ | Add a role
|
8
8
|
[**create**](RepositoriesFileApi.md#create) | **POST** /pulp/api/v3/repositories/file/file/ | Create a file repository
|
9
9
|
[**delete**](RepositoriesFileApi.md#delete) | **DELETE** {file_file_repository_href} | Delete a file repository
|
10
10
|
[**list**](RepositoriesFileApi.md#list) | **GET** /pulp/api/v3/repositories/file/file/ | List file repositorys
|
11
|
-
[**list_roles**](RepositoriesFileApi.md#list_roles) | **GET** {file_file_repository_href}list_roles/ |
|
11
|
+
[**list_roles**](RepositoriesFileApi.md#list_roles) | **GET** {file_file_repository_href}list_roles/ | List roles
|
12
12
|
[**modify**](RepositoriesFileApi.md#modify) | **POST** {file_file_repository_href}modify/ | Modify Repository Content
|
13
|
-
[**my_permissions**](RepositoriesFileApi.md#my_permissions) | **GET** {file_file_repository_href}my_permissions/ |
|
13
|
+
[**my_permissions**](RepositoriesFileApi.md#my_permissions) | **GET** {file_file_repository_href}my_permissions/ | List user permissions
|
14
14
|
[**partial_update**](RepositoriesFileApi.md#partial_update) | **PATCH** {file_file_repository_href} | Update a file repository
|
15
15
|
[**read**](RepositoriesFileApi.md#read) | **GET** {file_file_repository_href} | Inspect a file repository
|
16
|
-
[**remove_role**](RepositoriesFileApi.md#remove_role) | **POST** {file_file_repository_href}remove_role/ |
|
16
|
+
[**remove_role**](RepositoriesFileApi.md#remove_role) | **POST** {file_file_repository_href}remove_role/ | Remove a role
|
17
|
+
[**set_label**](RepositoriesFileApi.md#set_label) | **POST** {file_file_repository_href}set_label/ | Set a label
|
17
18
|
[**sync**](RepositoriesFileApi.md#sync) | **POST** {file_file_repository_href}sync/ | Sync from a remote
|
19
|
+
[**unset_label**](RepositoriesFileApi.md#unset_label) | **POST** {file_file_repository_href}unset_label/ | Unset a label
|
18
20
|
[**update**](RepositoriesFileApi.md#update) | **PUT** {file_file_repository_href} | Update a file repository
|
19
21
|
|
20
22
|
|
@@ -23,7 +25,7 @@ Method | HTTP request | Description
|
|
23
25
|
|
24
26
|
> NestedRoleResponse add_role(file_file_repository_href, nested_role)
|
25
27
|
|
26
|
-
|
28
|
+
Add a role
|
27
29
|
|
28
30
|
Add a role for this object to users/groups.
|
29
31
|
|
@@ -44,6 +46,7 @@ file_file_repository_href = 'file_file_repository_href_example' # String |
|
|
44
46
|
nested_role = PulpFileClient::NestedRole.new # NestedRole |
|
45
47
|
|
46
48
|
begin
|
49
|
+
#Add a role
|
47
50
|
result = api_instance.add_role(file_file_repository_href, nested_role)
|
48
51
|
p result
|
49
52
|
rescue PulpFileClient::ApiError => e
|
@@ -206,13 +209,18 @@ opts = {
|
|
206
209
|
name: 'name_example', # String | Filter results where name matches value
|
207
210
|
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
208
211
|
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
212
|
+
name__iexact: 'name__iexact_example', # String | Filter results where name matches value
|
209
213
|
name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
214
|
+
name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
|
215
|
+
name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
|
216
|
+
name__regex: 'name__regex_example', # String | Filter results where name matches regex value
|
210
217
|
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
211
218
|
offset: 56, # Integer | The initial index from which to return the results.
|
212
219
|
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) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
213
220
|
pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
|
214
221
|
pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
|
215
222
|
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
223
|
+
q: 'q_example', # String |
|
216
224
|
remote: 'remote_example', # String | Foreign Key referenced by HREF
|
217
225
|
retain_repo_versions: 56, # Integer | Filter results where retain_repo_versions matches value
|
218
226
|
retain_repo_versions__gt: 56, # Integer | Filter results where retain_repo_versions is greater than value
|
@@ -246,13 +254,18 @@ Name | Type | Description | Notes
|
|
246
254
|
**name** | **String**| Filter results where name matches value | [optional]
|
247
255
|
**name__contains** | **String**| Filter results where name contains value | [optional]
|
248
256
|
**name__icontains** | **String**| Filter results where name contains value | [optional]
|
257
|
+
**name__iexact** | **String**| Filter results where name matches value | [optional]
|
249
258
|
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
259
|
+
**name__iregex** | **String**| Filter results where name matches regex value | [optional]
|
260
|
+
**name__istartswith** | **String**| Filter results where name starts with value | [optional]
|
261
|
+
**name__regex** | **String**| Filter results where name matches regex value | [optional]
|
250
262
|
**name__startswith** | **String**| Filter results where name starts with value | [optional]
|
251
263
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
252
264
|
**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) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
|
253
265
|
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
254
266
|
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
255
267
|
**pulp_label_select** | **String**| Filter labels by search string | [optional]
|
268
|
+
**q** | **String**| | [optional]
|
256
269
|
**remote** | [**String**](.md)| Foreign Key referenced by HREF | [optional]
|
257
270
|
**retain_repo_versions** | **Integer**| Filter results where retain_repo_versions matches value | [optional]
|
258
271
|
**retain_repo_versions__gt** | **Integer**| Filter results where retain_repo_versions is greater than value | [optional]
|
@@ -284,7 +297,7 @@ Name | Type | Description | Notes
|
|
284
297
|
|
285
298
|
> ObjectRolesResponse list_roles(file_file_repository_href, opts)
|
286
299
|
|
287
|
-
|
300
|
+
List roles
|
288
301
|
|
289
302
|
List roles assigned to this object.
|
290
303
|
|
@@ -308,6 +321,7 @@ opts = {
|
|
308
321
|
}
|
309
322
|
|
310
323
|
begin
|
324
|
+
#List roles
|
311
325
|
result = api_instance.list_roles(file_file_repository_href, opts)
|
312
326
|
p result
|
313
327
|
rescue PulpFileClient::ApiError => e
|
@@ -397,7 +411,7 @@ Name | Type | Description | Notes
|
|
397
411
|
|
398
412
|
> MyPermissionsResponse my_permissions(file_file_repository_href, opts)
|
399
413
|
|
400
|
-
|
414
|
+
List user permissions
|
401
415
|
|
402
416
|
List permissions available to the current user on this object.
|
403
417
|
|
@@ -421,6 +435,7 @@ opts = {
|
|
421
435
|
}
|
422
436
|
|
423
437
|
begin
|
438
|
+
#List user permissions
|
424
439
|
result = api_instance.my_permissions(file_file_repository_href, opts)
|
425
440
|
p result
|
426
441
|
rescue PulpFileClient::ApiError => e
|
@@ -569,7 +584,7 @@ Name | Type | Description | Notes
|
|
569
584
|
|
570
585
|
> NestedRoleResponse remove_role(file_file_repository_href, nested_role)
|
571
586
|
|
572
|
-
|
587
|
+
Remove a role
|
573
588
|
|
574
589
|
Remove a role for this object from users/groups.
|
575
590
|
|
@@ -590,6 +605,7 @@ file_file_repository_href = 'file_file_repository_href_example' # String |
|
|
590
605
|
nested_role = PulpFileClient::NestedRole.new # NestedRole |
|
591
606
|
|
592
607
|
begin
|
608
|
+
#Remove a role
|
593
609
|
result = api_instance.remove_role(file_file_repository_href, nested_role)
|
594
610
|
p result
|
595
611
|
rescue PulpFileClient::ApiError => e
|
@@ -619,6 +635,61 @@ Name | Type | Description | Notes
|
|
619
635
|
- **Accept**: application/json
|
620
636
|
|
621
637
|
|
638
|
+
## set_label
|
639
|
+
|
640
|
+
> SetLabelResponse set_label(file_file_repository_href, set_label)
|
641
|
+
|
642
|
+
Set a label
|
643
|
+
|
644
|
+
Set a single pulp_label on the object to a specific value or null.
|
645
|
+
|
646
|
+
### Example
|
647
|
+
|
648
|
+
```ruby
|
649
|
+
# load the gem
|
650
|
+
require 'pulp_file_client'
|
651
|
+
# setup authorization
|
652
|
+
PulpFileClient.configure do |config|
|
653
|
+
# Configure HTTP basic authorization: basicAuth
|
654
|
+
config.username = 'YOUR USERNAME'
|
655
|
+
config.password = 'YOUR PASSWORD'
|
656
|
+
end
|
657
|
+
|
658
|
+
api_instance = PulpFileClient::RepositoriesFileApi.new
|
659
|
+
file_file_repository_href = 'file_file_repository_href_example' # String |
|
660
|
+
set_label = PulpFileClient::SetLabel.new # SetLabel |
|
661
|
+
|
662
|
+
begin
|
663
|
+
#Set a label
|
664
|
+
result = api_instance.set_label(file_file_repository_href, set_label)
|
665
|
+
p result
|
666
|
+
rescue PulpFileClient::ApiError => e
|
667
|
+
puts "Exception when calling RepositoriesFileApi->set_label: #{e}"
|
668
|
+
end
|
669
|
+
```
|
670
|
+
|
671
|
+
### Parameters
|
672
|
+
|
673
|
+
|
674
|
+
Name | Type | Description | Notes
|
675
|
+
------------- | ------------- | ------------- | -------------
|
676
|
+
**file_file_repository_href** | **String**| |
|
677
|
+
**set_label** | [**SetLabel**](SetLabel.md)| |
|
678
|
+
|
679
|
+
### Return type
|
680
|
+
|
681
|
+
[**SetLabelResponse**](SetLabelResponse.md)
|
682
|
+
|
683
|
+
### Authorization
|
684
|
+
|
685
|
+
[basicAuth](../README.md#basicAuth)
|
686
|
+
|
687
|
+
### HTTP request headers
|
688
|
+
|
689
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
690
|
+
- **Accept**: application/json
|
691
|
+
|
692
|
+
|
622
693
|
## sync
|
623
694
|
|
624
695
|
> AsyncOperationResponse sync(file_file_repository_href, repository_sync_url)
|
@@ -674,6 +745,61 @@ Name | Type | Description | Notes
|
|
674
745
|
- **Accept**: application/json
|
675
746
|
|
676
747
|
|
748
|
+
## unset_label
|
749
|
+
|
750
|
+
> UnsetLabelResponse unset_label(file_file_repository_href, unset_label)
|
751
|
+
|
752
|
+
Unset a label
|
753
|
+
|
754
|
+
Unset a single pulp_label on the object.
|
755
|
+
|
756
|
+
### Example
|
757
|
+
|
758
|
+
```ruby
|
759
|
+
# load the gem
|
760
|
+
require 'pulp_file_client'
|
761
|
+
# setup authorization
|
762
|
+
PulpFileClient.configure do |config|
|
763
|
+
# Configure HTTP basic authorization: basicAuth
|
764
|
+
config.username = 'YOUR USERNAME'
|
765
|
+
config.password = 'YOUR PASSWORD'
|
766
|
+
end
|
767
|
+
|
768
|
+
api_instance = PulpFileClient::RepositoriesFileApi.new
|
769
|
+
file_file_repository_href = 'file_file_repository_href_example' # String |
|
770
|
+
unset_label = PulpFileClient::UnsetLabel.new # UnsetLabel |
|
771
|
+
|
772
|
+
begin
|
773
|
+
#Unset a label
|
774
|
+
result = api_instance.unset_label(file_file_repository_href, unset_label)
|
775
|
+
p result
|
776
|
+
rescue PulpFileClient::ApiError => e
|
777
|
+
puts "Exception when calling RepositoriesFileApi->unset_label: #{e}"
|
778
|
+
end
|
779
|
+
```
|
780
|
+
|
781
|
+
### Parameters
|
782
|
+
|
783
|
+
|
784
|
+
Name | Type | Description | Notes
|
785
|
+
------------- | ------------- | ------------- | -------------
|
786
|
+
**file_file_repository_href** | **String**| |
|
787
|
+
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
|
788
|
+
|
789
|
+
### Return type
|
790
|
+
|
791
|
+
[**UnsetLabelResponse**](UnsetLabelResponse.md)
|
792
|
+
|
793
|
+
### Authorization
|
794
|
+
|
795
|
+
[basicAuth](../README.md#basicAuth)
|
796
|
+
|
797
|
+
### HTTP request headers
|
798
|
+
|
799
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
800
|
+
- **Accept**: application/json
|
801
|
+
|
802
|
+
|
677
803
|
## update
|
678
804
|
|
679
805
|
> AsyncOperationResponse update(file_file_repository_href, file_file_repository)
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# PulpFileClient::RepositoriesFileVersionsApi
|
2
2
|
|
3
|
-
All URIs are relative to *
|
3
|
+
All URIs are relative to *http://pulp*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
@@ -105,6 +105,7 @@ opts = {
|
|
105
105
|
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
|
106
106
|
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
|
107
107
|
pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
|
108
|
+
q: 'q_example', # String |
|
108
109
|
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
109
110
|
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
110
111
|
}
|
@@ -142,6 +143,7 @@ Name | Type | Description | Notes
|
|
142
143
|
**pulp_created__lte** | **DateTime**| Filter results where pulp_created is less than or equal to value | [optional]
|
143
144
|
**pulp_created__range** | [**Array<DateTime>**](DateTime.md)| Filter results where pulp_created is between two comma separated values | [optional]
|
144
145
|
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
146
|
+
**q** | **String**| | [optional]
|
145
147
|
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
146
148
|
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
147
149
|
|
data/docs/SetLabel.md
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
# PulpFileClient::SetLabel
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**key** | **String** | |
|
8
|
+
**value** | **String** | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'PulpFileClient'
|
14
|
+
|
15
|
+
instance = PulpFileClient::SetLabel.new(key: null,
|
16
|
+
value: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# PulpFileClient::SetLabelResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**key** | **String** | |
|
8
|
+
**value** | **String** | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'PulpFileClient'
|
14
|
+
|
15
|
+
instance = PulpFileClient::SetLabelResponse.new(key: null,
|
16
|
+
value: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|