pulpcore_client 3.42.0 → 3.43.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.
- checksums.yaml +4 -4
- data/README.md +18 -4
- data/docs/ArtifactDistributionResponse.md +9 -9
- data/docs/CompositeContentGuard.md +21 -0
- data/docs/CompositeContentGuardResponse.md +25 -0
- data/docs/ContentguardsApi.md +4 -4
- data/docs/ContentguardsCompositeApi.md +607 -0
- data/docs/PaginatedCompositeContentGuardResponseList.md +23 -0
- data/docs/PatchedCompositeContentGuard.md +21 -0
- data/lib/pulpcore_client/api/contentguards_api.rb +6 -6
- data/lib/pulpcore_client/api/contentguards_composite_api.rb +741 -0
- data/lib/pulpcore_client/models/artifact_distribution_response.rb +45 -45
- data/lib/pulpcore_client/models/composite_content_guard.rb +270 -0
- data/lib/pulpcore_client/models/composite_content_guard_response.rb +255 -0
- data/lib/pulpcore_client/models/paginated_composite_content_guard_response_list.rb +237 -0
- data/lib/pulpcore_client/models/patched_composite_content_guard.rb +261 -0
- data/lib/pulpcore_client/version.rb +1 -1
- data/lib/pulpcore_client.rb +5 -0
- data/spec/api/contentguards_api_spec.rb +2 -2
- data/spec/api/contentguards_composite_api_spec.rb +181 -0
- data/spec/models/artifact_distribution_response_spec.rb +7 -7
- data/spec/models/composite_content_guard_response_spec.rb +65 -0
- data/spec/models/composite_content_guard_spec.rb +53 -0
- data/spec/models/paginated_composite_content_guard_response_list_spec.rb +59 -0
- data/spec/models/patched_composite_content_guard_spec.rb +53 -0
- metadata +22 -2
@@ -0,0 +1,607 @@
|
|
1
|
+
# PulpcoreClient::ContentguardsCompositeApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://pulp*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**add_role**](ContentguardsCompositeApi.md#add_role) | **POST** {composite_content_guard_href}add_role/ | Add a role
|
8
|
+
[**create**](ContentguardsCompositeApi.md#create) | **POST** /pulp/api/v3/contentguards/core/composite/ | Create a composite content guard
|
9
|
+
[**delete**](ContentguardsCompositeApi.md#delete) | **DELETE** {composite_content_guard_href} | Delete a composite content guard
|
10
|
+
[**list**](ContentguardsCompositeApi.md#list) | **GET** /pulp/api/v3/contentguards/core/composite/ | List composite content guards
|
11
|
+
[**list_roles**](ContentguardsCompositeApi.md#list_roles) | **GET** {composite_content_guard_href}list_roles/ | List roles
|
12
|
+
[**my_permissions**](ContentguardsCompositeApi.md#my_permissions) | **GET** {composite_content_guard_href}my_permissions/ | List user permissions
|
13
|
+
[**partial_update**](ContentguardsCompositeApi.md#partial_update) | **PATCH** {composite_content_guard_href} | Update a composite content guard
|
14
|
+
[**read**](ContentguardsCompositeApi.md#read) | **GET** {composite_content_guard_href} | Inspect a composite content guard
|
15
|
+
[**remove_role**](ContentguardsCompositeApi.md#remove_role) | **POST** {composite_content_guard_href}remove_role/ | Remove a role
|
16
|
+
[**update**](ContentguardsCompositeApi.md#update) | **PUT** {composite_content_guard_href} | Update a composite content guard
|
17
|
+
|
18
|
+
|
19
|
+
|
20
|
+
## add_role
|
21
|
+
|
22
|
+
> NestedRoleResponse add_role(composite_content_guard_href, nested_role)
|
23
|
+
|
24
|
+
Add a role
|
25
|
+
|
26
|
+
Add a role for this object to users/groups.
|
27
|
+
|
28
|
+
### Example
|
29
|
+
|
30
|
+
```ruby
|
31
|
+
# load the gem
|
32
|
+
require 'pulpcore_client'
|
33
|
+
# setup authorization
|
34
|
+
PulpcoreClient.configure do |config|
|
35
|
+
# Configure HTTP basic authorization: basicAuth
|
36
|
+
config.username = 'YOUR USERNAME'
|
37
|
+
config.password = 'YOUR PASSWORD'
|
38
|
+
end
|
39
|
+
|
40
|
+
api_instance = PulpcoreClient::ContentguardsCompositeApi.new
|
41
|
+
composite_content_guard_href = 'composite_content_guard_href_example' # String |
|
42
|
+
nested_role = PulpcoreClient::NestedRole.new # NestedRole |
|
43
|
+
|
44
|
+
begin
|
45
|
+
#Add a role
|
46
|
+
result = api_instance.add_role(composite_content_guard_href, nested_role)
|
47
|
+
p result
|
48
|
+
rescue PulpcoreClient::ApiError => e
|
49
|
+
puts "Exception when calling ContentguardsCompositeApi->add_role: #{e}"
|
50
|
+
end
|
51
|
+
```
|
52
|
+
|
53
|
+
### Parameters
|
54
|
+
|
55
|
+
|
56
|
+
Name | Type | Description | Notes
|
57
|
+
------------- | ------------- | ------------- | -------------
|
58
|
+
**composite_content_guard_href** | **String**| |
|
59
|
+
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
60
|
+
|
61
|
+
### Return type
|
62
|
+
|
63
|
+
[**NestedRoleResponse**](NestedRoleResponse.md)
|
64
|
+
|
65
|
+
### Authorization
|
66
|
+
|
67
|
+
[basicAuth](../README.md#basicAuth)
|
68
|
+
|
69
|
+
### HTTP request headers
|
70
|
+
|
71
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
72
|
+
- **Accept**: application/json
|
73
|
+
|
74
|
+
|
75
|
+
## create
|
76
|
+
|
77
|
+
> CompositeContentGuardResponse create(composite_content_guard)
|
78
|
+
|
79
|
+
Create a composite content guard
|
80
|
+
|
81
|
+
Content guard that queries a list-of content-guards for access permissions.
|
82
|
+
|
83
|
+
### Example
|
84
|
+
|
85
|
+
```ruby
|
86
|
+
# load the gem
|
87
|
+
require 'pulpcore_client'
|
88
|
+
# setup authorization
|
89
|
+
PulpcoreClient.configure do |config|
|
90
|
+
# Configure HTTP basic authorization: basicAuth
|
91
|
+
config.username = 'YOUR USERNAME'
|
92
|
+
config.password = 'YOUR PASSWORD'
|
93
|
+
end
|
94
|
+
|
95
|
+
api_instance = PulpcoreClient::ContentguardsCompositeApi.new
|
96
|
+
composite_content_guard = PulpcoreClient::CompositeContentGuard.new # CompositeContentGuard |
|
97
|
+
|
98
|
+
begin
|
99
|
+
#Create a composite content guard
|
100
|
+
result = api_instance.create(composite_content_guard)
|
101
|
+
p result
|
102
|
+
rescue PulpcoreClient::ApiError => e
|
103
|
+
puts "Exception when calling ContentguardsCompositeApi->create: #{e}"
|
104
|
+
end
|
105
|
+
```
|
106
|
+
|
107
|
+
### Parameters
|
108
|
+
|
109
|
+
|
110
|
+
Name | Type | Description | Notes
|
111
|
+
------------- | ------------- | ------------- | -------------
|
112
|
+
**composite_content_guard** | [**CompositeContentGuard**](CompositeContentGuard.md)| |
|
113
|
+
|
114
|
+
### Return type
|
115
|
+
|
116
|
+
[**CompositeContentGuardResponse**](CompositeContentGuardResponse.md)
|
117
|
+
|
118
|
+
### Authorization
|
119
|
+
|
120
|
+
[basicAuth](../README.md#basicAuth)
|
121
|
+
|
122
|
+
### HTTP request headers
|
123
|
+
|
124
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
125
|
+
- **Accept**: application/json
|
126
|
+
|
127
|
+
|
128
|
+
## delete
|
129
|
+
|
130
|
+
> delete(composite_content_guard_href)
|
131
|
+
|
132
|
+
Delete a composite content guard
|
133
|
+
|
134
|
+
Content guard that queries a list-of content-guards for access permissions.
|
135
|
+
|
136
|
+
### Example
|
137
|
+
|
138
|
+
```ruby
|
139
|
+
# load the gem
|
140
|
+
require 'pulpcore_client'
|
141
|
+
# setup authorization
|
142
|
+
PulpcoreClient.configure do |config|
|
143
|
+
# Configure HTTP basic authorization: basicAuth
|
144
|
+
config.username = 'YOUR USERNAME'
|
145
|
+
config.password = 'YOUR PASSWORD'
|
146
|
+
end
|
147
|
+
|
148
|
+
api_instance = PulpcoreClient::ContentguardsCompositeApi.new
|
149
|
+
composite_content_guard_href = 'composite_content_guard_href_example' # String |
|
150
|
+
|
151
|
+
begin
|
152
|
+
#Delete a composite content guard
|
153
|
+
api_instance.delete(composite_content_guard_href)
|
154
|
+
rescue PulpcoreClient::ApiError => e
|
155
|
+
puts "Exception when calling ContentguardsCompositeApi->delete: #{e}"
|
156
|
+
end
|
157
|
+
```
|
158
|
+
|
159
|
+
### Parameters
|
160
|
+
|
161
|
+
|
162
|
+
Name | Type | Description | Notes
|
163
|
+
------------- | ------------- | ------------- | -------------
|
164
|
+
**composite_content_guard_href** | **String**| |
|
165
|
+
|
166
|
+
### Return type
|
167
|
+
|
168
|
+
nil (empty response body)
|
169
|
+
|
170
|
+
### Authorization
|
171
|
+
|
172
|
+
[basicAuth](../README.md#basicAuth)
|
173
|
+
|
174
|
+
### HTTP request headers
|
175
|
+
|
176
|
+
- **Content-Type**: Not defined
|
177
|
+
- **Accept**: Not defined
|
178
|
+
|
179
|
+
|
180
|
+
## list
|
181
|
+
|
182
|
+
> PaginatedCompositeContentGuardResponseList list(opts)
|
183
|
+
|
184
|
+
List composite content guards
|
185
|
+
|
186
|
+
Content guard that queries a list-of content-guards for access permissions.
|
187
|
+
|
188
|
+
### Example
|
189
|
+
|
190
|
+
```ruby
|
191
|
+
# load the gem
|
192
|
+
require 'pulpcore_client'
|
193
|
+
# setup authorization
|
194
|
+
PulpcoreClient.configure do |config|
|
195
|
+
# Configure HTTP basic authorization: basicAuth
|
196
|
+
config.username = 'YOUR USERNAME'
|
197
|
+
config.password = 'YOUR PASSWORD'
|
198
|
+
end
|
199
|
+
|
200
|
+
api_instance = PulpcoreClient::ContentguardsCompositeApi.new
|
201
|
+
opts = {
|
202
|
+
limit: 56, # Integer | Number of results to return per page.
|
203
|
+
name: 'name_example', # String | Filter results where name matches value
|
204
|
+
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
205
|
+
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
206
|
+
name__iexact: 'name__iexact_example', # String | Filter results where name matches value
|
207
|
+
name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
208
|
+
name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
|
209
|
+
name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
|
210
|
+
name__regex: 'name__regex_example', # String | Filter results where name matches regex value
|
211
|
+
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
212
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
213
|
+
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) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
214
|
+
pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
|
215
|
+
pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
|
216
|
+
q: 'q_example', # String |
|
217
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
218
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
219
|
+
}
|
220
|
+
|
221
|
+
begin
|
222
|
+
#List composite content guards
|
223
|
+
result = api_instance.list(opts)
|
224
|
+
p result
|
225
|
+
rescue PulpcoreClient::ApiError => e
|
226
|
+
puts "Exception when calling ContentguardsCompositeApi->list: #{e}"
|
227
|
+
end
|
228
|
+
```
|
229
|
+
|
230
|
+
### Parameters
|
231
|
+
|
232
|
+
|
233
|
+
Name | Type | Description | Notes
|
234
|
+
------------- | ------------- | ------------- | -------------
|
235
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
236
|
+
**name** | **String**| Filter results where name matches value | [optional]
|
237
|
+
**name__contains** | **String**| Filter results where name contains value | [optional]
|
238
|
+
**name__icontains** | **String**| Filter results where name contains value | [optional]
|
239
|
+
**name__iexact** | **String**| Filter results where name matches value | [optional]
|
240
|
+
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
241
|
+
**name__iregex** | **String**| Filter results where name matches regex value | [optional]
|
242
|
+
**name__istartswith** | **String**| Filter results where name starts with value | [optional]
|
243
|
+
**name__regex** | **String**| Filter results where name matches regex value | [optional]
|
244
|
+
**name__startswith** | **String**| Filter results where name starts with value | [optional]
|
245
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
246
|
+
**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) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
|
247
|
+
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
248
|
+
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
249
|
+
**q** | **String**| | [optional]
|
250
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
251
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
252
|
+
|
253
|
+
### Return type
|
254
|
+
|
255
|
+
[**PaginatedCompositeContentGuardResponseList**](PaginatedCompositeContentGuardResponseList.md)
|
256
|
+
|
257
|
+
### Authorization
|
258
|
+
|
259
|
+
[basicAuth](../README.md#basicAuth)
|
260
|
+
|
261
|
+
### HTTP request headers
|
262
|
+
|
263
|
+
- **Content-Type**: Not defined
|
264
|
+
- **Accept**: application/json
|
265
|
+
|
266
|
+
|
267
|
+
## list_roles
|
268
|
+
|
269
|
+
> ObjectRolesResponse list_roles(composite_content_guard_href, opts)
|
270
|
+
|
271
|
+
List roles
|
272
|
+
|
273
|
+
List roles assigned to this object.
|
274
|
+
|
275
|
+
### Example
|
276
|
+
|
277
|
+
```ruby
|
278
|
+
# load the gem
|
279
|
+
require 'pulpcore_client'
|
280
|
+
# setup authorization
|
281
|
+
PulpcoreClient.configure do |config|
|
282
|
+
# Configure HTTP basic authorization: basicAuth
|
283
|
+
config.username = 'YOUR USERNAME'
|
284
|
+
config.password = 'YOUR PASSWORD'
|
285
|
+
end
|
286
|
+
|
287
|
+
api_instance = PulpcoreClient::ContentguardsCompositeApi.new
|
288
|
+
composite_content_guard_href = 'composite_content_guard_href_example' # String |
|
289
|
+
opts = {
|
290
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
291
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
292
|
+
}
|
293
|
+
|
294
|
+
begin
|
295
|
+
#List roles
|
296
|
+
result = api_instance.list_roles(composite_content_guard_href, opts)
|
297
|
+
p result
|
298
|
+
rescue PulpcoreClient::ApiError => e
|
299
|
+
puts "Exception when calling ContentguardsCompositeApi->list_roles: #{e}"
|
300
|
+
end
|
301
|
+
```
|
302
|
+
|
303
|
+
### Parameters
|
304
|
+
|
305
|
+
|
306
|
+
Name | Type | Description | Notes
|
307
|
+
------------- | ------------- | ------------- | -------------
|
308
|
+
**composite_content_guard_href** | **String**| |
|
309
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
310
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
311
|
+
|
312
|
+
### Return type
|
313
|
+
|
314
|
+
[**ObjectRolesResponse**](ObjectRolesResponse.md)
|
315
|
+
|
316
|
+
### Authorization
|
317
|
+
|
318
|
+
[basicAuth](../README.md#basicAuth)
|
319
|
+
|
320
|
+
### HTTP request headers
|
321
|
+
|
322
|
+
- **Content-Type**: Not defined
|
323
|
+
- **Accept**: application/json
|
324
|
+
|
325
|
+
|
326
|
+
## my_permissions
|
327
|
+
|
328
|
+
> MyPermissionsResponse my_permissions(composite_content_guard_href, opts)
|
329
|
+
|
330
|
+
List user permissions
|
331
|
+
|
332
|
+
List permissions available to the current user on this object.
|
333
|
+
|
334
|
+
### Example
|
335
|
+
|
336
|
+
```ruby
|
337
|
+
# load the gem
|
338
|
+
require 'pulpcore_client'
|
339
|
+
# setup authorization
|
340
|
+
PulpcoreClient.configure do |config|
|
341
|
+
# Configure HTTP basic authorization: basicAuth
|
342
|
+
config.username = 'YOUR USERNAME'
|
343
|
+
config.password = 'YOUR PASSWORD'
|
344
|
+
end
|
345
|
+
|
346
|
+
api_instance = PulpcoreClient::ContentguardsCompositeApi.new
|
347
|
+
composite_content_guard_href = 'composite_content_guard_href_example' # String |
|
348
|
+
opts = {
|
349
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
350
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
351
|
+
}
|
352
|
+
|
353
|
+
begin
|
354
|
+
#List user permissions
|
355
|
+
result = api_instance.my_permissions(composite_content_guard_href, opts)
|
356
|
+
p result
|
357
|
+
rescue PulpcoreClient::ApiError => e
|
358
|
+
puts "Exception when calling ContentguardsCompositeApi->my_permissions: #{e}"
|
359
|
+
end
|
360
|
+
```
|
361
|
+
|
362
|
+
### Parameters
|
363
|
+
|
364
|
+
|
365
|
+
Name | Type | Description | Notes
|
366
|
+
------------- | ------------- | ------------- | -------------
|
367
|
+
**composite_content_guard_href** | **String**| |
|
368
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
369
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
370
|
+
|
371
|
+
### Return type
|
372
|
+
|
373
|
+
[**MyPermissionsResponse**](MyPermissionsResponse.md)
|
374
|
+
|
375
|
+
### Authorization
|
376
|
+
|
377
|
+
[basicAuth](../README.md#basicAuth)
|
378
|
+
|
379
|
+
### HTTP request headers
|
380
|
+
|
381
|
+
- **Content-Type**: Not defined
|
382
|
+
- **Accept**: application/json
|
383
|
+
|
384
|
+
|
385
|
+
## partial_update
|
386
|
+
|
387
|
+
> CompositeContentGuardResponse partial_update(composite_content_guard_href, patched_composite_content_guard)
|
388
|
+
|
389
|
+
Update a composite content guard
|
390
|
+
|
391
|
+
Content guard that queries a list-of content-guards for access permissions.
|
392
|
+
|
393
|
+
### Example
|
394
|
+
|
395
|
+
```ruby
|
396
|
+
# load the gem
|
397
|
+
require 'pulpcore_client'
|
398
|
+
# setup authorization
|
399
|
+
PulpcoreClient.configure do |config|
|
400
|
+
# Configure HTTP basic authorization: basicAuth
|
401
|
+
config.username = 'YOUR USERNAME'
|
402
|
+
config.password = 'YOUR PASSWORD'
|
403
|
+
end
|
404
|
+
|
405
|
+
api_instance = PulpcoreClient::ContentguardsCompositeApi.new
|
406
|
+
composite_content_guard_href = 'composite_content_guard_href_example' # String |
|
407
|
+
patched_composite_content_guard = PulpcoreClient::PatchedCompositeContentGuard.new # PatchedCompositeContentGuard |
|
408
|
+
|
409
|
+
begin
|
410
|
+
#Update a composite content guard
|
411
|
+
result = api_instance.partial_update(composite_content_guard_href, patched_composite_content_guard)
|
412
|
+
p result
|
413
|
+
rescue PulpcoreClient::ApiError => e
|
414
|
+
puts "Exception when calling ContentguardsCompositeApi->partial_update: #{e}"
|
415
|
+
end
|
416
|
+
```
|
417
|
+
|
418
|
+
### Parameters
|
419
|
+
|
420
|
+
|
421
|
+
Name | Type | Description | Notes
|
422
|
+
------------- | ------------- | ------------- | -------------
|
423
|
+
**composite_content_guard_href** | **String**| |
|
424
|
+
**patched_composite_content_guard** | [**PatchedCompositeContentGuard**](PatchedCompositeContentGuard.md)| |
|
425
|
+
|
426
|
+
### Return type
|
427
|
+
|
428
|
+
[**CompositeContentGuardResponse**](CompositeContentGuardResponse.md)
|
429
|
+
|
430
|
+
### Authorization
|
431
|
+
|
432
|
+
[basicAuth](../README.md#basicAuth)
|
433
|
+
|
434
|
+
### HTTP request headers
|
435
|
+
|
436
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
437
|
+
- **Accept**: application/json
|
438
|
+
|
439
|
+
|
440
|
+
## read
|
441
|
+
|
442
|
+
> CompositeContentGuardResponse read(composite_content_guard_href, opts)
|
443
|
+
|
444
|
+
Inspect a composite content guard
|
445
|
+
|
446
|
+
Content guard that queries a list-of content-guards for access permissions.
|
447
|
+
|
448
|
+
### Example
|
449
|
+
|
450
|
+
```ruby
|
451
|
+
# load the gem
|
452
|
+
require 'pulpcore_client'
|
453
|
+
# setup authorization
|
454
|
+
PulpcoreClient.configure do |config|
|
455
|
+
# Configure HTTP basic authorization: basicAuth
|
456
|
+
config.username = 'YOUR USERNAME'
|
457
|
+
config.password = 'YOUR PASSWORD'
|
458
|
+
end
|
459
|
+
|
460
|
+
api_instance = PulpcoreClient::ContentguardsCompositeApi.new
|
461
|
+
composite_content_guard_href = 'composite_content_guard_href_example' # String |
|
462
|
+
opts = {
|
463
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
464
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
465
|
+
}
|
466
|
+
|
467
|
+
begin
|
468
|
+
#Inspect a composite content guard
|
469
|
+
result = api_instance.read(composite_content_guard_href, opts)
|
470
|
+
p result
|
471
|
+
rescue PulpcoreClient::ApiError => e
|
472
|
+
puts "Exception when calling ContentguardsCompositeApi->read: #{e}"
|
473
|
+
end
|
474
|
+
```
|
475
|
+
|
476
|
+
### Parameters
|
477
|
+
|
478
|
+
|
479
|
+
Name | Type | Description | Notes
|
480
|
+
------------- | ------------- | ------------- | -------------
|
481
|
+
**composite_content_guard_href** | **String**| |
|
482
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
483
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
484
|
+
|
485
|
+
### Return type
|
486
|
+
|
487
|
+
[**CompositeContentGuardResponse**](CompositeContentGuardResponse.md)
|
488
|
+
|
489
|
+
### Authorization
|
490
|
+
|
491
|
+
[basicAuth](../README.md#basicAuth)
|
492
|
+
|
493
|
+
### HTTP request headers
|
494
|
+
|
495
|
+
- **Content-Type**: Not defined
|
496
|
+
- **Accept**: application/json
|
497
|
+
|
498
|
+
|
499
|
+
## remove_role
|
500
|
+
|
501
|
+
> NestedRoleResponse remove_role(composite_content_guard_href, nested_role)
|
502
|
+
|
503
|
+
Remove a role
|
504
|
+
|
505
|
+
Remove a role for this object from users/groups.
|
506
|
+
|
507
|
+
### Example
|
508
|
+
|
509
|
+
```ruby
|
510
|
+
# load the gem
|
511
|
+
require 'pulpcore_client'
|
512
|
+
# setup authorization
|
513
|
+
PulpcoreClient.configure do |config|
|
514
|
+
# Configure HTTP basic authorization: basicAuth
|
515
|
+
config.username = 'YOUR USERNAME'
|
516
|
+
config.password = 'YOUR PASSWORD'
|
517
|
+
end
|
518
|
+
|
519
|
+
api_instance = PulpcoreClient::ContentguardsCompositeApi.new
|
520
|
+
composite_content_guard_href = 'composite_content_guard_href_example' # String |
|
521
|
+
nested_role = PulpcoreClient::NestedRole.new # NestedRole |
|
522
|
+
|
523
|
+
begin
|
524
|
+
#Remove a role
|
525
|
+
result = api_instance.remove_role(composite_content_guard_href, nested_role)
|
526
|
+
p result
|
527
|
+
rescue PulpcoreClient::ApiError => e
|
528
|
+
puts "Exception when calling ContentguardsCompositeApi->remove_role: #{e}"
|
529
|
+
end
|
530
|
+
```
|
531
|
+
|
532
|
+
### Parameters
|
533
|
+
|
534
|
+
|
535
|
+
Name | Type | Description | Notes
|
536
|
+
------------- | ------------- | ------------- | -------------
|
537
|
+
**composite_content_guard_href** | **String**| |
|
538
|
+
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
539
|
+
|
540
|
+
### Return type
|
541
|
+
|
542
|
+
[**NestedRoleResponse**](NestedRoleResponse.md)
|
543
|
+
|
544
|
+
### Authorization
|
545
|
+
|
546
|
+
[basicAuth](../README.md#basicAuth)
|
547
|
+
|
548
|
+
### HTTP request headers
|
549
|
+
|
550
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
551
|
+
- **Accept**: application/json
|
552
|
+
|
553
|
+
|
554
|
+
## update
|
555
|
+
|
556
|
+
> CompositeContentGuardResponse update(composite_content_guard_href, composite_content_guard)
|
557
|
+
|
558
|
+
Update a composite content guard
|
559
|
+
|
560
|
+
Content guard that queries a list-of content-guards for access permissions.
|
561
|
+
|
562
|
+
### Example
|
563
|
+
|
564
|
+
```ruby
|
565
|
+
# load the gem
|
566
|
+
require 'pulpcore_client'
|
567
|
+
# setup authorization
|
568
|
+
PulpcoreClient.configure do |config|
|
569
|
+
# Configure HTTP basic authorization: basicAuth
|
570
|
+
config.username = 'YOUR USERNAME'
|
571
|
+
config.password = 'YOUR PASSWORD'
|
572
|
+
end
|
573
|
+
|
574
|
+
api_instance = PulpcoreClient::ContentguardsCompositeApi.new
|
575
|
+
composite_content_guard_href = 'composite_content_guard_href_example' # String |
|
576
|
+
composite_content_guard = PulpcoreClient::CompositeContentGuard.new # CompositeContentGuard |
|
577
|
+
|
578
|
+
begin
|
579
|
+
#Update a composite content guard
|
580
|
+
result = api_instance.update(composite_content_guard_href, composite_content_guard)
|
581
|
+
p result
|
582
|
+
rescue PulpcoreClient::ApiError => e
|
583
|
+
puts "Exception when calling ContentguardsCompositeApi->update: #{e}"
|
584
|
+
end
|
585
|
+
```
|
586
|
+
|
587
|
+
### Parameters
|
588
|
+
|
589
|
+
|
590
|
+
Name | Type | Description | Notes
|
591
|
+
------------- | ------------- | ------------- | -------------
|
592
|
+
**composite_content_guard_href** | **String**| |
|
593
|
+
**composite_content_guard** | [**CompositeContentGuard**](CompositeContentGuard.md)| |
|
594
|
+
|
595
|
+
### Return type
|
596
|
+
|
597
|
+
[**CompositeContentGuardResponse**](CompositeContentGuardResponse.md)
|
598
|
+
|
599
|
+
### Authorization
|
600
|
+
|
601
|
+
[basicAuth](../README.md#basicAuth)
|
602
|
+
|
603
|
+
### HTTP request headers
|
604
|
+
|
605
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
606
|
+
- **Accept**: application/json
|
607
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpcoreClient::PaginatedCompositeContentGuardResponseList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
**_next** | **String** | | [optional]
|
9
|
+
**previous** | **String** | | [optional]
|
10
|
+
**results** | [**Array<CompositeContentGuardResponse>**](CompositeContentGuardResponse.md) | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpcoreClient'
|
16
|
+
|
17
|
+
instance = PulpcoreClient::PaginatedCompositeContentGuardResponseList.new(count: 123,
|
18
|
+
_next: http://api.example.org/accounts/?offset=400&limit=100,
|
19
|
+
previous: http://api.example.org/accounts/?offset=200&limit=100,
|
20
|
+
results: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# PulpcoreClient::PatchedCompositeContentGuard
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | The unique name. | [optional]
|
8
|
+
**description** | **String** | An optional description. | [optional]
|
9
|
+
**guards** | **Array<String>** | List of ContentGuards to ask for access-permission. | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'PulpcoreClient'
|
15
|
+
|
16
|
+
instance = PulpcoreClient::PatchedCompositeContentGuard.new(name: null,
|
17
|
+
description: null,
|
18
|
+
guards: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -36,8 +36,8 @@ module PulpcoreClient
|
|
36
36
|
# @option opts [Array<String>] :ordering 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) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
37
37
|
# @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas.
|
38
38
|
# @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas.
|
39
|
-
# @option opts [String] :pulp_type Pulp type * `core.rbac` - core.rbac * `core.content_redirect` - core.content_redirect * `core.header` - core.header
|
40
|
-
# @option opts [Array<String>] :pulp_type__in Multiple values may be separated by commas. * `core.rbac` - core.rbac * `core.content_redirect` - core.content_redirect * `core.header` - core.header
|
39
|
+
# @option opts [String] :pulp_type Pulp type * `core.rbac` - core.rbac * `core.content_redirect` - core.content_redirect * `core.header` - core.header * `core.composite` - core.composite
|
40
|
+
# @option opts [Array<String>] :pulp_type__in Multiple values may be separated by commas. * `core.rbac` - core.rbac * `core.content_redirect` - core.content_redirect * `core.header` - core.header * `core.composite` - core.composite
|
41
41
|
# @option opts [String] :q
|
42
42
|
# @option opts [Array<String>] :fields A list of fields to include in the response.
|
43
43
|
# @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
|
@@ -64,8 +64,8 @@ module PulpcoreClient
|
|
64
64
|
# @option opts [Array<String>] :ordering 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) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
65
65
|
# @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas.
|
66
66
|
# @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas.
|
67
|
-
# @option opts [String] :pulp_type Pulp type * `core.rbac` - core.rbac * `core.content_redirect` - core.content_redirect * `core.header` - core.header
|
68
|
-
# @option opts [Array<String>] :pulp_type__in Multiple values may be separated by commas. * `core.rbac` - core.rbac * `core.content_redirect` - core.content_redirect * `core.header` - core.header
|
67
|
+
# @option opts [String] :pulp_type Pulp type * `core.rbac` - core.rbac * `core.content_redirect` - core.content_redirect * `core.header` - core.header * `core.composite` - core.composite
|
68
|
+
# @option opts [Array<String>] :pulp_type__in Multiple values may be separated by commas. * `core.rbac` - core.rbac * `core.content_redirect` - core.content_redirect * `core.header` - core.header * `core.composite` - core.composite
|
69
69
|
# @option opts [String] :q
|
70
70
|
# @option opts [Array<String>] :fields A list of fields to include in the response.
|
71
71
|
# @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
|
@@ -78,11 +78,11 @@ module PulpcoreClient
|
|
78
78
|
if @api_client.config.client_side_validation && opts[:'ordering'] && !opts[:'ordering'].all? { |item| allowable_values.include?(item) }
|
79
79
|
fail ArgumentError, "invalid value for \"ordering\", must include one of #{allowable_values}"
|
80
80
|
end
|
81
|
-
allowable_values = ["core.content_redirect", "core.header", "core.rbac"]
|
81
|
+
allowable_values = ["core.composite", "core.content_redirect", "core.header", "core.rbac"]
|
82
82
|
if @api_client.config.client_side_validation && opts[:'pulp_type'] && !allowable_values.include?(opts[:'pulp_type'])
|
83
83
|
fail ArgumentError, "invalid value for \"pulp_type\", must be one of #{allowable_values}"
|
84
84
|
end
|
85
|
-
allowable_values = ["core.content_redirect", "core.header", "core.rbac"]
|
85
|
+
allowable_values = ["core.composite", "core.content_redirect", "core.header", "core.rbac"]
|
86
86
|
if @api_client.config.client_side_validation && opts[:'pulp_type__in'] && !opts[:'pulp_type__in'].all? { |item| allowable_values.include?(item) }
|
87
87
|
fail ArgumentError, "invalid value for \"pulp_type__in\", must include one of #{allowable_values}"
|
88
88
|
end
|