pulp_python_client 3.0.0b9.dev01590959185 → 3.0.0b11.dev01596922885
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of pulp_python_client might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/README.md +49 -42
- data/docs/ContentPackagesApi.md +56 -58
- data/docs/ContentSummary.md +3 -3
- data/docs/ContentSummaryResponse.md +21 -0
- data/docs/DistributionsPypiApi.md +110 -62
- data/docs/InlineResponse200.md +3 -3
- data/docs/InlineResponse2001.md +3 -3
- data/docs/InlineResponse2002.md +3 -3
- data/docs/InlineResponse2003.md +3 -3
- data/docs/InlineResponse2004.md +3 -3
- data/docs/InlineResponse2005.md +3 -3
- data/docs/PatchedpythonPythonDistribution.md +23 -0
- data/docs/PatchedpythonPythonRemote.md +43 -0
- data/docs/PatchedpythonPythonRepository.md +21 -0
- data/docs/PolicyEnum.md +16 -0
- data/docs/PublicationsPypiApi.md +43 -43
- data/docs/PythonBanderRemote.md +19 -0
- data/docs/PythonPythonDistribution.md +1 -7
- data/docs/{PythonPythonDistributionRead.md → PythonPythonDistributionResponse.md} +2 -2
- data/docs/PythonPythonPackageContent.md +61 -0
- data/docs/{PythonPythonPackageContentRead.md → PythonPythonPackageContentResponse.md} +3 -3
- data/docs/PythonPythonPublication.md +2 -8
- data/docs/{PythonPythonPublicationRead.md → PythonPythonPublicationResponse.md} +2 -2
- data/docs/PythonPythonRemote.md +6 -12
- data/docs/{PythonPythonRemoteRead.md → PythonPythonRemoteResponse.md} +7 -7
- data/docs/PythonPythonRepository.md +4 -10
- data/docs/{PythonPythonRepositoryRead.md → PythonPythonRepositoryResponse.md} +5 -3
- data/docs/RemotesPythonApi.md +184 -68
- data/docs/RepositoriesPythonApi.md +97 -73
- data/docs/RepositoriesPythonVersionsApi.md +94 -60
- data/docs/RepositoryAddRemoveContent.md +2 -2
- data/docs/RepositorySyncURL.md +1 -1
- data/docs/RepositoryVersion.md +1 -9
- data/docs/{RepositoryVersionRead.md → RepositoryVersionResponse.md} +3 -3
- data/lib/pulp_python_client.rb +15 -9
- data/lib/pulp_python_client/api/content_packages_api.rb +77 -88
- data/lib/pulp_python_client/api/distributions_pypi_api.rb +157 -94
- data/lib/pulp_python_client/api/publications_pypi_api.rb +65 -65
- data/lib/pulp_python_client/api/remotes_python_api.rb +259 -106
- data/lib/pulp_python_client/api/repositories_python_api.rb +145 -118
- data/lib/pulp_python_client/api/repositories_python_versions_api.rb +137 -89
- data/lib/pulp_python_client/api_client.rb +2 -2
- data/lib/pulp_python_client/api_error.rb +2 -2
- data/lib/pulp_python_client/configuration.rb +3 -3
- data/lib/pulp_python_client/models/async_operation_response.rb +3 -2
- data/lib/pulp_python_client/models/content_summary.rb +9 -15
- data/lib/pulp_python_client/models/content_summary_response.rb +240 -0
- data/lib/pulp_python_client/models/inline_response200.rb +3 -13
- data/lib/pulp_python_client/models/inline_response2001.rb +3 -13
- data/lib/pulp_python_client/models/inline_response2002.rb +3 -13
- data/lib/pulp_python_client/models/inline_response2003.rb +3 -13
- data/lib/pulp_python_client/models/inline_response2004.rb +3 -13
- data/lib/pulp_python_client/models/inline_response2005.rb +3 -13
- data/lib/pulp_python_client/models/patchedpython_python_distribution.rb +240 -0
- data/lib/pulp_python_client/models/patchedpython_python_remote.rb +359 -0
- data/lib/pulp_python_client/models/patchedpython_python_repository.rb +229 -0
- data/lib/pulp_python_client/models/policy_enum.rb +37 -0
- data/lib/pulp_python_client/models/{project_specifier.rb → python_bander_remote.rb} +26 -40
- data/lib/pulp_python_client/models/python_python_distribution.rb +4 -85
- data/lib/pulp_python_client/models/{python_python_distribution_read.rb → python_python_distribution_response.rb} +6 -58
- data/lib/pulp_python_client/models/python_python_package_content.rb +433 -0
- data/lib/pulp_python_client/models/{python_python_package_content_read.rb → python_python_package_content_response.rb} +6 -89
- data/lib/pulp_python_client/models/python_python_publication.rb +7 -37
- data/lib/pulp_python_client/models/{python_python_publication_read.rb → python_python_publication_response.rb} +6 -5
- data/lib/pulp_python_client/models/python_python_remote.rb +13 -209
- data/lib/pulp_python_client/models/{python_python_remote_read.rb → python_python_remote_response.rb} +15 -182
- data/lib/pulp_python_client/models/python_python_repository.rb +18 -78
- data/lib/pulp_python_client/models/{python_python_repository_read.rb → python_python_repository_response.rb} +21 -44
- data/lib/pulp_python_client/models/repository_add_remove_content.rb +5 -4
- data/lib/pulp_python_client/models/repository_sync_url.rb +3 -8
- data/lib/pulp_python_client/models/repository_version.rb +7 -43
- data/lib/pulp_python_client/models/{repository_version_read.rb → repository_version_response.rb} +8 -6
- data/lib/pulp_python_client/version.rb +3 -3
- data/pulp_python_client.gemspec +4 -4
- data/spec/api/content_packages_api_spec.rb +26 -27
- data/spec/api/distributions_pypi_api_spec.rb +41 -20
- data/spec/api/publications_pypi_api_spec.rb +17 -17
- data/spec/api/remotes_python_api_spec.rb +64 -24
- data/spec/api/repositories_python_api_spec.rb +28 -19
- data/spec/api/repositories_python_versions_api_spec.rb +38 -22
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/async_operation_response_spec.rb +2 -2
- data/spec/models/content_summary_response_spec.rb +53 -0
- data/spec/models/content_summary_spec.rb +2 -2
- data/spec/models/inline_response2001_spec.rb +2 -2
- data/spec/models/inline_response2002_spec.rb +2 -2
- data/spec/models/inline_response2003_spec.rb +2 -2
- data/spec/models/inline_response2004_spec.rb +2 -2
- data/spec/models/inline_response2005_spec.rb +2 -2
- data/spec/models/inline_response200_spec.rb +2 -2
- data/spec/models/patchedpython_python_distribution_spec.rb +59 -0
- data/spec/models/patchedpython_python_remote_spec.rb +119 -0
- data/spec/models/patchedpython_python_repository_spec.rb +53 -0
- data/spec/models/policy_enum_spec.rb +35 -0
- data/spec/models/{project_specifier_spec.rb → python_bander_remote_spec.rb} +10 -10
- data/spec/models/{python_python_distribution_read_spec.rb → python_python_distribution_response_spec.rb} +8 -8
- data/spec/models/python_python_distribution_spec.rb +2 -20
- data/spec/models/{python_python_package_content_read_spec.rb → python_python_package_content_response_spec.rb} +8 -8
- data/spec/models/python_python_package_content_spec.rb +173 -0
- data/spec/models/{python_python_publication_read_spec.rb → python_python_publication_response_spec.rb} +8 -8
- data/spec/models/python_python_publication_spec.rb +2 -20
- data/spec/models/{python_python_remote_read_spec.rb → python_python_remote_response_spec.rb} +8 -12
- data/spec/models/python_python_remote_spec.rb +2 -24
- data/spec/models/{python_python_repository_read_spec.rb → python_python_repository_response_spec.rb} +14 -8
- data/spec/models/python_python_repository_spec.rb +5 -23
- data/spec/models/repository_add_remove_content_spec.rb +2 -2
- data/spec/models/repository_sync_url_spec.rb +2 -2
- data/spec/models/{repository_version_read_spec.rb → repository_version_response_spec.rb} +8 -8
- data/spec/models/repository_version_spec.rb +2 -26
- data/spec/spec_helper.rb +2 -2
- metadata +70 -46
- data/docs/ProjectSpecifier.md +0 -19
@@ -0,0 +1,21 @@
|
|
1
|
+
# PulpPythonClient::ContentSummaryResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**added** | [**Object**](.md) | |
|
8
|
+
**removed** | [**Object**](.md) | |
|
9
|
+
**present** | [**Object**](.md) | |
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'PulpPythonClient'
|
15
|
+
|
16
|
+
instance = PulpPythonClient::ContentSummaryResponse.new(added: null,
|
17
|
+
removed: null,
|
18
|
+
present: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -5,17 +5,17 @@ All URIs are relative to *http://pulp*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**create**](DistributionsPypiApi.md#create) | **POST** /pulp/api/v3/distributions/python/pypi/ | Create a python distribution
|
8
|
-
[**delete**](DistributionsPypiApi.md#delete) | **DELETE** {
|
8
|
+
[**delete**](DistributionsPypiApi.md#delete) | **DELETE** {python_python_distribution_href} | Delete a python distribution
|
9
9
|
[**list**](DistributionsPypiApi.md#list) | **GET** /pulp/api/v3/distributions/python/pypi/ | List python distributions
|
10
|
-
[**partial_update**](DistributionsPypiApi.md#partial_update) | **PATCH** {
|
11
|
-
[**read**](DistributionsPypiApi.md#read) | **GET** {
|
12
|
-
[**update**](DistributionsPypiApi.md#update) | **PUT** {
|
10
|
+
[**partial_update**](DistributionsPypiApi.md#partial_update) | **PATCH** {python_python_distribution_href} | Update a python distribution
|
11
|
+
[**read**](DistributionsPypiApi.md#read) | **GET** {python_python_distribution_href} | Inspect a python distribution
|
12
|
+
[**update**](DistributionsPypiApi.md#update) | **PUT** {python_python_distribution_href} | Update a python distribution
|
13
13
|
|
14
14
|
|
15
15
|
|
16
16
|
## create
|
17
17
|
|
18
|
-
> AsyncOperationResponse create(
|
18
|
+
> AsyncOperationResponse create(python_python_distribution)
|
19
19
|
|
20
20
|
Create a python distribution
|
21
21
|
|
@@ -28,17 +28,17 @@ Trigger an asynchronous create task
|
|
28
28
|
require 'pulp_python_client'
|
29
29
|
# setup authorization
|
30
30
|
PulpPythonClient.configure do |config|
|
31
|
-
# Configure HTTP basic authorization:
|
31
|
+
# Configure HTTP basic authorization: basicAuth
|
32
32
|
config.username = 'YOUR USERNAME'
|
33
33
|
config.password = 'YOUR PASSWORD'
|
34
34
|
end
|
35
35
|
|
36
36
|
api_instance = PulpPythonClient::DistributionsPypiApi.new
|
37
|
-
|
37
|
+
python_python_distribution = PulpPythonClient::PythonPythonDistribution.new # PythonPythonDistribution |
|
38
38
|
|
39
39
|
begin
|
40
40
|
#Create a python distribution
|
41
|
-
result = api_instance.create(
|
41
|
+
result = api_instance.create(python_python_distribution)
|
42
42
|
p result
|
43
43
|
rescue PulpPythonClient::ApiError => e
|
44
44
|
puts "Exception when calling DistributionsPypiApi->create: #{e}"
|
@@ -50,7 +50,7 @@ end
|
|
50
50
|
|
51
51
|
Name | Type | Description | Notes
|
52
52
|
------------- | ------------- | ------------- | -------------
|
53
|
-
**
|
53
|
+
**python_python_distribution** | [**PythonPythonDistribution**](PythonPythonDistribution.md)| |
|
54
54
|
|
55
55
|
### Return type
|
56
56
|
|
@@ -58,17 +58,17 @@ Name | Type | Description | Notes
|
|
58
58
|
|
59
59
|
### Authorization
|
60
60
|
|
61
|
-
[
|
61
|
+
[basicAuth](../README.md#basicAuth)
|
62
62
|
|
63
63
|
### HTTP request headers
|
64
64
|
|
65
|
-
- **Content-Type**: application/json
|
65
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
66
66
|
- **Accept**: application/json
|
67
67
|
|
68
68
|
|
69
69
|
## delete
|
70
70
|
|
71
|
-
> AsyncOperationResponse delete(
|
71
|
+
> AsyncOperationResponse delete(python_python_distribution_href, opts)
|
72
72
|
|
73
73
|
Delete a python distribution
|
74
74
|
|
@@ -81,17 +81,26 @@ Trigger an asynchronous delete task
|
|
81
81
|
require 'pulp_python_client'
|
82
82
|
# setup authorization
|
83
83
|
PulpPythonClient.configure do |config|
|
84
|
-
# Configure HTTP basic authorization:
|
84
|
+
# Configure HTTP basic authorization: basicAuth
|
85
85
|
config.username = 'YOUR USERNAME'
|
86
86
|
config.password = 'YOUR PASSWORD'
|
87
87
|
end
|
88
88
|
|
89
89
|
api_instance = PulpPythonClient::DistributionsPypiApi.new
|
90
|
-
|
90
|
+
python_python_distribution_href = 'python_python_distribution_href_example' # String |
|
91
|
+
opts = {
|
92
|
+
base_path: 'base_path_example', # String | base_path
|
93
|
+
base_path__contains: 'base_path__contains_example', # String | base_path__contains
|
94
|
+
base_path__icontains: 'base_path__icontains_example', # String | base_path__icontains
|
95
|
+
base_path__in: 'base_path__in_example', # String | base_path__in
|
96
|
+
name: 'name_example', # String | name
|
97
|
+
name__in: 'name__in_example', # String | name__in
|
98
|
+
ordering: 'ordering_example' # String | Which field to use when ordering the results.
|
99
|
+
}
|
91
100
|
|
92
101
|
begin
|
93
102
|
#Delete a python distribution
|
94
|
-
result = api_instance.delete(
|
103
|
+
result = api_instance.delete(python_python_distribution_href, opts)
|
95
104
|
p result
|
96
105
|
rescue PulpPythonClient::ApiError => e
|
97
106
|
puts "Exception when calling DistributionsPypiApi->delete: #{e}"
|
@@ -103,7 +112,14 @@ end
|
|
103
112
|
|
104
113
|
Name | Type | Description | Notes
|
105
114
|
------------- | ------------- | ------------- | -------------
|
106
|
-
**
|
115
|
+
**python_python_distribution_href** | **String**| |
|
116
|
+
**base_path** | **String**| base_path | [optional]
|
117
|
+
**base_path__contains** | **String**| base_path__contains | [optional]
|
118
|
+
**base_path__icontains** | **String**| base_path__icontains | [optional]
|
119
|
+
**base_path__in** | **String**| base_path__in | [optional]
|
120
|
+
**name** | **String**| name | [optional]
|
121
|
+
**name__in** | **String**| name__in | [optional]
|
122
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
107
123
|
|
108
124
|
### Return type
|
109
125
|
|
@@ -111,7 +127,7 @@ Name | Type | Description | Notes
|
|
111
127
|
|
112
128
|
### Authorization
|
113
129
|
|
114
|
-
[
|
130
|
+
[basicAuth](../README.md#basicAuth)
|
115
131
|
|
116
132
|
### HTTP request headers
|
117
133
|
|
@@ -125,7 +141,7 @@ Name | Type | Description | Notes
|
|
125
141
|
|
126
142
|
List python distributions
|
127
143
|
|
128
|
-
Pulp Python Distributions are used to distribute Python Publications
|
144
|
+
<!-- User-facing documentation, rendered as html--> Pulp Python Distributions are used to distribute <a href=\"../restapi.html#tag/publications\">Python Publications.</a> <b> Pulp Python Distributions should not be confused with \"Python Distribution\" as defined by the Python community.</b> In Pulp usage, Python content is refered to as <a href=\"../restapi.html#tag/content\">Python Package Content.</a>
|
129
145
|
|
130
146
|
### Example
|
131
147
|
|
@@ -134,22 +150,22 @@ List python distributions
|
|
134
150
|
require 'pulp_python_client'
|
135
151
|
# setup authorization
|
136
152
|
PulpPythonClient.configure do |config|
|
137
|
-
# Configure HTTP basic authorization:
|
153
|
+
# Configure HTTP basic authorization: basicAuth
|
138
154
|
config.username = 'YOUR USERNAME'
|
139
155
|
config.password = 'YOUR PASSWORD'
|
140
156
|
end
|
141
157
|
|
142
158
|
api_instance = PulpPythonClient::DistributionsPypiApi.new
|
143
159
|
opts = {
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
|
149
|
-
base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
|
150
|
-
base_path__in: 'base_path__in_example', # String | Filter results where base_path is in a comma-separated list of values
|
160
|
+
base_path: 'base_path_example', # String | base_path
|
161
|
+
base_path__contains: 'base_path__contains_example', # String | base_path__contains
|
162
|
+
base_path__icontains: 'base_path__icontains_example', # String | base_path__icontains
|
163
|
+
base_path__in: 'base_path__in_example', # String | base_path__in
|
151
164
|
limit: 56, # Integer | Number of results to return per page.
|
165
|
+
name: 'name_example', # String | name
|
166
|
+
name__in: 'name__in_example', # String | name__in
|
152
167
|
offset: 56, # Integer | The initial index from which to return the results.
|
168
|
+
ordering: 'ordering_example', # String | Which field to use when ordering the results.
|
153
169
|
fields: 'fields_example', # String | A list of fields to include in the response.
|
154
170
|
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
155
171
|
}
|
@@ -168,15 +184,15 @@ end
|
|
168
184
|
|
169
185
|
Name | Type | Description | Notes
|
170
186
|
------------- | ------------- | ------------- | -------------
|
171
|
-
**
|
172
|
-
**
|
173
|
-
**
|
174
|
-
**
|
175
|
-
**base_path__contains** | **String**| Filter results where base_path contains value | [optional]
|
176
|
-
**base_path__icontains** | **String**| Filter results where base_path contains value | [optional]
|
177
|
-
**base_path__in** | **String**| Filter results where base_path is in a comma-separated list of values | [optional]
|
187
|
+
**base_path** | **String**| base_path | [optional]
|
188
|
+
**base_path__contains** | **String**| base_path__contains | [optional]
|
189
|
+
**base_path__icontains** | **String**| base_path__icontains | [optional]
|
190
|
+
**base_path__in** | **String**| base_path__in | [optional]
|
178
191
|
**limit** | **Integer**| Number of results to return per page. | [optional]
|
192
|
+
**name** | **String**| name | [optional]
|
193
|
+
**name__in** | **String**| name__in | [optional]
|
179
194
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
195
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
180
196
|
**fields** | **String**| A list of fields to include in the response. | [optional]
|
181
197
|
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
182
198
|
|
@@ -186,7 +202,7 @@ Name | Type | Description | Notes
|
|
186
202
|
|
187
203
|
### Authorization
|
188
204
|
|
189
|
-
[
|
205
|
+
[basicAuth](../README.md#basicAuth)
|
190
206
|
|
191
207
|
### HTTP request headers
|
192
208
|
|
@@ -196,9 +212,9 @@ Name | Type | Description | Notes
|
|
196
212
|
|
197
213
|
## partial_update
|
198
214
|
|
199
|
-
> AsyncOperationResponse partial_update(
|
215
|
+
> AsyncOperationResponse partial_update(python_python_distribution_href, patchedpython_python_distribution, opts)
|
200
216
|
|
201
|
-
|
217
|
+
Update a python distribution
|
202
218
|
|
203
219
|
Trigger an asynchronous partial update task
|
204
220
|
|
@@ -209,18 +225,27 @@ Trigger an asynchronous partial update task
|
|
209
225
|
require 'pulp_python_client'
|
210
226
|
# setup authorization
|
211
227
|
PulpPythonClient.configure do |config|
|
212
|
-
# Configure HTTP basic authorization:
|
228
|
+
# Configure HTTP basic authorization: basicAuth
|
213
229
|
config.username = 'YOUR USERNAME'
|
214
230
|
config.password = 'YOUR PASSWORD'
|
215
231
|
end
|
216
232
|
|
217
233
|
api_instance = PulpPythonClient::DistributionsPypiApi.new
|
218
|
-
|
219
|
-
|
234
|
+
python_python_distribution_href = 'python_python_distribution_href_example' # String |
|
235
|
+
patchedpython_python_distribution = PulpPythonClient::PatchedpythonPythonDistribution.new # PatchedpythonPythonDistribution |
|
236
|
+
opts = {
|
237
|
+
base_path: 'base_path_example', # String | base_path
|
238
|
+
base_path__contains: 'base_path__contains_example', # String | base_path__contains
|
239
|
+
base_path__icontains: 'base_path__icontains_example', # String | base_path__icontains
|
240
|
+
base_path__in: 'base_path__in_example', # String | base_path__in
|
241
|
+
name: 'name_example', # String | name
|
242
|
+
name__in: 'name__in_example', # String | name__in
|
243
|
+
ordering: 'ordering_example' # String | Which field to use when ordering the results.
|
244
|
+
}
|
220
245
|
|
221
246
|
begin
|
222
|
-
#
|
223
|
-
result = api_instance.partial_update(
|
247
|
+
#Update a python distribution
|
248
|
+
result = api_instance.partial_update(python_python_distribution_href, patchedpython_python_distribution, opts)
|
224
249
|
p result
|
225
250
|
rescue PulpPythonClient::ApiError => e
|
226
251
|
puts "Exception when calling DistributionsPypiApi->partial_update: #{e}"
|
@@ -232,8 +257,15 @@ end
|
|
232
257
|
|
233
258
|
Name | Type | Description | Notes
|
234
259
|
------------- | ------------- | ------------- | -------------
|
235
|
-
**
|
236
|
-
**
|
260
|
+
**python_python_distribution_href** | **String**| |
|
261
|
+
**patchedpython_python_distribution** | [**PatchedpythonPythonDistribution**](PatchedpythonPythonDistribution.md)| |
|
262
|
+
**base_path** | **String**| base_path | [optional]
|
263
|
+
**base_path__contains** | **String**| base_path__contains | [optional]
|
264
|
+
**base_path__icontains** | **String**| base_path__icontains | [optional]
|
265
|
+
**base_path__in** | **String**| base_path__in | [optional]
|
266
|
+
**name** | **String**| name | [optional]
|
267
|
+
**name__in** | **String**| name__in | [optional]
|
268
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
237
269
|
|
238
270
|
### Return type
|
239
271
|
|
@@ -241,21 +273,21 @@ Name | Type | Description | Notes
|
|
241
273
|
|
242
274
|
### Authorization
|
243
275
|
|
244
|
-
[
|
276
|
+
[basicAuth](../README.md#basicAuth)
|
245
277
|
|
246
278
|
### HTTP request headers
|
247
279
|
|
248
|
-
- **Content-Type**: application/json
|
280
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
249
281
|
- **Accept**: application/json
|
250
282
|
|
251
283
|
|
252
284
|
## read
|
253
285
|
|
254
|
-
>
|
286
|
+
> PythonPythonDistributionResponse read(python_python_distribution_href, opts)
|
255
287
|
|
256
288
|
Inspect a python distribution
|
257
289
|
|
258
|
-
Pulp Python Distributions are used to distribute Python Publications
|
290
|
+
<!-- User-facing documentation, rendered as html--> Pulp Python Distributions are used to distribute <a href=\"../restapi.html#tag/publications\">Python Publications.</a> <b> Pulp Python Distributions should not be confused with \"Python Distribution\" as defined by the Python community.</b> In Pulp usage, Python content is refered to as <a href=\"../restapi.html#tag/content\">Python Package Content.</a>
|
259
291
|
|
260
292
|
### Example
|
261
293
|
|
@@ -264,13 +296,13 @@ Inspect a python distribution
|
|
264
296
|
require 'pulp_python_client'
|
265
297
|
# setup authorization
|
266
298
|
PulpPythonClient.configure do |config|
|
267
|
-
# Configure HTTP basic authorization:
|
299
|
+
# Configure HTTP basic authorization: basicAuth
|
268
300
|
config.username = 'YOUR USERNAME'
|
269
301
|
config.password = 'YOUR PASSWORD'
|
270
302
|
end
|
271
303
|
|
272
304
|
api_instance = PulpPythonClient::DistributionsPypiApi.new
|
273
|
-
|
305
|
+
python_python_distribution_href = 'python_python_distribution_href_example' # String |
|
274
306
|
opts = {
|
275
307
|
fields: 'fields_example', # String | A list of fields to include in the response.
|
276
308
|
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
|
@@ -278,7 +310,7 @@ opts = {
|
|
278
310
|
|
279
311
|
begin
|
280
312
|
#Inspect a python distribution
|
281
|
-
result = api_instance.read(
|
313
|
+
result = api_instance.read(python_python_distribution_href, opts)
|
282
314
|
p result
|
283
315
|
rescue PulpPythonClient::ApiError => e
|
284
316
|
puts "Exception when calling DistributionsPypiApi->read: #{e}"
|
@@ -290,17 +322,17 @@ end
|
|
290
322
|
|
291
323
|
Name | Type | Description | Notes
|
292
324
|
------------- | ------------- | ------------- | -------------
|
293
|
-
**
|
325
|
+
**python_python_distribution_href** | **String**| |
|
294
326
|
**fields** | **String**| A list of fields to include in the response. | [optional]
|
295
327
|
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
|
296
328
|
|
297
329
|
### Return type
|
298
330
|
|
299
|
-
[**
|
331
|
+
[**PythonPythonDistributionResponse**](PythonPythonDistributionResponse.md)
|
300
332
|
|
301
333
|
### Authorization
|
302
334
|
|
303
|
-
[
|
335
|
+
[basicAuth](../README.md#basicAuth)
|
304
336
|
|
305
337
|
### HTTP request headers
|
306
338
|
|
@@ -310,7 +342,7 @@ Name | Type | Description | Notes
|
|
310
342
|
|
311
343
|
## update
|
312
344
|
|
313
|
-
> AsyncOperationResponse update(
|
345
|
+
> AsyncOperationResponse update(python_python_distribution_href, python_python_distribution, opts)
|
314
346
|
|
315
347
|
Update a python distribution
|
316
348
|
|
@@ -323,18 +355,27 @@ Trigger an asynchronous update task
|
|
323
355
|
require 'pulp_python_client'
|
324
356
|
# setup authorization
|
325
357
|
PulpPythonClient.configure do |config|
|
326
|
-
# Configure HTTP basic authorization:
|
358
|
+
# Configure HTTP basic authorization: basicAuth
|
327
359
|
config.username = 'YOUR USERNAME'
|
328
360
|
config.password = 'YOUR PASSWORD'
|
329
361
|
end
|
330
362
|
|
331
363
|
api_instance = PulpPythonClient::DistributionsPypiApi.new
|
332
|
-
|
333
|
-
|
364
|
+
python_python_distribution_href = 'python_python_distribution_href_example' # String |
|
365
|
+
python_python_distribution = PulpPythonClient::PythonPythonDistribution.new # PythonPythonDistribution |
|
366
|
+
opts = {
|
367
|
+
base_path: 'base_path_example', # String | base_path
|
368
|
+
base_path__contains: 'base_path__contains_example', # String | base_path__contains
|
369
|
+
base_path__icontains: 'base_path__icontains_example', # String | base_path__icontains
|
370
|
+
base_path__in: 'base_path__in_example', # String | base_path__in
|
371
|
+
name: 'name_example', # String | name
|
372
|
+
name__in: 'name__in_example', # String | name__in
|
373
|
+
ordering: 'ordering_example' # String | Which field to use when ordering the results.
|
374
|
+
}
|
334
375
|
|
335
376
|
begin
|
336
377
|
#Update a python distribution
|
337
|
-
result = api_instance.update(
|
378
|
+
result = api_instance.update(python_python_distribution_href, python_python_distribution, opts)
|
338
379
|
p result
|
339
380
|
rescue PulpPythonClient::ApiError => e
|
340
381
|
puts "Exception when calling DistributionsPypiApi->update: #{e}"
|
@@ -346,8 +387,15 @@ end
|
|
346
387
|
|
347
388
|
Name | Type | Description | Notes
|
348
389
|
------------- | ------------- | ------------- | -------------
|
349
|
-
**
|
350
|
-
**
|
390
|
+
**python_python_distribution_href** | **String**| |
|
391
|
+
**python_python_distribution** | [**PythonPythonDistribution**](PythonPythonDistribution.md)| |
|
392
|
+
**base_path** | **String**| base_path | [optional]
|
393
|
+
**base_path__contains** | **String**| base_path__contains | [optional]
|
394
|
+
**base_path__icontains** | **String**| base_path__icontains | [optional]
|
395
|
+
**base_path__in** | **String**| base_path__in | [optional]
|
396
|
+
**name** | **String**| name | [optional]
|
397
|
+
**name__in** | **String**| name__in | [optional]
|
398
|
+
**ordering** | **String**| Which field to use when ordering the results. | [optional]
|
351
399
|
|
352
400
|
### Return type
|
353
401
|
|
@@ -355,10 +403,10 @@ Name | Type | Description | Notes
|
|
355
403
|
|
356
404
|
### Authorization
|
357
405
|
|
358
|
-
[
|
406
|
+
[basicAuth](../README.md#basicAuth)
|
359
407
|
|
360
408
|
### HTTP request headers
|
361
409
|
|
362
|
-
- **Content-Type**: application/json
|
410
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
363
411
|
- **Accept**: application/json
|
364
412
|
|
data/docs/InlineResponse200.md
CHANGED
@@ -4,17 +4,17 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**count** | **Integer** | |
|
7
|
+
**count** | **Integer** | | [optional]
|
8
8
|
**_next** | **String** | | [optional]
|
9
9
|
**previous** | **String** | | [optional]
|
10
|
-
**results** | [**Array<
|
10
|
+
**results** | [**Array<PythonPythonPackageContentResponse>**](PythonPythonPackageContentResponse.md) | | [optional]
|
11
11
|
|
12
12
|
## Code Sample
|
13
13
|
|
14
14
|
```ruby
|
15
15
|
require 'PulpPythonClient'
|
16
16
|
|
17
|
-
instance = PulpPythonClient::InlineResponse200.new(count:
|
17
|
+
instance = PulpPythonClient::InlineResponse200.new(count: 123,
|
18
18
|
_next: null,
|
19
19
|
previous: null,
|
20
20
|
results: null)
|
data/docs/InlineResponse2001.md
CHANGED
@@ -4,17 +4,17 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**count** | **Integer** | |
|
7
|
+
**count** | **Integer** | | [optional]
|
8
8
|
**_next** | **String** | | [optional]
|
9
9
|
**previous** | **String** | | [optional]
|
10
|
-
**results** | [**Array<
|
10
|
+
**results** | [**Array<PythonPythonDistributionResponse>**](PythonPythonDistributionResponse.md) | | [optional]
|
11
11
|
|
12
12
|
## Code Sample
|
13
13
|
|
14
14
|
```ruby
|
15
15
|
require 'PulpPythonClient'
|
16
16
|
|
17
|
-
instance = PulpPythonClient::InlineResponse2001.new(count:
|
17
|
+
instance = PulpPythonClient::InlineResponse2001.new(count: 123,
|
18
18
|
_next: null,
|
19
19
|
previous: null,
|
20
20
|
results: null)
|