pulpcore_client 3.20.0 → 3.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +8 -84
- data/docs/ContentApi.md +1 -115
- data/docs/ContentguardsApi.md +1 -280
- data/docs/DistributionsApi.md +3 -281
- data/docs/PublicationsApi.md +0 -113
- data/docs/PulpImport.md +3 -1
- data/docs/RemotesApi.md +0 -280
- data/docs/RepositoriesApi.md +3 -281
- data/docs/UploadsApi.md +228 -0
- data/lib/pulpcore_client/api/content_api.rb +2 -134
- data/lib/pulpcore_client/api/contentguards_api.rb +2 -334
- data/lib/pulpcore_client/api/distributions_api.rb +5 -336
- data/lib/pulpcore_client/api/publications_api.rb +0 -128
- data/lib/pulpcore_client/api/remotes_api.rb +0 -334
- data/lib/pulpcore_client/api/repositories_api.rb +5 -336
- data/lib/pulpcore_client/api/repository_versions_api.rb +1 -1
- data/lib/pulpcore_client/api/uploads_api.rb +268 -0
- data/lib/pulpcore_client/api_client.rb +1 -1
- data/lib/pulpcore_client/models/pulp_import.rb +16 -4
- data/lib/pulpcore_client/version.rb +1 -1
- data/lib/pulpcore_client.rb +0 -31
- data/pulpcore_client.gemspec +3 -3
- data/spec/api/content_api_spec.rb +1 -27
- data/spec/api/contentguards_api_spec.rb +1 -65
- data/spec/api/distributions_api_spec.rb +2 -65
- data/spec/api/publications_api_spec.rb +0 -26
- data/spec/api/remotes_api_spec.rb +0 -64
- data/spec/api/repositories_api_spec.rb +2 -65
- data/spec/api/uploads_api_spec.rb +50 -0
- data/spec/models/pulp_import_spec.rb +6 -0
- metadata +136 -261
- data/docs/AcsApi.md +0 -417
- data/docs/AlternateContentSource.md +0 -23
- data/docs/AlternateContentSourceResponse.md +0 -27
- data/docs/ContentGuard.md +0 -19
- data/docs/Distribution.md +0 -25
- data/docs/Export.md +0 -17
- data/docs/ExportResponse.md +0 -25
- data/docs/Exporter.md +0 -17
- data/docs/ExporterResponse.md +0 -21
- data/docs/ExportersApi.md +0 -362
- data/docs/ExportersExportsApi.md +0 -241
- data/docs/Import.md +0 -19
- data/docs/Importer.md +0 -17
- data/docs/ImporterResponse.md +0 -21
- data/docs/ImportersApi.md +0 -361
- data/docs/ImportersImportsApi.md +0 -241
- data/docs/MultipleArtifactContent.md +0 -17
- data/docs/PaginatedAlternateContentSourceResponseList.md +0 -23
- data/docs/PaginatedExportResponseList.md +0 -23
- data/docs/PaginatedExporterResponseList.md +0 -23
- data/docs/PaginatedImporterResponseList.md +0 -23
- data/docs/PatchedAlternateContentSource.md +0 -23
- data/docs/PatchedContentGuard.md +0 -19
- data/docs/PatchedDistribution.md +0 -25
- data/docs/PatchedExporter.md +0 -17
- data/docs/PatchedImporter.md +0 -17
- data/docs/PatchedRemote.md +0 -57
- data/docs/PatchedRepository.md +0 -25
- data/docs/Remote.md +0 -57
- data/docs/RepositoriesVersionsApi.md +0 -271
- data/docs/Repository.md +0 -25
- data/git_push.sh +0 -58
- data/lib/pulpcore_client/api/acs_api.rb +0 -514
- data/lib/pulpcore_client/api/exporters_api.rb +0 -446
- data/lib/pulpcore_client/api/exporters_exports_api.rb +0 -294
- data/lib/pulpcore_client/api/importers_api.rb +0 -444
- data/lib/pulpcore_client/api/importers_imports_api.rb +0 -294
- data/lib/pulpcore_client/api/repositories_versions_api.rb +0 -343
- data/lib/pulpcore_client/models/alternate_content_source.rb +0 -270
- data/lib/pulpcore_client/models/alternate_content_source_response.rb +0 -270
- data/lib/pulpcore_client/models/content_guard.rb +0 -258
- data/lib/pulpcore_client/models/distribution.rb +0 -297
- data/lib/pulpcore_client/models/export.rb +0 -209
- data/lib/pulpcore_client/models/export_response.rb +0 -250
- data/lib/pulpcore_client/models/exporter.rb +0 -232
- data/lib/pulpcore_client/models/exporter_response.rb +0 -232
- data/lib/pulpcore_client/models/import.rb +0 -228
- data/lib/pulpcore_client/models/importer.rb +0 -232
- data/lib/pulpcore_client/models/importer_response.rb +0 -232
- data/lib/pulpcore_client/models/multiple_artifact_content.rb +0 -213
- data/lib/pulpcore_client/models/paginated_alternate_content_source_response_list.rb +0 -237
- data/lib/pulpcore_client/models/paginated_export_response_list.rb +0 -237
- data/lib/pulpcore_client/models/paginated_exporter_response_list.rb +0 -237
- data/lib/pulpcore_client/models/paginated_importer_response_list.rb +0 -237
- data/lib/pulpcore_client/models/patched_alternate_content_source.rb +0 -256
- data/lib/pulpcore_client/models/patched_content_guard.rb +0 -249
- data/lib/pulpcore_client/models/patched_distribution.rb +0 -279
- data/lib/pulpcore_client/models/patched_exporter.rb +0 -223
- data/lib/pulpcore_client/models/patched_importer.rb +0 -223
- data/lib/pulpcore_client/models/patched_remote.rb +0 -649
- data/lib/pulpcore_client/models/patched_repository.rb +0 -295
- data/lib/pulpcore_client/models/remote.rb +0 -667
- data/lib/pulpcore_client/models/repository.rb +0 -304
- data/spec/api/acs_api_spec.rb +0 -132
- data/spec/api/exporters_api_spec.rb +0 -120
- data/spec/api/exporters_exports_api_spec.rb +0 -90
- data/spec/api/importers_api_spec.rb +0 -120
- data/spec/api/importers_imports_api_spec.rb +0 -90
- data/spec/api/repositories_versions_api_spec.rb +0 -104
- data/spec/models/alternate_content_source_response_spec.rb +0 -71
- data/spec/models/alternate_content_source_spec.rb +0 -59
- data/spec/models/content_guard_spec.rb +0 -47
- data/spec/models/distribution_spec.rb +0 -65
- data/spec/models/export_response_spec.rb +0 -65
- data/spec/models/export_spec.rb +0 -41
- data/spec/models/exporter_response_spec.rb +0 -53
- data/spec/models/exporter_spec.rb +0 -41
- data/spec/models/import_spec.rb +0 -47
- data/spec/models/importer_response_spec.rb +0 -53
- data/spec/models/importer_spec.rb +0 -41
- data/spec/models/multiple_artifact_content_spec.rb +0 -41
- data/spec/models/paginated_alternate_content_source_response_list_spec.rb +0 -59
- data/spec/models/paginated_export_response_list_spec.rb +0 -59
- data/spec/models/paginated_exporter_response_list_spec.rb +0 -59
- data/spec/models/paginated_importer_response_list_spec.rb +0 -59
- data/spec/models/patched_alternate_content_source_spec.rb +0 -59
- data/spec/models/patched_content_guard_spec.rb +0 -47
- data/spec/models/patched_distribution_spec.rb +0 -65
- data/spec/models/patched_exporter_spec.rb +0 -41
- data/spec/models/patched_importer_spec.rb +0 -41
- data/spec/models/patched_remote_spec.rb +0 -161
- data/spec/models/patched_repository_spec.rb +0 -65
- data/spec/models/remote_spec.rb +0 -161
- data/spec/models/repository_spec.rb +0 -65
data/docs/PublicationsApi.md
CHANGED
@@ -4,64 +4,10 @@ All URIs are relative to *https://pulp*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**delete**](PublicationsApi.md#delete) | **DELETE** {publication_href} | Delete a publication
|
8
7
|
[**list**](PublicationsApi.md#list) | **GET** /pulp/api/v3/publications/ | List publications
|
9
|
-
[**read**](PublicationsApi.md#read) | **GET** {publication_href} | Inspect a publication
|
10
8
|
|
11
9
|
|
12
10
|
|
13
|
-
## delete
|
14
|
-
|
15
|
-
> delete(publication_href)
|
16
|
-
|
17
|
-
Delete a publication
|
18
|
-
|
19
|
-
A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.
|
20
|
-
|
21
|
-
### Example
|
22
|
-
|
23
|
-
```ruby
|
24
|
-
# load the gem
|
25
|
-
require 'pulpcore_client'
|
26
|
-
# setup authorization
|
27
|
-
PulpcoreClient.configure do |config|
|
28
|
-
# Configure HTTP basic authorization: basicAuth
|
29
|
-
config.username = 'YOUR USERNAME'
|
30
|
-
config.password = 'YOUR PASSWORD'
|
31
|
-
end
|
32
|
-
|
33
|
-
api_instance = PulpcoreClient::PublicationsApi.new
|
34
|
-
publication_href = 'publication_href_example' # String |
|
35
|
-
|
36
|
-
begin
|
37
|
-
#Delete a publication
|
38
|
-
api_instance.delete(publication_href)
|
39
|
-
rescue PulpcoreClient::ApiError => e
|
40
|
-
puts "Exception when calling PublicationsApi->delete: #{e}"
|
41
|
-
end
|
42
|
-
```
|
43
|
-
|
44
|
-
### Parameters
|
45
|
-
|
46
|
-
|
47
|
-
Name | Type | Description | Notes
|
48
|
-
------------- | ------------- | ------------- | -------------
|
49
|
-
**publication_href** | **String**| |
|
50
|
-
|
51
|
-
### Return type
|
52
|
-
|
53
|
-
nil (empty response body)
|
54
|
-
|
55
|
-
### Authorization
|
56
|
-
|
57
|
-
[basicAuth](../README.md#basicAuth)
|
58
|
-
|
59
|
-
### HTTP request headers
|
60
|
-
|
61
|
-
- **Content-Type**: Not defined
|
62
|
-
- **Accept**: Not defined
|
63
|
-
|
64
|
-
|
65
11
|
## list
|
66
12
|
|
67
13
|
> PaginatedPublicationResponseList list(opts)
|
@@ -144,62 +90,3 @@ Name | Type | Description | Notes
|
|
144
90
|
- **Content-Type**: Not defined
|
145
91
|
- **Accept**: application/json
|
146
92
|
|
147
|
-
|
148
|
-
## read
|
149
|
-
|
150
|
-
> PublicationResponse read(publication_href, opts)
|
151
|
-
|
152
|
-
Inspect a publication
|
153
|
-
|
154
|
-
A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.
|
155
|
-
|
156
|
-
### Example
|
157
|
-
|
158
|
-
```ruby
|
159
|
-
# load the gem
|
160
|
-
require 'pulpcore_client'
|
161
|
-
# setup authorization
|
162
|
-
PulpcoreClient.configure do |config|
|
163
|
-
# Configure HTTP basic authorization: basicAuth
|
164
|
-
config.username = 'YOUR USERNAME'
|
165
|
-
config.password = 'YOUR PASSWORD'
|
166
|
-
end
|
167
|
-
|
168
|
-
api_instance = PulpcoreClient::PublicationsApi.new
|
169
|
-
publication_href = 'publication_href_example' # String |
|
170
|
-
opts = {
|
171
|
-
fields: 'fields_example', # String | A list of fields to include in the response.
|
172
|
-
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
173
|
-
}
|
174
|
-
|
175
|
-
begin
|
176
|
-
#Inspect a publication
|
177
|
-
result = api_instance.read(publication_href, opts)
|
178
|
-
p result
|
179
|
-
rescue PulpcoreClient::ApiError => e
|
180
|
-
puts "Exception when calling PublicationsApi->read: #{e}"
|
181
|
-
end
|
182
|
-
```
|
183
|
-
|
184
|
-
### Parameters
|
185
|
-
|
186
|
-
|
187
|
-
Name | Type | Description | Notes
|
188
|
-
------------- | ------------- | ------------- | -------------
|
189
|
-
**publication_href** | **String**| |
|
190
|
-
**fields** | **String**| A list of fields to include in the response. | [optional]
|
191
|
-
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
192
|
-
|
193
|
-
### Return type
|
194
|
-
|
195
|
-
[**PublicationResponse**](PublicationResponse.md)
|
196
|
-
|
197
|
-
### Authorization
|
198
|
-
|
199
|
-
[basicAuth](../README.md#basicAuth)
|
200
|
-
|
201
|
-
### HTTP request headers
|
202
|
-
|
203
|
-
- **Content-Type**: Not defined
|
204
|
-
- **Accept**: application/json
|
205
|
-
|
data/docs/PulpImport.md
CHANGED
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**path** | **String** | Path to export that will be imported. | [optional]
|
8
8
|
**toc** | **String** | Path to a table-of-contents file describing chunks to be validated, reassembled, and imported. | [optional]
|
9
|
+
**create_repositories** | **Boolean** | If True, missing repositories will be automatically created during the import. | [optional] [default to false]
|
9
10
|
|
10
11
|
## Code Sample
|
11
12
|
|
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
|
|
13
14
|
require 'PulpcoreClient'
|
14
15
|
|
15
16
|
instance = PulpcoreClient::PulpImport.new(path: null,
|
16
|
-
toc: null
|
17
|
+
toc: null,
|
18
|
+
create_repositories: null)
|
17
19
|
```
|
18
20
|
|
19
21
|
|
data/docs/RemotesApi.md
CHANGED
@@ -4,121 +4,10 @@ All URIs are relative to *https://pulp*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**create**](RemotesApi.md#create) | **POST** /pulp/api/v3/remotes/ | Create a remote
|
8
|
-
[**delete**](RemotesApi.md#delete) | **DELETE** {remote_href} | Delete a remote
|
9
7
|
[**list**](RemotesApi.md#list) | **GET** /pulp/api/v3/remotes/ | List remotes
|
10
|
-
[**partial_update**](RemotesApi.md#partial_update) | **PATCH** {remote_href} | Update a remote
|
11
|
-
[**read**](RemotesApi.md#read) | **GET** {remote_href} | Inspect a remote
|
12
|
-
[**update**](RemotesApi.md#update) | **PUT** {remote_href} | Update a remote
|
13
8
|
|
14
9
|
|
15
10
|
|
16
|
-
## create
|
17
|
-
|
18
|
-
> RemoteResponse create(remote)
|
19
|
-
|
20
|
-
Create a remote
|
21
|
-
|
22
|
-
A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.
|
23
|
-
|
24
|
-
### Example
|
25
|
-
|
26
|
-
```ruby
|
27
|
-
# load the gem
|
28
|
-
require 'pulpcore_client'
|
29
|
-
# setup authorization
|
30
|
-
PulpcoreClient.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 = PulpcoreClient::RemotesApi.new
|
37
|
-
remote = PulpcoreClient::Remote.new # Remote |
|
38
|
-
|
39
|
-
begin
|
40
|
-
#Create a remote
|
41
|
-
result = api_instance.create(remote)
|
42
|
-
p result
|
43
|
-
rescue PulpcoreClient::ApiError => e
|
44
|
-
puts "Exception when calling RemotesApi->create: #{e}"
|
45
|
-
end
|
46
|
-
```
|
47
|
-
|
48
|
-
### Parameters
|
49
|
-
|
50
|
-
|
51
|
-
Name | Type | Description | Notes
|
52
|
-
------------- | ------------- | ------------- | -------------
|
53
|
-
**remote** | [**Remote**](Remote.md)| |
|
54
|
-
|
55
|
-
### Return type
|
56
|
-
|
57
|
-
[**RemoteResponse**](RemoteResponse.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(remote_href)
|
72
|
-
|
73
|
-
Delete a remote
|
74
|
-
|
75
|
-
Trigger an asynchronous delete task
|
76
|
-
|
77
|
-
### Example
|
78
|
-
|
79
|
-
```ruby
|
80
|
-
# load the gem
|
81
|
-
require 'pulpcore_client'
|
82
|
-
# setup authorization
|
83
|
-
PulpcoreClient.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 = PulpcoreClient::RemotesApi.new
|
90
|
-
remote_href = 'remote_href_example' # String |
|
91
|
-
|
92
|
-
begin
|
93
|
-
#Delete a remote
|
94
|
-
result = api_instance.delete(remote_href)
|
95
|
-
p result
|
96
|
-
rescue PulpcoreClient::ApiError => e
|
97
|
-
puts "Exception when calling RemotesApi->delete: #{e}"
|
98
|
-
end
|
99
|
-
```
|
100
|
-
|
101
|
-
### Parameters
|
102
|
-
|
103
|
-
|
104
|
-
Name | Type | Description | Notes
|
105
|
-
------------- | ------------- | ------------- | -------------
|
106
|
-
**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
11
|
## list
|
123
12
|
|
124
13
|
> PaginatedRemoteResponseList list(opts)
|
@@ -205,172 +94,3 @@ Name | Type | Description | Notes
|
|
205
94
|
- **Content-Type**: Not defined
|
206
95
|
- **Accept**: application/json
|
207
96
|
|
208
|
-
|
209
|
-
## partial_update
|
210
|
-
|
211
|
-
> AsyncOperationResponse partial_update(remote_href, patched_remote)
|
212
|
-
|
213
|
-
Update a remote
|
214
|
-
|
215
|
-
Trigger an asynchronous partial update task
|
216
|
-
|
217
|
-
### Example
|
218
|
-
|
219
|
-
```ruby
|
220
|
-
# load the gem
|
221
|
-
require 'pulpcore_client'
|
222
|
-
# setup authorization
|
223
|
-
PulpcoreClient.configure do |config|
|
224
|
-
# Configure HTTP basic authorization: basicAuth
|
225
|
-
config.username = 'YOUR USERNAME'
|
226
|
-
config.password = 'YOUR PASSWORD'
|
227
|
-
end
|
228
|
-
|
229
|
-
api_instance = PulpcoreClient::RemotesApi.new
|
230
|
-
remote_href = 'remote_href_example' # String |
|
231
|
-
patched_remote = PulpcoreClient::PatchedRemote.new # PatchedRemote |
|
232
|
-
|
233
|
-
begin
|
234
|
-
#Update a remote
|
235
|
-
result = api_instance.partial_update(remote_href, patched_remote)
|
236
|
-
p result
|
237
|
-
rescue PulpcoreClient::ApiError => e
|
238
|
-
puts "Exception when calling RemotesApi->partial_update: #{e}"
|
239
|
-
end
|
240
|
-
```
|
241
|
-
|
242
|
-
### Parameters
|
243
|
-
|
244
|
-
|
245
|
-
Name | Type | Description | Notes
|
246
|
-
------------- | ------------- | ------------- | -------------
|
247
|
-
**remote_href** | **String**| |
|
248
|
-
**patched_remote** | [**PatchedRemote**](PatchedRemote.md)| |
|
249
|
-
|
250
|
-
### Return type
|
251
|
-
|
252
|
-
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
253
|
-
|
254
|
-
### Authorization
|
255
|
-
|
256
|
-
[basicAuth](../README.md#basicAuth)
|
257
|
-
|
258
|
-
### HTTP request headers
|
259
|
-
|
260
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
261
|
-
- **Accept**: application/json
|
262
|
-
|
263
|
-
|
264
|
-
## read
|
265
|
-
|
266
|
-
> RemoteResponse read(remote_href, opts)
|
267
|
-
|
268
|
-
Inspect a remote
|
269
|
-
|
270
|
-
A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.
|
271
|
-
|
272
|
-
### Example
|
273
|
-
|
274
|
-
```ruby
|
275
|
-
# load the gem
|
276
|
-
require 'pulpcore_client'
|
277
|
-
# setup authorization
|
278
|
-
PulpcoreClient.configure do |config|
|
279
|
-
# Configure HTTP basic authorization: basicAuth
|
280
|
-
config.username = 'YOUR USERNAME'
|
281
|
-
config.password = 'YOUR PASSWORD'
|
282
|
-
end
|
283
|
-
|
284
|
-
api_instance = PulpcoreClient::RemotesApi.new
|
285
|
-
remote_href = 'remote_href_example' # String |
|
286
|
-
opts = {
|
287
|
-
fields: 'fields_example', # String | A list of fields to include in the response.
|
288
|
-
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
289
|
-
}
|
290
|
-
|
291
|
-
begin
|
292
|
-
#Inspect a remote
|
293
|
-
result = api_instance.read(remote_href, opts)
|
294
|
-
p result
|
295
|
-
rescue PulpcoreClient::ApiError => e
|
296
|
-
puts "Exception when calling RemotesApi->read: #{e}"
|
297
|
-
end
|
298
|
-
```
|
299
|
-
|
300
|
-
### Parameters
|
301
|
-
|
302
|
-
|
303
|
-
Name | Type | Description | Notes
|
304
|
-
------------- | ------------- | ------------- | -------------
|
305
|
-
**remote_href** | **String**| |
|
306
|
-
**fields** | **String**| A list of fields to include in the response. | [optional]
|
307
|
-
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
308
|
-
|
309
|
-
### Return type
|
310
|
-
|
311
|
-
[**RemoteResponse**](RemoteResponse.md)
|
312
|
-
|
313
|
-
### Authorization
|
314
|
-
|
315
|
-
[basicAuth](../README.md#basicAuth)
|
316
|
-
|
317
|
-
### HTTP request headers
|
318
|
-
|
319
|
-
- **Content-Type**: Not defined
|
320
|
-
- **Accept**: application/json
|
321
|
-
|
322
|
-
|
323
|
-
## update
|
324
|
-
|
325
|
-
> AsyncOperationResponse update(remote_href, remote)
|
326
|
-
|
327
|
-
Update a remote
|
328
|
-
|
329
|
-
Trigger an asynchronous update task
|
330
|
-
|
331
|
-
### Example
|
332
|
-
|
333
|
-
```ruby
|
334
|
-
# load the gem
|
335
|
-
require 'pulpcore_client'
|
336
|
-
# setup authorization
|
337
|
-
PulpcoreClient.configure do |config|
|
338
|
-
# Configure HTTP basic authorization: basicAuth
|
339
|
-
config.username = 'YOUR USERNAME'
|
340
|
-
config.password = 'YOUR PASSWORD'
|
341
|
-
end
|
342
|
-
|
343
|
-
api_instance = PulpcoreClient::RemotesApi.new
|
344
|
-
remote_href = 'remote_href_example' # String |
|
345
|
-
remote = PulpcoreClient::Remote.new # Remote |
|
346
|
-
|
347
|
-
begin
|
348
|
-
#Update a remote
|
349
|
-
result = api_instance.update(remote_href, remote)
|
350
|
-
p result
|
351
|
-
rescue PulpcoreClient::ApiError => e
|
352
|
-
puts "Exception when calling RemotesApi->update: #{e}"
|
353
|
-
end
|
354
|
-
```
|
355
|
-
|
356
|
-
### Parameters
|
357
|
-
|
358
|
-
|
359
|
-
Name | Type | Description | Notes
|
360
|
-
------------- | ------------- | ------------- | -------------
|
361
|
-
**remote_href** | **String**| |
|
362
|
-
**remote** | [**Remote**](Remote.md)| |
|
363
|
-
|
364
|
-
### Return type
|
365
|
-
|
366
|
-
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
367
|
-
|
368
|
-
### Authorization
|
369
|
-
|
370
|
-
[basicAuth](../README.md#basicAuth)
|
371
|
-
|
372
|
-
### HTTP request headers
|
373
|
-
|
374
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
375
|
-
- **Accept**: application/json
|
376
|
-
|