pulp_docker_client 4.0.0b5
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 +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +79 -0
- data/README.md +131 -0
- data/Rakefile +10 -0
- data/docs/AsyncOperationResponse.md +17 -0
- data/docs/Blob.md +29 -0
- data/docs/ContentBlobsApi.md +182 -0
- data/docs/ContentManifestTagsApi.md +182 -0
- data/docs/ContentManifestsApi.md +180 -0
- data/docs/DistributionsDockerApi.md +352 -0
- data/docs/DockerDistribution.md +31 -0
- data/docs/DockerRemote.md +49 -0
- data/docs/InlineResponse200.md +23 -0
- data/docs/InlineResponse2001.md +23 -0
- data/docs/InlineResponse2002.md +23 -0
- data/docs/InlineResponse2003.md +23 -0
- data/docs/InlineResponse2004.md +23 -0
- data/docs/Manifest.md +37 -0
- data/docs/ManifestTag.md +29 -0
- data/docs/RemotesDockerApi.md +411 -0
- data/docs/RepositorySyncURL.md +19 -0
- data/git_push.sh +55 -0
- data/lib/pulp_docker_client/api/content_blobs_api.rb +222 -0
- data/lib/pulp_docker_client/api/content_manifest_tags_api.rb +222 -0
- data/lib/pulp_docker_client/api/content_manifests_api.rb +219 -0
- data/lib/pulp_docker_client/api/distributions_docker_api.rb +430 -0
- data/lib/pulp_docker_client/api/remotes_docker_api.rb +504 -0
- data/lib/pulp_docker_client/api_client.rb +387 -0
- data/lib/pulp_docker_client/api_error.rb +57 -0
- data/lib/pulp_docker_client/configuration.rb +251 -0
- data/lib/pulp_docker_client/models/async_operation_response.rb +202 -0
- data/lib/pulp_docker_client/models/blob.rb +347 -0
- data/lib/pulp_docker_client/models/docker_distribution.rb +347 -0
- data/lib/pulp_docker_client/models/docker_remote.rb +598 -0
- data/lib/pulp_docker_client/models/inline_response200.rb +235 -0
- data/lib/pulp_docker_client/models/inline_response2001.rb +235 -0
- data/lib/pulp_docker_client/models/inline_response2002.rb +235 -0
- data/lib/pulp_docker_client/models/inline_response2003.rb +235 -0
- data/lib/pulp_docker_client/models/inline_response2004.rb +235 -0
- data/lib/pulp_docker_client/models/manifest.rb +411 -0
- data/lib/pulp_docker_client/models/manifest_tag.rb +328 -0
- data/lib/pulp_docker_client/models/repository_sync_url.rb +214 -0
- data/lib/pulp_docker_client/version.rb +15 -0
- data/lib/pulp_docker_client.rb +56 -0
- data/pulp_docker_client.gemspec +45 -0
- data/spec/api/content_blobs_api_spec.rb +76 -0
- data/spec/api/content_manifest_tags_api_spec.rb +76 -0
- data/spec/api/content_manifests_api_spec.rb +75 -0
- data/spec/api/distributions_docker_api_spec.rb +116 -0
- data/spec/api/remotes_docker_api_spec.rb +130 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/async_operation_response_spec.rb +41 -0
- data/spec/models/blob_spec.rb +77 -0
- data/spec/models/docker_distribution_spec.rb +83 -0
- data/spec/models/docker_remote_spec.rb +141 -0
- data/spec/models/inline_response2001_spec.rb +59 -0
- data/spec/models/inline_response2002_spec.rb +59 -0
- data/spec/models/inline_response2003_spec.rb +59 -0
- data/spec/models/inline_response2004_spec.rb +59 -0
- data/spec/models/inline_response200_spec.rb +59 -0
- data/spec/models/manifest_spec.rb +101 -0
- data/spec/models/manifest_tag_spec.rb +77 -0
- data/spec/models/repository_sync_url_spec.rb +47 -0
- data/spec/spec_helper.rb +111 -0
- metadata +309 -0
@@ -0,0 +1,180 @@
|
|
1
|
+
# PulpDockerClient::ContentManifestsApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create**](ContentManifestsApi.md#create) | **POST** /pulp/api/v3/content/docker/manifests/ | Create a manifest
|
8
|
+
[**list**](ContentManifestsApi.md#list) | **GET** /pulp/api/v3/content/docker/manifests/ | List manifests
|
9
|
+
[**read**](ContentManifestsApi.md#read) | **GET** {manifest_href} | Inspect a manifest
|
10
|
+
|
11
|
+
|
12
|
+
|
13
|
+
## create
|
14
|
+
|
15
|
+
> Manifest create(data)
|
16
|
+
|
17
|
+
Create a manifest
|
18
|
+
|
19
|
+
Create a new Manifest from a request.
|
20
|
+
|
21
|
+
### Example
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
# load the gem
|
25
|
+
require 'pulp_docker_client'
|
26
|
+
# setup authorization
|
27
|
+
PulpDockerClient.configure do |config|
|
28
|
+
# Configure HTTP basic authorization: Basic
|
29
|
+
config.username = 'YOUR USERNAME'
|
30
|
+
config.password = 'YOUR PASSWORD'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = PulpDockerClient::ContentManifestsApi.new
|
34
|
+
data = PulpDockerClient::Manifest.new # Manifest |
|
35
|
+
|
36
|
+
begin
|
37
|
+
#Create a manifest
|
38
|
+
result = api_instance.create(data)
|
39
|
+
p result
|
40
|
+
rescue PulpDockerClient::ApiError => e
|
41
|
+
puts "Exception when calling ContentManifestsApi->create: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
### Parameters
|
46
|
+
|
47
|
+
|
48
|
+
Name | Type | Description | Notes
|
49
|
+
------------- | ------------- | ------------- | -------------
|
50
|
+
**data** | [**Manifest**](Manifest.md)| |
|
51
|
+
|
52
|
+
### Return type
|
53
|
+
|
54
|
+
[**Manifest**](Manifest.md)
|
55
|
+
|
56
|
+
### Authorization
|
57
|
+
|
58
|
+
[Basic](../README.md#Basic)
|
59
|
+
|
60
|
+
### HTTP request headers
|
61
|
+
|
62
|
+
- **Content-Type**: application/json
|
63
|
+
- **Accept**: application/json
|
64
|
+
|
65
|
+
|
66
|
+
## list
|
67
|
+
|
68
|
+
> InlineResponse2002 list(opts)
|
69
|
+
|
70
|
+
List manifests
|
71
|
+
|
72
|
+
ViewSet for Manifest.
|
73
|
+
|
74
|
+
### Example
|
75
|
+
|
76
|
+
```ruby
|
77
|
+
# load the gem
|
78
|
+
require 'pulp_docker_client'
|
79
|
+
# setup authorization
|
80
|
+
PulpDockerClient.configure do |config|
|
81
|
+
# Configure HTTP basic authorization: Basic
|
82
|
+
config.username = 'YOUR USERNAME'
|
83
|
+
config.password = 'YOUR PASSWORD'
|
84
|
+
end
|
85
|
+
|
86
|
+
api_instance = PulpDockerClient::ContentManifestsApi.new
|
87
|
+
opts = {
|
88
|
+
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
|
89
|
+
repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
|
90
|
+
repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
|
91
|
+
page: 56, # Integer | A page number within the paginated result set.
|
92
|
+
page_size: 56 # Integer | Number of results to return per page.
|
93
|
+
}
|
94
|
+
|
95
|
+
begin
|
96
|
+
#List manifests
|
97
|
+
result = api_instance.list(opts)
|
98
|
+
p result
|
99
|
+
rescue PulpDockerClient::ApiError => e
|
100
|
+
puts "Exception when calling ContentManifestsApi->list: #{e}"
|
101
|
+
end
|
102
|
+
```
|
103
|
+
|
104
|
+
### Parameters
|
105
|
+
|
106
|
+
|
107
|
+
Name | Type | Description | Notes
|
108
|
+
------------- | ------------- | ------------- | -------------
|
109
|
+
**repository_version** | **String**| Repository Version referenced by HREF | [optional]
|
110
|
+
**repository_version_added** | **String**| Repository Version referenced by HREF | [optional]
|
111
|
+
**repository_version_removed** | **String**| Repository Version referenced by HREF | [optional]
|
112
|
+
**page** | **Integer**| A page number within the paginated result set. | [optional]
|
113
|
+
**page_size** | **Integer**| Number of results to return per page. | [optional]
|
114
|
+
|
115
|
+
### Return type
|
116
|
+
|
117
|
+
[**InlineResponse2002**](InlineResponse2002.md)
|
118
|
+
|
119
|
+
### Authorization
|
120
|
+
|
121
|
+
[Basic](../README.md#Basic)
|
122
|
+
|
123
|
+
### HTTP request headers
|
124
|
+
|
125
|
+
- **Content-Type**: Not defined
|
126
|
+
- **Accept**: application/json
|
127
|
+
|
128
|
+
|
129
|
+
## read
|
130
|
+
|
131
|
+
> Manifest read(manifest_href)
|
132
|
+
|
133
|
+
Inspect a manifest
|
134
|
+
|
135
|
+
ViewSet for Manifest.
|
136
|
+
|
137
|
+
### Example
|
138
|
+
|
139
|
+
```ruby
|
140
|
+
# load the gem
|
141
|
+
require 'pulp_docker_client'
|
142
|
+
# setup authorization
|
143
|
+
PulpDockerClient.configure do |config|
|
144
|
+
# Configure HTTP basic authorization: Basic
|
145
|
+
config.username = 'YOUR USERNAME'
|
146
|
+
config.password = 'YOUR PASSWORD'
|
147
|
+
end
|
148
|
+
|
149
|
+
api_instance = PulpDockerClient::ContentManifestsApi.new
|
150
|
+
manifest_href = 'manifest_href_example' # String | URI of Manifest. e.g.: /pulp/api/v3/content/docker/manifests/1/
|
151
|
+
|
152
|
+
begin
|
153
|
+
#Inspect a manifest
|
154
|
+
result = api_instance.read(manifest_href)
|
155
|
+
p result
|
156
|
+
rescue PulpDockerClient::ApiError => e
|
157
|
+
puts "Exception when calling ContentManifestsApi->read: #{e}"
|
158
|
+
end
|
159
|
+
```
|
160
|
+
|
161
|
+
### Parameters
|
162
|
+
|
163
|
+
|
164
|
+
Name | Type | Description | Notes
|
165
|
+
------------- | ------------- | ------------- | -------------
|
166
|
+
**manifest_href** | **String**| URI of Manifest. e.g.: /pulp/api/v3/content/docker/manifests/1/ |
|
167
|
+
|
168
|
+
### Return type
|
169
|
+
|
170
|
+
[**Manifest**](Manifest.md)
|
171
|
+
|
172
|
+
### Authorization
|
173
|
+
|
174
|
+
[Basic](../README.md#Basic)
|
175
|
+
|
176
|
+
### HTTP request headers
|
177
|
+
|
178
|
+
- **Content-Type**: Not defined
|
179
|
+
- **Accept**: application/json
|
180
|
+
|
@@ -0,0 +1,352 @@
|
|
1
|
+
# PulpDockerClient::DistributionsDockerApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create**](DistributionsDockerApi.md#create) | **POST** /pulp/api/v3/distributions/docker/docker/ | Create a docker distribution
|
8
|
+
[**delete**](DistributionsDockerApi.md#delete) | **DELETE** {docker_distribution_href} | Delete a docker distribution
|
9
|
+
[**list**](DistributionsDockerApi.md#list) | **GET** /pulp/api/v3/distributions/docker/docker/ | List docker distributions
|
10
|
+
[**partial_update**](DistributionsDockerApi.md#partial_update) | **PATCH** {docker_distribution_href} | Partially update a docker distribution
|
11
|
+
[**read**](DistributionsDockerApi.md#read) | **GET** {docker_distribution_href} | Inspect a docker distribution
|
12
|
+
[**update**](DistributionsDockerApi.md#update) | **PUT** {docker_distribution_href} | Update a docker distribution
|
13
|
+
|
14
|
+
|
15
|
+
|
16
|
+
## create
|
17
|
+
|
18
|
+
> AsyncOperationResponse create(data)
|
19
|
+
|
20
|
+
Create a docker distribution
|
21
|
+
|
22
|
+
Trigger an asynchronous create task
|
23
|
+
|
24
|
+
### Example
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
# load the gem
|
28
|
+
require 'pulp_docker_client'
|
29
|
+
# setup authorization
|
30
|
+
PulpDockerClient.configure do |config|
|
31
|
+
# Configure HTTP basic authorization: Basic
|
32
|
+
config.username = 'YOUR USERNAME'
|
33
|
+
config.password = 'YOUR PASSWORD'
|
34
|
+
end
|
35
|
+
|
36
|
+
api_instance = PulpDockerClient::DistributionsDockerApi.new
|
37
|
+
data = PulpDockerClient::DockerDistribution.new # DockerDistribution |
|
38
|
+
|
39
|
+
begin
|
40
|
+
#Create a docker distribution
|
41
|
+
result = api_instance.create(data)
|
42
|
+
p result
|
43
|
+
rescue PulpDockerClient::ApiError => e
|
44
|
+
puts "Exception when calling DistributionsDockerApi->create: #{e}"
|
45
|
+
end
|
46
|
+
```
|
47
|
+
|
48
|
+
### Parameters
|
49
|
+
|
50
|
+
|
51
|
+
Name | Type | Description | Notes
|
52
|
+
------------- | ------------- | ------------- | -------------
|
53
|
+
**data** | [**DockerDistribution**](DockerDistribution.md)| |
|
54
|
+
|
55
|
+
### Return type
|
56
|
+
|
57
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
58
|
+
|
59
|
+
### Authorization
|
60
|
+
|
61
|
+
[Basic](../README.md#Basic)
|
62
|
+
|
63
|
+
### HTTP request headers
|
64
|
+
|
65
|
+
- **Content-Type**: application/json
|
66
|
+
- **Accept**: application/json
|
67
|
+
|
68
|
+
|
69
|
+
## delete
|
70
|
+
|
71
|
+
> AsyncOperationResponse delete(docker_distribution_href)
|
72
|
+
|
73
|
+
Delete a docker distribution
|
74
|
+
|
75
|
+
Trigger an asynchronous delete task
|
76
|
+
|
77
|
+
### Example
|
78
|
+
|
79
|
+
```ruby
|
80
|
+
# load the gem
|
81
|
+
require 'pulp_docker_client'
|
82
|
+
# setup authorization
|
83
|
+
PulpDockerClient.configure do |config|
|
84
|
+
# Configure HTTP basic authorization: Basic
|
85
|
+
config.username = 'YOUR USERNAME'
|
86
|
+
config.password = 'YOUR PASSWORD'
|
87
|
+
end
|
88
|
+
|
89
|
+
api_instance = PulpDockerClient::DistributionsDockerApi.new
|
90
|
+
docker_distribution_href = 'docker_distribution_href_example' # String | URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/
|
91
|
+
|
92
|
+
begin
|
93
|
+
#Delete a docker distribution
|
94
|
+
result = api_instance.delete(docker_distribution_href)
|
95
|
+
p result
|
96
|
+
rescue PulpDockerClient::ApiError => e
|
97
|
+
puts "Exception when calling DistributionsDockerApi->delete: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
### Parameters
|
102
|
+
|
103
|
+
|
104
|
+
Name | Type | Description | Notes
|
105
|
+
------------- | ------------- | ------------- | -------------
|
106
|
+
**docker_distribution_href** | **String**| URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/ |
|
107
|
+
|
108
|
+
### Return type
|
109
|
+
|
110
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
111
|
+
|
112
|
+
### Authorization
|
113
|
+
|
114
|
+
[Basic](../README.md#Basic)
|
115
|
+
|
116
|
+
### HTTP request headers
|
117
|
+
|
118
|
+
- **Content-Type**: Not defined
|
119
|
+
- **Accept**: application/json
|
120
|
+
|
121
|
+
|
122
|
+
## list
|
123
|
+
|
124
|
+
> InlineResponse2003 list(opts)
|
125
|
+
|
126
|
+
List docker distributions
|
127
|
+
|
128
|
+
ViewSet for DockerDistribution model.
|
129
|
+
|
130
|
+
### Example
|
131
|
+
|
132
|
+
```ruby
|
133
|
+
# load the gem
|
134
|
+
require 'pulp_docker_client'
|
135
|
+
# setup authorization
|
136
|
+
PulpDockerClient.configure do |config|
|
137
|
+
# Configure HTTP basic authorization: Basic
|
138
|
+
config.username = 'YOUR USERNAME'
|
139
|
+
config.password = 'YOUR PASSWORD'
|
140
|
+
end
|
141
|
+
|
142
|
+
api_instance = PulpDockerClient::DistributionsDockerApi.new
|
143
|
+
opts = {
|
144
|
+
name: 'name_example', # String |
|
145
|
+
name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
|
146
|
+
base_path: 'base_path_example', # String |
|
147
|
+
base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
|
148
|
+
base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
|
149
|
+
base_path__in: 'base_path__in_example', # String | Filter results where base_path is in a comma-separated list of values
|
150
|
+
page: 56, # Integer | A page number within the paginated result set.
|
151
|
+
page_size: 56 # Integer | Number of results to return per page.
|
152
|
+
}
|
153
|
+
|
154
|
+
begin
|
155
|
+
#List docker distributions
|
156
|
+
result = api_instance.list(opts)
|
157
|
+
p result
|
158
|
+
rescue PulpDockerClient::ApiError => e
|
159
|
+
puts "Exception when calling DistributionsDockerApi->list: #{e}"
|
160
|
+
end
|
161
|
+
```
|
162
|
+
|
163
|
+
### Parameters
|
164
|
+
|
165
|
+
|
166
|
+
Name | Type | Description | Notes
|
167
|
+
------------- | ------------- | ------------- | -------------
|
168
|
+
**name** | **String**| | [optional]
|
169
|
+
**name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional]
|
170
|
+
**base_path** | **String**| | [optional]
|
171
|
+
**base_path__contains** | **String**| Filter results where base_path contains value | [optional]
|
172
|
+
**base_path__icontains** | **String**| Filter results where base_path contains value | [optional]
|
173
|
+
**base_path__in** | **String**| Filter results where base_path is in a comma-separated list of values | [optional]
|
174
|
+
**page** | **Integer**| A page number within the paginated result set. | [optional]
|
175
|
+
**page_size** | **Integer**| Number of results to return per page. | [optional]
|
176
|
+
|
177
|
+
### Return type
|
178
|
+
|
179
|
+
[**InlineResponse2003**](InlineResponse2003.md)
|
180
|
+
|
181
|
+
### Authorization
|
182
|
+
|
183
|
+
[Basic](../README.md#Basic)
|
184
|
+
|
185
|
+
### HTTP request headers
|
186
|
+
|
187
|
+
- **Content-Type**: Not defined
|
188
|
+
- **Accept**: application/json
|
189
|
+
|
190
|
+
|
191
|
+
## partial_update
|
192
|
+
|
193
|
+
> AsyncOperationResponse partial_update(docker_distribution_href, data)
|
194
|
+
|
195
|
+
Partially update a docker distribution
|
196
|
+
|
197
|
+
Trigger an asynchronous partial update task
|
198
|
+
|
199
|
+
### Example
|
200
|
+
|
201
|
+
```ruby
|
202
|
+
# load the gem
|
203
|
+
require 'pulp_docker_client'
|
204
|
+
# setup authorization
|
205
|
+
PulpDockerClient.configure do |config|
|
206
|
+
# Configure HTTP basic authorization: Basic
|
207
|
+
config.username = 'YOUR USERNAME'
|
208
|
+
config.password = 'YOUR PASSWORD'
|
209
|
+
end
|
210
|
+
|
211
|
+
api_instance = PulpDockerClient::DistributionsDockerApi.new
|
212
|
+
docker_distribution_href = 'docker_distribution_href_example' # String | URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/
|
213
|
+
data = PulpDockerClient::DockerDistribution.new # DockerDistribution |
|
214
|
+
|
215
|
+
begin
|
216
|
+
#Partially update a docker distribution
|
217
|
+
result = api_instance.partial_update(docker_distribution_href, data)
|
218
|
+
p result
|
219
|
+
rescue PulpDockerClient::ApiError => e
|
220
|
+
puts "Exception when calling DistributionsDockerApi->partial_update: #{e}"
|
221
|
+
end
|
222
|
+
```
|
223
|
+
|
224
|
+
### Parameters
|
225
|
+
|
226
|
+
|
227
|
+
Name | Type | Description | Notes
|
228
|
+
------------- | ------------- | ------------- | -------------
|
229
|
+
**docker_distribution_href** | **String**| URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/ |
|
230
|
+
**data** | [**DockerDistribution**](DockerDistribution.md)| |
|
231
|
+
|
232
|
+
### Return type
|
233
|
+
|
234
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
235
|
+
|
236
|
+
### Authorization
|
237
|
+
|
238
|
+
[Basic](../README.md#Basic)
|
239
|
+
|
240
|
+
### HTTP request headers
|
241
|
+
|
242
|
+
- **Content-Type**: application/json
|
243
|
+
- **Accept**: application/json
|
244
|
+
|
245
|
+
|
246
|
+
## read
|
247
|
+
|
248
|
+
> DockerDistribution read(docker_distribution_href)
|
249
|
+
|
250
|
+
Inspect a docker distribution
|
251
|
+
|
252
|
+
ViewSet for DockerDistribution model.
|
253
|
+
|
254
|
+
### Example
|
255
|
+
|
256
|
+
```ruby
|
257
|
+
# load the gem
|
258
|
+
require 'pulp_docker_client'
|
259
|
+
# setup authorization
|
260
|
+
PulpDockerClient.configure do |config|
|
261
|
+
# Configure HTTP basic authorization: Basic
|
262
|
+
config.username = 'YOUR USERNAME'
|
263
|
+
config.password = 'YOUR PASSWORD'
|
264
|
+
end
|
265
|
+
|
266
|
+
api_instance = PulpDockerClient::DistributionsDockerApi.new
|
267
|
+
docker_distribution_href = 'docker_distribution_href_example' # String | URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/
|
268
|
+
|
269
|
+
begin
|
270
|
+
#Inspect a docker distribution
|
271
|
+
result = api_instance.read(docker_distribution_href)
|
272
|
+
p result
|
273
|
+
rescue PulpDockerClient::ApiError => e
|
274
|
+
puts "Exception when calling DistributionsDockerApi->read: #{e}"
|
275
|
+
end
|
276
|
+
```
|
277
|
+
|
278
|
+
### Parameters
|
279
|
+
|
280
|
+
|
281
|
+
Name | Type | Description | Notes
|
282
|
+
------------- | ------------- | ------------- | -------------
|
283
|
+
**docker_distribution_href** | **String**| URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/ |
|
284
|
+
|
285
|
+
### Return type
|
286
|
+
|
287
|
+
[**DockerDistribution**](DockerDistribution.md)
|
288
|
+
|
289
|
+
### Authorization
|
290
|
+
|
291
|
+
[Basic](../README.md#Basic)
|
292
|
+
|
293
|
+
### HTTP request headers
|
294
|
+
|
295
|
+
- **Content-Type**: Not defined
|
296
|
+
- **Accept**: application/json
|
297
|
+
|
298
|
+
|
299
|
+
## update
|
300
|
+
|
301
|
+
> AsyncOperationResponse update(docker_distribution_href, data)
|
302
|
+
|
303
|
+
Update a docker distribution
|
304
|
+
|
305
|
+
Trigger an asynchronous update task
|
306
|
+
|
307
|
+
### Example
|
308
|
+
|
309
|
+
```ruby
|
310
|
+
# load the gem
|
311
|
+
require 'pulp_docker_client'
|
312
|
+
# setup authorization
|
313
|
+
PulpDockerClient.configure do |config|
|
314
|
+
# Configure HTTP basic authorization: Basic
|
315
|
+
config.username = 'YOUR USERNAME'
|
316
|
+
config.password = 'YOUR PASSWORD'
|
317
|
+
end
|
318
|
+
|
319
|
+
api_instance = PulpDockerClient::DistributionsDockerApi.new
|
320
|
+
docker_distribution_href = 'docker_distribution_href_example' # String | URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/
|
321
|
+
data = PulpDockerClient::DockerDistribution.new # DockerDistribution |
|
322
|
+
|
323
|
+
begin
|
324
|
+
#Update a docker distribution
|
325
|
+
result = api_instance.update(docker_distribution_href, data)
|
326
|
+
p result
|
327
|
+
rescue PulpDockerClient::ApiError => e
|
328
|
+
puts "Exception when calling DistributionsDockerApi->update: #{e}"
|
329
|
+
end
|
330
|
+
```
|
331
|
+
|
332
|
+
### Parameters
|
333
|
+
|
334
|
+
|
335
|
+
Name | Type | Description | Notes
|
336
|
+
------------- | ------------- | ------------- | -------------
|
337
|
+
**docker_distribution_href** | **String**| URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/ |
|
338
|
+
**data** | [**DockerDistribution**](DockerDistribution.md)| |
|
339
|
+
|
340
|
+
### Return type
|
341
|
+
|
342
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
343
|
+
|
344
|
+
### Authorization
|
345
|
+
|
346
|
+
[Basic](../README.md#Basic)
|
347
|
+
|
348
|
+
### HTTP request headers
|
349
|
+
|
350
|
+
- **Content-Type**: application/json
|
351
|
+
- **Accept**: application/json
|
352
|
+
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# PulpDockerClient::DockerDistribution
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**repository_version** | **String** | RepositoryVersion to be served | [optional]
|
8
|
+
**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
|
9
|
+
**_created** | **DateTime** | Timestamp of creation. | [optional]
|
10
|
+
**content_guard** | **String** | An optional content-guard. | [optional]
|
11
|
+
**_href** | **String** | | [optional]
|
12
|
+
**name** | **String** | A unique name. Ex, `rawhide` and `stable`. |
|
13
|
+
**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |
|
14
|
+
**registry_path** | **String** | The Registry hostame:port/name/ to use with docker pull command defined by this distribution. | [optional]
|
15
|
+
|
16
|
+
## Code Sample
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'PulpDockerClient'
|
20
|
+
|
21
|
+
instance = PulpDockerClient::DockerDistribution.new(repository_version: null,
|
22
|
+
repository: null,
|
23
|
+
_created: null,
|
24
|
+
content_guard: null,
|
25
|
+
_href: null,
|
26
|
+
name: null,
|
27
|
+
base_path: null,
|
28
|
+
registry_path: null)
|
29
|
+
```
|
30
|
+
|
31
|
+
|
@@ -0,0 +1,49 @@
|
|
1
|
+
# PulpDockerClient::DockerRemote
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**_href** | **String** | | [optional]
|
8
|
+
**_created** | **DateTime** | Timestamp of creation. | [optional]
|
9
|
+
**_type** | **String** | | [optional]
|
10
|
+
**name** | **String** | A unique name for this remote. |
|
11
|
+
**url** | **String** | The URL of an external content source. |
|
12
|
+
**ssl_ca_certificate** | **String** | A string containing the PEM encoded CA certificate used to validate the server certificate presented by the remote server. All new line characters must be escaped. Returns SHA256 sum on GET. | [optional]
|
13
|
+
**ssl_client_certificate** | **String** | A string containing the PEM encoded client certificate used for authentication. All new line characters must be escaped. Returns SHA256 sum on GET. | [optional]
|
14
|
+
**ssl_client_key** | **String** | A PEM encoded private key used for authentication. Returns SHA256 sum on GET. | [optional]
|
15
|
+
**ssl_validation** | **Boolean** | If True, SSL peer validation must be performed. | [optional]
|
16
|
+
**proxy_url** | **String** | The proxy URL. Format: scheme://user:password@host:port | [optional]
|
17
|
+
**username** | **String** | The username to be used for authentication when syncing. | [optional]
|
18
|
+
**password** | **String** | The password to be used for authentication when syncing. | [optional]
|
19
|
+
**_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional]
|
20
|
+
**download_concurrency** | **Integer** | Total number of simultaneous connections. | [optional]
|
21
|
+
**policy** | **String** | The policy to use when downloading content. | [optional] [default to 'immediate']
|
22
|
+
**upstream_name** | **String** | Name of the upstream repository |
|
23
|
+
**whitelist_tags** | **String** | A comma separated string of tags to sync. Example: latest,1.27.0 | [optional]
|
24
|
+
|
25
|
+
## Code Sample
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'PulpDockerClient'
|
29
|
+
|
30
|
+
instance = PulpDockerClient::DockerRemote.new(_href: null,
|
31
|
+
_created: null,
|
32
|
+
_type: null,
|
33
|
+
name: null,
|
34
|
+
url: null,
|
35
|
+
ssl_ca_certificate: null,
|
36
|
+
ssl_client_certificate: null,
|
37
|
+
ssl_client_key: null,
|
38
|
+
ssl_validation: null,
|
39
|
+
proxy_url: null,
|
40
|
+
username: null,
|
41
|
+
password: null,
|
42
|
+
_last_updated: null,
|
43
|
+
download_concurrency: null,
|
44
|
+
policy: null,
|
45
|
+
upstream_name: null,
|
46
|
+
whitelist_tags: null)
|
47
|
+
```
|
48
|
+
|
49
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpDockerClient::InlineResponse200
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**_next** | **String** | | [optional]
|
8
|
+
**previous** | **String** | | [optional]
|
9
|
+
**count** | **Integer** | |
|
10
|
+
**results** | [**Array<Blob>**](Blob.md) | |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpDockerClient'
|
16
|
+
|
17
|
+
instance = PulpDockerClient::InlineResponse200.new(_next: null,
|
18
|
+
previous: null,
|
19
|
+
count: null,
|
20
|
+
results: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpDockerClient::InlineResponse2001
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**_next** | **String** | | [optional]
|
8
|
+
**previous** | **String** | | [optional]
|
9
|
+
**count** | **Integer** | |
|
10
|
+
**results** | [**Array<ManifestTag>**](ManifestTag.md) | |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpDockerClient'
|
16
|
+
|
17
|
+
instance = PulpDockerClient::InlineResponse2001.new(_next: null,
|
18
|
+
previous: null,
|
19
|
+
count: null,
|
20
|
+
results: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpDockerClient::InlineResponse2002
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**_next** | **String** | | [optional]
|
8
|
+
**previous** | **String** | | [optional]
|
9
|
+
**count** | **Integer** | |
|
10
|
+
**results** | [**Array<Manifest>**](Manifest.md) | |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpDockerClient'
|
16
|
+
|
17
|
+
instance = PulpDockerClient::InlineResponse2002.new(_next: null,
|
18
|
+
previous: null,
|
19
|
+
count: null,
|
20
|
+
results: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# PulpDockerClient::InlineResponse2003
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**_next** | **String** | | [optional]
|
8
|
+
**previous** | **String** | | [optional]
|
9
|
+
**count** | **Integer** | |
|
10
|
+
**results** | [**Array<DockerDistribution>**](DockerDistribution.md) | |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'PulpDockerClient'
|
16
|
+
|
17
|
+
instance = PulpDockerClient::InlineResponse2003.new(_next: null,
|
18
|
+
previous: null,
|
19
|
+
count: null,
|
20
|
+
results: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|