pulp_file_client 1.8.1 → 1.10.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 +22 -15
- data/docs/AcsFileApi.md +417 -0
- data/docs/ContentFilesApi.md +1 -1
- data/docs/DistributionsFileApi.md +1 -1
- data/docs/FileFileAlternateContentSource.md +23 -0
- data/docs/FileFileAlternateContentSourceResponse.md +27 -0
- data/docs/FileFileRepository.md +3 -3
- data/docs/FileFileRepositoryResponse.md +3 -3
- data/docs/PaginatedfileFileAlternateContentSourceResponseList.md +23 -0
- data/docs/PatchedfileFileAlternateContentSource.md +23 -0
- data/docs/PatchedfileFileRepository.md +3 -3
- data/docs/PublicationsFileApi.md +1 -1
- data/docs/RemotesFileApi.md +1 -1
- data/docs/RepositoriesFileApi.md +1 -1
- data/docs/RepositoriesFileVersionsApi.md +1 -1
- data/docs/TaskGroupOperationResponse.md +17 -0
- data/lib/pulp_file_client/api/acs_file_api.rb +510 -0
- data/lib/pulp_file_client/configuration.rb +2 -2
- data/lib/pulp_file_client/models/file_file_alternate_content_source.rb +251 -0
- data/lib/pulp_file_client/models/file_file_alternate_content_source_response.rb +270 -0
- data/lib/pulp_file_client/models/file_file_repository.rb +17 -16
- data/lib/pulp_file_client/models/file_file_repository_response.rb +17 -16
- data/lib/pulp_file_client/models/paginatedfile_file_alternate_content_source_response_list.rb +237 -0
- data/lib/pulp_file_client/models/patchedfile_file_alternate_content_source.rb +241 -0
- data/lib/pulp_file_client/models/patchedfile_file_repository.rb +17 -16
- data/lib/pulp_file_client/models/task_group_operation_response.rb +213 -0
- data/lib/pulp_file_client/version.rb +1 -1
- data/lib/pulp_file_client.rb +6 -0
- data/spec/api/acs_file_api_spec.rb +132 -0
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/file_file_alternate_content_source_response_spec.rb +71 -0
- data/spec/models/file_file_alternate_content_source_spec.rb +59 -0
- data/spec/models/file_file_repository_response_spec.rb +1 -1
- data/spec/models/file_file_repository_spec.rb +1 -1
- data/spec/models/paginatedfile_file_alternate_content_source_response_list_spec.rb +59 -0
- data/spec/models/patchedfile_file_alternate_content_source_spec.rb +59 -0
- data/spec/models/patchedfile_file_repository_spec.rb +1 -1
- data/spec/models/task_group_operation_response_spec.rb +41 -0
- metadata +44 -20
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 30e94f95bb6a95bec8613984e96a2beab521df43341efedcdc2b61e6a6cdb4fd
|
4
|
+
data.tar.gz: 52ef7ffc7ab38facfe243aa978a4113849909c1f32c147d2a4dae3adf5030ea1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b194c1e79a26c72a6fb308a8fdc05f53a73ac533ca0eff51619b723e0628e1daf5c6098c40546533b64b1cb0ca5cf504b9a2177ea2da3c6af11ca7abe839f70d
|
7
|
+
data.tar.gz: a97d00da9d8e9fce77bb06fc42064f3351612063c50bf6055d27ba14c388bae2f006fd8b97f08bef69bd04c9c6f203d8a7e76553c4510a375e2eae1bfd2da569
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Fetch, Upload, Organize, and Distribute Software Packages
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: v3
|
10
|
-
- Package version: 1.
|
10
|
+
- Package version: 1.10.0
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://pulpproject.org](https://pulpproject.org)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build pulp_file_client.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./pulp_file_client-1.
|
27
|
+
gem install ./pulp_file_client-1.10.0.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./pulp_file_client-1.
|
30
|
+
(for development, run `gem install --dev ./pulp_file_client-1.10.0.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'pulp_file_client', '~> 1.
|
36
|
+
gem 'pulp_file_client', '~> 1.10.0'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -64,30 +64,32 @@ PulpFileClient.configure do |config|
|
|
64
64
|
config.password = 'YOUR_PASSWORD'
|
65
65
|
end
|
66
66
|
|
67
|
-
api_instance = PulpFileClient::
|
68
|
-
|
69
|
-
opts = {
|
70
|
-
artifact: 'artifact_example', # String | Artifact file representing the physical content
|
71
|
-
file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
|
72
|
-
repository: 'repository_example' # String | A URI of a repository the new content unit should be associated with.
|
73
|
-
}
|
67
|
+
api_instance = PulpFileClient::AcsFileApi.new
|
68
|
+
file_file_alternate_content_source = PulpFileClient::FileFileAlternateContentSource.new # FileFileAlternateContentSource |
|
74
69
|
|
75
70
|
begin
|
76
|
-
#Create a file content
|
77
|
-
result = api_instance.create(
|
71
|
+
#Create a file alternate content source
|
72
|
+
result = api_instance.create(file_file_alternate_content_source)
|
78
73
|
p result
|
79
74
|
rescue PulpFileClient::ApiError => e
|
80
|
-
puts "Exception when calling
|
75
|
+
puts "Exception when calling AcsFileApi->create: #{e}"
|
81
76
|
end
|
82
77
|
|
83
78
|
```
|
84
79
|
|
85
80
|
## Documentation for API Endpoints
|
86
81
|
|
87
|
-
All URIs are relative to *
|
82
|
+
All URIs are relative to *https://pulp*
|
88
83
|
|
89
84
|
Class | Method | HTTP request | Description
|
90
85
|
------------ | ------------- | ------------- | -------------
|
86
|
+
*PulpFileClient::AcsFileApi* | [**create**](docs/AcsFileApi.md#create) | **POST** /pulp/api/v3/acs/file/file/ | Create a file alternate content source
|
87
|
+
*PulpFileClient::AcsFileApi* | [**delete**](docs/AcsFileApi.md#delete) | **DELETE** {file_file_alternate_content_source_href} | Delete a file alternate content source
|
88
|
+
*PulpFileClient::AcsFileApi* | [**list**](docs/AcsFileApi.md#list) | **GET** /pulp/api/v3/acs/file/file/ | List file alternate content sources
|
89
|
+
*PulpFileClient::AcsFileApi* | [**partial_update**](docs/AcsFileApi.md#partial_update) | **PATCH** {file_file_alternate_content_source_href} | Update a file alternate content source
|
90
|
+
*PulpFileClient::AcsFileApi* | [**read**](docs/AcsFileApi.md#read) | **GET** {file_file_alternate_content_source_href} | Inspect a file alternate content source
|
91
|
+
*PulpFileClient::AcsFileApi* | [**refresh**](docs/AcsFileApi.md#refresh) | **POST** {file_file_alternate_content_source_href}refresh/ |
|
92
|
+
*PulpFileClient::AcsFileApi* | [**update**](docs/AcsFileApi.md#update) | **PUT** {file_file_alternate_content_source_href} | Update a file alternate content source
|
91
93
|
*PulpFileClient::ContentFilesApi* | [**create**](docs/ContentFilesApi.md#create) | **POST** /pulp/api/v3/content/file/files/ | Create a file content
|
92
94
|
*PulpFileClient::ContentFilesApi* | [**list**](docs/ContentFilesApi.md#list) | **GET** /pulp/api/v3/content/file/files/ | List file contents
|
93
95
|
*PulpFileClient::ContentFilesApi* | [**read**](docs/ContentFilesApi.md#read) | **GET** {file_file_content_href} | Inspect a file content
|
@@ -126,6 +128,8 @@ Class | Method | HTTP request | Description
|
|
126
128
|
- [PulpFileClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
|
127
129
|
- [PulpFileClient::ContentSummary](docs/ContentSummary.md)
|
128
130
|
- [PulpFileClient::ContentSummaryResponse](docs/ContentSummaryResponse.md)
|
131
|
+
- [PulpFileClient::FileFileAlternateContentSource](docs/FileFileAlternateContentSource.md)
|
132
|
+
- [PulpFileClient::FileFileAlternateContentSourceResponse](docs/FileFileAlternateContentSourceResponse.md)
|
129
133
|
- [PulpFileClient::FileFileContent](docs/FileFileContent.md)
|
130
134
|
- [PulpFileClient::FileFileContentResponse](docs/FileFileContentResponse.md)
|
131
135
|
- [PulpFileClient::FileFileDistribution](docs/FileFileDistribution.md)
|
@@ -137,11 +141,13 @@ Class | Method | HTTP request | Description
|
|
137
141
|
- [PulpFileClient::FileFileRepository](docs/FileFileRepository.md)
|
138
142
|
- [PulpFileClient::FileFileRepositoryResponse](docs/FileFileRepositoryResponse.md)
|
139
143
|
- [PulpFileClient::PaginatedRepositoryVersionResponseList](docs/PaginatedRepositoryVersionResponseList.md)
|
144
|
+
- [PulpFileClient::PaginatedfileFileAlternateContentSourceResponseList](docs/PaginatedfileFileAlternateContentSourceResponseList.md)
|
140
145
|
- [PulpFileClient::PaginatedfileFileContentResponseList](docs/PaginatedfileFileContentResponseList.md)
|
141
146
|
- [PulpFileClient::PaginatedfileFileDistributionResponseList](docs/PaginatedfileFileDistributionResponseList.md)
|
142
147
|
- [PulpFileClient::PaginatedfileFilePublicationResponseList](docs/PaginatedfileFilePublicationResponseList.md)
|
143
148
|
- [PulpFileClient::PaginatedfileFileRemoteResponseList](docs/PaginatedfileFileRemoteResponseList.md)
|
144
149
|
- [PulpFileClient::PaginatedfileFileRepositoryResponseList](docs/PaginatedfileFileRepositoryResponseList.md)
|
150
|
+
- [PulpFileClient::PatchedfileFileAlternateContentSource](docs/PatchedfileFileAlternateContentSource.md)
|
145
151
|
- [PulpFileClient::PatchedfileFileDistribution](docs/PatchedfileFileDistribution.md)
|
146
152
|
- [PulpFileClient::PatchedfileFileRemote](docs/PatchedfileFileRemote.md)
|
147
153
|
- [PulpFileClient::PatchedfileFileRepository](docs/PatchedfileFileRepository.md)
|
@@ -150,6 +156,7 @@ Class | Method | HTTP request | Description
|
|
150
156
|
- [PulpFileClient::RepositorySyncURL](docs/RepositorySyncURL.md)
|
151
157
|
- [PulpFileClient::RepositoryVersion](docs/RepositoryVersion.md)
|
152
158
|
- [PulpFileClient::RepositoryVersionResponse](docs/RepositoryVersionResponse.md)
|
159
|
+
- [PulpFileClient::TaskGroupOperationResponse](docs/TaskGroupOperationResponse.md)
|
153
160
|
|
154
161
|
|
155
162
|
## Documentation for Authorization
|
data/docs/AcsFileApi.md
ADDED
@@ -0,0 +1,417 @@
|
|
1
|
+
# PulpFileClient::AcsFileApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pulp*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create**](AcsFileApi.md#create) | **POST** /pulp/api/v3/acs/file/file/ | Create a file alternate content source
|
8
|
+
[**delete**](AcsFileApi.md#delete) | **DELETE** {file_file_alternate_content_source_href} | Delete a file alternate content source
|
9
|
+
[**list**](AcsFileApi.md#list) | **GET** /pulp/api/v3/acs/file/file/ | List file alternate content sources
|
10
|
+
[**partial_update**](AcsFileApi.md#partial_update) | **PATCH** {file_file_alternate_content_source_href} | Update a file alternate content source
|
11
|
+
[**read**](AcsFileApi.md#read) | **GET** {file_file_alternate_content_source_href} | Inspect a file alternate content source
|
12
|
+
[**refresh**](AcsFileApi.md#refresh) | **POST** {file_file_alternate_content_source_href}refresh/ |
|
13
|
+
[**update**](AcsFileApi.md#update) | **PUT** {file_file_alternate_content_source_href} | Update a file alternate content source
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
## create
|
18
|
+
|
19
|
+
> FileFileAlternateContentSourceResponse create(file_file_alternate_content_source)
|
20
|
+
|
21
|
+
Create a file alternate content source
|
22
|
+
|
23
|
+
Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
|
24
|
+
|
25
|
+
### Example
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
# load the gem
|
29
|
+
require 'pulp_file_client'
|
30
|
+
# setup authorization
|
31
|
+
PulpFileClient.configure do |config|
|
32
|
+
# Configure HTTP basic authorization: basicAuth
|
33
|
+
config.username = 'YOUR USERNAME'
|
34
|
+
config.password = 'YOUR PASSWORD'
|
35
|
+
end
|
36
|
+
|
37
|
+
api_instance = PulpFileClient::AcsFileApi.new
|
38
|
+
file_file_alternate_content_source = PulpFileClient::FileFileAlternateContentSource.new # FileFileAlternateContentSource |
|
39
|
+
|
40
|
+
begin
|
41
|
+
#Create a file alternate content source
|
42
|
+
result = api_instance.create(file_file_alternate_content_source)
|
43
|
+
p result
|
44
|
+
rescue PulpFileClient::ApiError => e
|
45
|
+
puts "Exception when calling AcsFileApi->create: #{e}"
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
### Parameters
|
50
|
+
|
51
|
+
|
52
|
+
Name | Type | Description | Notes
|
53
|
+
------------- | ------------- | ------------- | -------------
|
54
|
+
**file_file_alternate_content_source** | [**FileFileAlternateContentSource**](FileFileAlternateContentSource.md)| |
|
55
|
+
|
56
|
+
### Return type
|
57
|
+
|
58
|
+
[**FileFileAlternateContentSourceResponse**](FileFileAlternateContentSourceResponse.md)
|
59
|
+
|
60
|
+
### Authorization
|
61
|
+
|
62
|
+
[basicAuth](../README.md#basicAuth)
|
63
|
+
|
64
|
+
### HTTP request headers
|
65
|
+
|
66
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
67
|
+
- **Accept**: application/json
|
68
|
+
|
69
|
+
|
70
|
+
## delete
|
71
|
+
|
72
|
+
> AsyncOperationResponse delete(file_file_alternate_content_source_href)
|
73
|
+
|
74
|
+
Delete a file alternate content source
|
75
|
+
|
76
|
+
Trigger an asynchronous delete ACS task
|
77
|
+
|
78
|
+
### Example
|
79
|
+
|
80
|
+
```ruby
|
81
|
+
# load the gem
|
82
|
+
require 'pulp_file_client'
|
83
|
+
# setup authorization
|
84
|
+
PulpFileClient.configure do |config|
|
85
|
+
# Configure HTTP basic authorization: basicAuth
|
86
|
+
config.username = 'YOUR USERNAME'
|
87
|
+
config.password = 'YOUR PASSWORD'
|
88
|
+
end
|
89
|
+
|
90
|
+
api_instance = PulpFileClient::AcsFileApi.new
|
91
|
+
file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # String |
|
92
|
+
|
93
|
+
begin
|
94
|
+
#Delete a file alternate content source
|
95
|
+
result = api_instance.delete(file_file_alternate_content_source_href)
|
96
|
+
p result
|
97
|
+
rescue PulpFileClient::ApiError => e
|
98
|
+
puts "Exception when calling AcsFileApi->delete: #{e}"
|
99
|
+
end
|
100
|
+
```
|
101
|
+
|
102
|
+
### Parameters
|
103
|
+
|
104
|
+
|
105
|
+
Name | Type | Description | Notes
|
106
|
+
------------- | ------------- | ------------- | -------------
|
107
|
+
**file_file_alternate_content_source_href** | **String**| |
|
108
|
+
|
109
|
+
### Return type
|
110
|
+
|
111
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
112
|
+
|
113
|
+
### Authorization
|
114
|
+
|
115
|
+
[basicAuth](../README.md#basicAuth)
|
116
|
+
|
117
|
+
### HTTP request headers
|
118
|
+
|
119
|
+
- **Content-Type**: Not defined
|
120
|
+
- **Accept**: application/json
|
121
|
+
|
122
|
+
|
123
|
+
## list
|
124
|
+
|
125
|
+
> PaginatedfileFileAlternateContentSourceResponseList list(opts)
|
126
|
+
|
127
|
+
List file alternate content sources
|
128
|
+
|
129
|
+
Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
|
130
|
+
|
131
|
+
### Example
|
132
|
+
|
133
|
+
```ruby
|
134
|
+
# load the gem
|
135
|
+
require 'pulp_file_client'
|
136
|
+
# setup authorization
|
137
|
+
PulpFileClient.configure do |config|
|
138
|
+
# Configure HTTP basic authorization: basicAuth
|
139
|
+
config.username = 'YOUR USERNAME'
|
140
|
+
config.password = 'YOUR PASSWORD'
|
141
|
+
end
|
142
|
+
|
143
|
+
api_instance = PulpFileClient::AcsFileApi.new
|
144
|
+
opts = {
|
145
|
+
limit: 56, # Integer | Number of results to return per page.
|
146
|
+
name: 'name_example', # String |
|
147
|
+
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
148
|
+
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
149
|
+
name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
150
|
+
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
151
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
152
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
153
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
154
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
155
|
+
}
|
156
|
+
|
157
|
+
begin
|
158
|
+
#List file alternate content sources
|
159
|
+
result = api_instance.list(opts)
|
160
|
+
p result
|
161
|
+
rescue PulpFileClient::ApiError => e
|
162
|
+
puts "Exception when calling AcsFileApi->list: #{e}"
|
163
|
+
end
|
164
|
+
```
|
165
|
+
|
166
|
+
### Parameters
|
167
|
+
|
168
|
+
|
169
|
+
Name | Type | Description | Notes
|
170
|
+
------------- | ------------- | ------------- | -------------
|
171
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
172
|
+
**name** | **String**| | [optional]
|
173
|
+
**name__contains** | **String**| Filter results where name contains value | [optional]
|
174
|
+
**name__icontains** | **String**| Filter results where name contains value | [optional]
|
175
|
+
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
176
|
+
**name__startswith** | **String**| Filter results where name starts with value | [optional]
|
177
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
178
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
179
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
180
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
181
|
+
|
182
|
+
### Return type
|
183
|
+
|
184
|
+
[**PaginatedfileFileAlternateContentSourceResponseList**](PaginatedfileFileAlternateContentSourceResponseList.md)
|
185
|
+
|
186
|
+
### Authorization
|
187
|
+
|
188
|
+
[basicAuth](../README.md#basicAuth)
|
189
|
+
|
190
|
+
### HTTP request headers
|
191
|
+
|
192
|
+
- **Content-Type**: Not defined
|
193
|
+
- **Accept**: application/json
|
194
|
+
|
195
|
+
|
196
|
+
## partial_update
|
197
|
+
|
198
|
+
> AsyncOperationResponse partial_update(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source)
|
199
|
+
|
200
|
+
Update a file alternate content source
|
201
|
+
|
202
|
+
Trigger an asynchronous partial update task
|
203
|
+
|
204
|
+
### Example
|
205
|
+
|
206
|
+
```ruby
|
207
|
+
# load the gem
|
208
|
+
require 'pulp_file_client'
|
209
|
+
# setup authorization
|
210
|
+
PulpFileClient.configure do |config|
|
211
|
+
# Configure HTTP basic authorization: basicAuth
|
212
|
+
config.username = 'YOUR USERNAME'
|
213
|
+
config.password = 'YOUR PASSWORD'
|
214
|
+
end
|
215
|
+
|
216
|
+
api_instance = PulpFileClient::AcsFileApi.new
|
217
|
+
file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # String |
|
218
|
+
patchedfile_file_alternate_content_source = PulpFileClient::PatchedfileFileAlternateContentSource.new # PatchedfileFileAlternateContentSource |
|
219
|
+
|
220
|
+
begin
|
221
|
+
#Update a file alternate content source
|
222
|
+
result = api_instance.partial_update(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source)
|
223
|
+
p result
|
224
|
+
rescue PulpFileClient::ApiError => e
|
225
|
+
puts "Exception when calling AcsFileApi->partial_update: #{e}"
|
226
|
+
end
|
227
|
+
```
|
228
|
+
|
229
|
+
### Parameters
|
230
|
+
|
231
|
+
|
232
|
+
Name | Type | Description | Notes
|
233
|
+
------------- | ------------- | ------------- | -------------
|
234
|
+
**file_file_alternate_content_source_href** | **String**| |
|
235
|
+
**patchedfile_file_alternate_content_source** | [**PatchedfileFileAlternateContentSource**](PatchedfileFileAlternateContentSource.md)| |
|
236
|
+
|
237
|
+
### Return type
|
238
|
+
|
239
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
240
|
+
|
241
|
+
### Authorization
|
242
|
+
|
243
|
+
[basicAuth](../README.md#basicAuth)
|
244
|
+
|
245
|
+
### HTTP request headers
|
246
|
+
|
247
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
248
|
+
- **Accept**: application/json
|
249
|
+
|
250
|
+
|
251
|
+
## read
|
252
|
+
|
253
|
+
> FileFileAlternateContentSourceResponse read(file_file_alternate_content_source_href, opts)
|
254
|
+
|
255
|
+
Inspect a file alternate content source
|
256
|
+
|
257
|
+
Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
|
258
|
+
|
259
|
+
### Example
|
260
|
+
|
261
|
+
```ruby
|
262
|
+
# load the gem
|
263
|
+
require 'pulp_file_client'
|
264
|
+
# setup authorization
|
265
|
+
PulpFileClient.configure do |config|
|
266
|
+
# Configure HTTP basic authorization: basicAuth
|
267
|
+
config.username = 'YOUR USERNAME'
|
268
|
+
config.password = 'YOUR PASSWORD'
|
269
|
+
end
|
270
|
+
|
271
|
+
api_instance = PulpFileClient::AcsFileApi.new
|
272
|
+
file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # String |
|
273
|
+
opts = {
|
274
|
+
fields: 'fields_example', # String | A list of fields to include in the response.
|
275
|
+
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
276
|
+
}
|
277
|
+
|
278
|
+
begin
|
279
|
+
#Inspect a file alternate content source
|
280
|
+
result = api_instance.read(file_file_alternate_content_source_href, opts)
|
281
|
+
p result
|
282
|
+
rescue PulpFileClient::ApiError => e
|
283
|
+
puts "Exception when calling AcsFileApi->read: #{e}"
|
284
|
+
end
|
285
|
+
```
|
286
|
+
|
287
|
+
### Parameters
|
288
|
+
|
289
|
+
|
290
|
+
Name | Type | Description | Notes
|
291
|
+
------------- | ------------- | ------------- | -------------
|
292
|
+
**file_file_alternate_content_source_href** | **String**| |
|
293
|
+
**fields** | **String**| A list of fields to include in the response. | [optional]
|
294
|
+
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
295
|
+
|
296
|
+
### Return type
|
297
|
+
|
298
|
+
[**FileFileAlternateContentSourceResponse**](FileFileAlternateContentSourceResponse.md)
|
299
|
+
|
300
|
+
### Authorization
|
301
|
+
|
302
|
+
[basicAuth](../README.md#basicAuth)
|
303
|
+
|
304
|
+
### HTTP request headers
|
305
|
+
|
306
|
+
- **Content-Type**: Not defined
|
307
|
+
- **Accept**: application/json
|
308
|
+
|
309
|
+
|
310
|
+
## refresh
|
311
|
+
|
312
|
+
> TaskGroupOperationResponse refresh(file_file_alternate_content_source_href, file_file_alternate_content_source)
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
Trigger an asynchronous task to create Alternate Content Source content.
|
317
|
+
|
318
|
+
### Example
|
319
|
+
|
320
|
+
```ruby
|
321
|
+
# load the gem
|
322
|
+
require 'pulp_file_client'
|
323
|
+
# setup authorization
|
324
|
+
PulpFileClient.configure do |config|
|
325
|
+
# Configure HTTP basic authorization: basicAuth
|
326
|
+
config.username = 'YOUR USERNAME'
|
327
|
+
config.password = 'YOUR PASSWORD'
|
328
|
+
end
|
329
|
+
|
330
|
+
api_instance = PulpFileClient::AcsFileApi.new
|
331
|
+
file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # String |
|
332
|
+
file_file_alternate_content_source = PulpFileClient::FileFileAlternateContentSource.new # FileFileAlternateContentSource |
|
333
|
+
|
334
|
+
begin
|
335
|
+
result = api_instance.refresh(file_file_alternate_content_source_href, file_file_alternate_content_source)
|
336
|
+
p result
|
337
|
+
rescue PulpFileClient::ApiError => e
|
338
|
+
puts "Exception when calling AcsFileApi->refresh: #{e}"
|
339
|
+
end
|
340
|
+
```
|
341
|
+
|
342
|
+
### Parameters
|
343
|
+
|
344
|
+
|
345
|
+
Name | Type | Description | Notes
|
346
|
+
------------- | ------------- | ------------- | -------------
|
347
|
+
**file_file_alternate_content_source_href** | **String**| |
|
348
|
+
**file_file_alternate_content_source** | [**FileFileAlternateContentSource**](FileFileAlternateContentSource.md)| |
|
349
|
+
|
350
|
+
### Return type
|
351
|
+
|
352
|
+
[**TaskGroupOperationResponse**](TaskGroupOperationResponse.md)
|
353
|
+
|
354
|
+
### Authorization
|
355
|
+
|
356
|
+
[basicAuth](../README.md#basicAuth)
|
357
|
+
|
358
|
+
### HTTP request headers
|
359
|
+
|
360
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
361
|
+
- **Accept**: application/json
|
362
|
+
|
363
|
+
|
364
|
+
## update
|
365
|
+
|
366
|
+
> AsyncOperationResponse update(file_file_alternate_content_source_href, file_file_alternate_content_source)
|
367
|
+
|
368
|
+
Update a file alternate content source
|
369
|
+
|
370
|
+
Trigger an asynchronous update task
|
371
|
+
|
372
|
+
### Example
|
373
|
+
|
374
|
+
```ruby
|
375
|
+
# load the gem
|
376
|
+
require 'pulp_file_client'
|
377
|
+
# setup authorization
|
378
|
+
PulpFileClient.configure do |config|
|
379
|
+
# Configure HTTP basic authorization: basicAuth
|
380
|
+
config.username = 'YOUR USERNAME'
|
381
|
+
config.password = 'YOUR PASSWORD'
|
382
|
+
end
|
383
|
+
|
384
|
+
api_instance = PulpFileClient::AcsFileApi.new
|
385
|
+
file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # String |
|
386
|
+
file_file_alternate_content_source = PulpFileClient::FileFileAlternateContentSource.new # FileFileAlternateContentSource |
|
387
|
+
|
388
|
+
begin
|
389
|
+
#Update a file alternate content source
|
390
|
+
result = api_instance.update(file_file_alternate_content_source_href, file_file_alternate_content_source)
|
391
|
+
p result
|
392
|
+
rescue PulpFileClient::ApiError => e
|
393
|
+
puts "Exception when calling AcsFileApi->update: #{e}"
|
394
|
+
end
|
395
|
+
```
|
396
|
+
|
397
|
+
### Parameters
|
398
|
+
|
399
|
+
|
400
|
+
Name | Type | Description | Notes
|
401
|
+
------------- | ------------- | ------------- | -------------
|
402
|
+
**file_file_alternate_content_source_href** | **String**| |
|
403
|
+
**file_file_alternate_content_source** | [**FileFileAlternateContentSource**](FileFileAlternateContentSource.md)| |
|
404
|
+
|
405
|
+
### Return type
|
406
|
+
|
407
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
408
|
+
|
409
|
+
### Authorization
|
410
|
+
|
411
|
+
[basicAuth](../README.md#basicAuth)
|
412
|
+
|
413
|
+
### HTTP request headers
|
414
|
+
|
415
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
416
|
+
- **Accept**: application/json
|
417
|
+
|
data/docs/ContentFilesApi.md
CHANGED
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpFileClient::FileFileAlternateContentSource
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | Name of Alternate Content Source. |
|
8
|
+
**last_refreshed** | **DateTime** | Date of last refresh of AlternateContentSource. | [optional]
|
9
|
+
**paths** | **Array<String>** | List of paths that will be appended to the Remote url when searching for content. | [optional]
|
10
|
+
**remote** | **String** | The remote to provide alternate content source. |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpFileClient'
|
16
|
+
|
17
|
+
instance = PulpFileClient::FileFileAlternateContentSource.new(name: null,
|
18
|
+
last_refreshed: null,
|
19
|
+
paths: null,
|
20
|
+
remote: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# PulpFileClient::FileFileAlternateContentSourceResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**pulp_href** | **String** | | [optional] [readonly]
|
8
|
+
**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
|
9
|
+
**name** | **String** | Name of Alternate Content Source. |
|
10
|
+
**last_refreshed** | **DateTime** | Date of last refresh of AlternateContentSource. | [optional]
|
11
|
+
**paths** | **Array<String>** | List of paths that will be appended to the Remote url when searching for content. | [optional]
|
12
|
+
**remote** | **String** | The remote to provide alternate content source. |
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'PulpFileClient'
|
18
|
+
|
19
|
+
instance = PulpFileClient::FileFileAlternateContentSourceResponse.new(pulp_href: null,
|
20
|
+
pulp_created: null,
|
21
|
+
name: null,
|
22
|
+
last_refreshed: null,
|
23
|
+
paths: null,
|
24
|
+
remote: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
data/docs/FileFileRepository.md
CHANGED
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
|
|
7
7
|
**pulp_labels** | [**Object**](.md) | | [optional]
|
8
8
|
**name** | **String** | A unique name for this repository. |
|
9
9
|
**description** | **String** | An optional description. | [optional]
|
10
|
-
**
|
11
|
-
**remote** | **String** |
|
10
|
+
**retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. This is provided as a tech preview in Pulp 3 and may change in the future. | [optional]
|
11
|
+
**remote** | **String** | An optional remote to use by default when syncing. | [optional]
|
12
12
|
**autopublish** | **Boolean** | Whether to automatically create publications for new repository versions, and update any distributions pointing to this repository. | [optional] [default to false]
|
13
13
|
**manifest** | **String** | Filename to use for manifest file containing metadata for all the files. | [optional] [default to 'PULP_MANIFEST']
|
14
14
|
|
@@ -20,7 +20,7 @@ require 'PulpFileClient'
|
|
20
20
|
instance = PulpFileClient::FileFileRepository.new(pulp_labels: null,
|
21
21
|
name: null,
|
22
22
|
description: null,
|
23
|
-
|
23
|
+
retain_repo_versions: null,
|
24
24
|
remote: null,
|
25
25
|
autopublish: null,
|
26
26
|
manifest: null)
|
@@ -11,8 +11,8 @@ Name | Type | Description | Notes
|
|
11
11
|
**latest_version_href** | **String** | | [optional] [readonly]
|
12
12
|
**name** | **String** | A unique name for this repository. |
|
13
13
|
**description** | **String** | An optional description. | [optional]
|
14
|
-
**
|
15
|
-
**remote** | **String** |
|
14
|
+
**retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. This is provided as a tech preview in Pulp 3 and may change in the future. | [optional]
|
15
|
+
**remote** | **String** | An optional remote to use by default when syncing. | [optional]
|
16
16
|
**autopublish** | **Boolean** | Whether to automatically create publications for new repository versions, and update any distributions pointing to this repository. | [optional] [default to false]
|
17
17
|
**manifest** | **String** | Filename to use for manifest file containing metadata for all the files. | [optional] [default to 'PULP_MANIFEST']
|
18
18
|
|
@@ -28,7 +28,7 @@ instance = PulpFileClient::FileFileRepositoryResponse.new(pulp_href: null,
|
|
28
28
|
latest_version_href: null,
|
29
29
|
name: null,
|
30
30
|
description: null,
|
31
|
-
|
31
|
+
retain_repo_versions: null,
|
32
32
|
remote: null,
|
33
33
|
autopublish: null,
|
34
34
|
manifest: null)
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpFileClient::PaginatedfileFileAlternateContentSourceResponseList
|
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<FileFileAlternateContentSourceResponse>**](FileFileAlternateContentSourceResponse.md) | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpFileClient'
|
16
|
+
|
17
|
+
instance = PulpFileClient::PaginatedfileFileAlternateContentSourceResponseList.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
|
+
|