pulp_python_client 3.32.1 → 3.33.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.
Files changed (33) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +13 -4
  3. data/docs/ContentPackagesApi.md +2 -0
  4. data/docs/ContentYanksApi.md +341 -0
  5. data/docs/PaginatedpythonPackageYankResponseList.md +24 -0
  6. data/docs/PypiLegacyApi.md +2 -2
  7. data/docs/PypiSimpleApi.md +2 -2
  8. data/docs/PypiUnyankApi.md +84 -0
  9. data/docs/PypiYankApi.md +84 -0
  10. data/docs/PythonPackageYankResponse.md +34 -0
  11. data/docs/Yank.md +22 -0
  12. data/lib/pulp_python_client/api/content_packages_api.rb +3 -0
  13. data/lib/pulp_python_client/api/content_yanks_api.rb +354 -0
  14. data/lib/pulp_python_client/api/pypi_legacy_api.rb +2 -2
  15. data/lib/pulp_python_client/api/pypi_simple_api.rb +2 -2
  16. data/lib/pulp_python_client/api/pypi_unyank_api.rb +99 -0
  17. data/lib/pulp_python_client/api/pypi_yank_api.rb +99 -0
  18. data/lib/pulp_python_client/models/metadata_version_enum.rb +2 -1
  19. data/lib/pulp_python_client/models/paginatedpython_package_yank_response_list.rb +257 -0
  20. data/lib/pulp_python_client/models/python_package_yank_response.rb +293 -0
  21. data/lib/pulp_python_client/models/yank.rb +290 -0
  22. data/lib/pulp_python_client/version.rb +1 -1
  23. data/lib/pulp_python_client.rb +6 -0
  24. data/spec/api/content_packages_api_spec.rb +1 -0
  25. data/spec/api/content_yanks_api_spec.rb +104 -0
  26. data/spec/api/pypi_legacy_api_spec.rb +1 -1
  27. data/spec/api/pypi_simple_api_spec.rb +1 -1
  28. data/spec/api/pypi_unyank_api_spec.rb +49 -0
  29. data/spec/api/pypi_yank_api_spec.rb +49 -0
  30. data/spec/models/paginatedpython_package_yank_response_list_spec.rb +54 -0
  31. data/spec/models/python_package_yank_response_spec.rb +84 -0
  32. data/spec/models/yank_spec.rb +48 -0
  33. metadata +26 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d5165f94c2bfbb15fbbfaac9a7147a93bced5ea8c72523f3a6dfd21c8497f65a
4
- data.tar.gz: 2af0791bbddc360868294a33a7b2a1eaf718336fedd82ac06404615cf38ece77
3
+ metadata.gz: e0a612bbb473ab32a3c0d54da649c4d02ab80d97e87eebf21c92fdcb830c30c4
4
+ data.tar.gz: c464607eaaedfff6ec11886e06af8ba5e29dc303d6d2fbad4bb52cda5c429c1f
5
5
  SHA512:
6
- metadata.gz: d22097fbc75e246ccab1d1bc094dd4df4d19492f0380e6abca99c70dbaa36062e86d378f0dbb86ff1d29214bdbd7ccce8d8dcc1f386e53e71e69af6e1f6100e1
7
- data.tar.gz: 943bc6e7ffbffebff791ebe7de3cd9a3ddee6ce8ac9a3ea24b2cdd75f51be710c081ee18e8cc7cf4a45c5a372adbe1f3cfac50fe6c283d55c7488af7e8791e1f
6
+ metadata.gz: b5d7bac0df987887fc70a1260bb96be05bdf4bf18daeb50d51a1318fe02ee7bdae71963faf311277f3fb45f1dd1f32a73152b14806fc222d4919cf6b0da9c796
7
+ data.tar.gz: 1143c4d7cc038a363627f3616c5f8c26a822c4529f7b29a95883ccbef3d27d1658b67e3bcfc209606d3f0afa56a195025f9637be041c2f50d3bc946748990f66
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: 3.32.1
10
+ - Package version: 3.33.0
11
11
  - Generator version: 7.10.0
12
12
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
13
13
  For more information, please visit [https://pulpproject.org](https://pulpproject.org)
@@ -25,16 +25,16 @@ gem build pulp_python_client.gemspec
25
25
  Then either install the gem locally:
26
26
 
27
27
  ```shell
28
- gem install ./pulp_python_client-3.32.1.gem
28
+ gem install ./pulp_python_client-3.33.0.gem
29
29
  ```
30
30
 
31
- (for development, run `gem install --dev ./pulp_python_client-3.32.1.gem` to install the development dependencies)
31
+ (for development, run `gem install --dev ./pulp_python_client-3.33.0.gem` to install the development dependencies)
32
32
 
33
33
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
34
34
 
35
35
  Finally add this to the Gemfile:
36
36
 
37
- gem 'pulp_python_client', '~> 3.32.1'
37
+ gem 'pulp_python_client', '~> 3.33.0'
38
38
 
39
39
  ### Install from Git
40
40
 
@@ -136,6 +136,10 @@ Class | Method | HTTP request | Description
136
136
  *PulpPythonClient::ContentProvenanceApi* | [**read**](docs/ContentProvenanceApi.md#read) | **GET** {python_package_provenance_href} | Inspect a package provenance
137
137
  *PulpPythonClient::ContentProvenanceApi* | [**set_label**](docs/ContentProvenanceApi.md#set_label) | **POST** {python_package_provenance_href}set_label/ | Set a label
138
138
  *PulpPythonClient::ContentProvenanceApi* | [**unset_label**](docs/ContentProvenanceApi.md#unset_label) | **POST** {python_package_provenance_href}unset_label/ | Unset a label
139
+ *PulpPythonClient::ContentYanksApi* | [**list**](docs/ContentYanksApi.md#list) | **GET** /pulp/api/v3/content/python/yanks/ | List package yanks
140
+ *PulpPythonClient::ContentYanksApi* | [**read**](docs/ContentYanksApi.md#read) | **GET** {python_package_yank_href} | Inspect a package yank
141
+ *PulpPythonClient::ContentYanksApi* | [**set_label**](docs/ContentYanksApi.md#set_label) | **POST** {python_package_yank_href}set_label/ | Set a label
142
+ *PulpPythonClient::ContentYanksApi* | [**unset_label**](docs/ContentYanksApi.md#unset_label) | **POST** {python_package_yank_href}unset_label/ | Unset a label
139
143
  *PulpPythonClient::DistributionsPypiApi* | [**add_role**](docs/DistributionsPypiApi.md#add_role) | **POST** {python_python_distribution_href}add_role/ | Add a role
140
144
  *PulpPythonClient::DistributionsPypiApi* | [**create**](docs/DistributionsPypiApi.md#create) | **POST** /pulp/api/v3/distributions/python/pypi/ | Create a python distribution
141
145
  *PulpPythonClient::DistributionsPypiApi* | [**delete**](docs/DistributionsPypiApi.md#delete) | **DELETE** {python_python_distribution_href} | Delete a python distribution
@@ -163,6 +167,8 @@ Class | Method | HTTP request | Description
163
167
  *PulpPythonClient::PypiSimpleApi* | [**create**](docs/PypiSimpleApi.md#create) | **POST** /pypi/{path}/simple/ | Upload a package
164
168
  *PulpPythonClient::PypiSimpleApi* | [**pypi_simple_package_read**](docs/PypiSimpleApi.md#pypi_simple_package_read) | **GET** /pypi/{path}/simple/{package}/ | Get package simple page
165
169
  *PulpPythonClient::PypiSimpleApi* | [**read**](docs/PypiSimpleApi.md#read) | **GET** /pypi/{path}/simple/ | Get index simple page
170
+ *PulpPythonClient::PypiUnyankApi* | [**unyank**](docs/PypiUnyankApi.md#unyank) | **POST** /pypi/{path}/unyank/ | Unyank a package version
171
+ *PulpPythonClient::PypiYankApi* | [**yank**](docs/PypiYankApi.md#yank) | **POST** /pypi/{path}/yank/ | Yank a package version
166
172
  *PulpPythonClient::RemotesPythonApi* | [**add_role**](docs/RemotesPythonApi.md#add_role) | **POST** {python_python_remote_href}add_role/ | Add a role
167
173
  *PulpPythonClient::RemotesPythonApi* | [**create**](docs/RemotesPythonApi.md#create) | **POST** /pulp/api/v3/remotes/python/python/ | Create a python remote
168
174
  *PulpPythonClient::RemotesPythonApi* | [**delete**](docs/RemotesPythonApi.md#delete) | **DELETE** {python_python_remote_href} | Delete a python remote
@@ -218,6 +224,7 @@ Class | Method | HTTP request | Description
218
224
  - [PulpPythonClient::PackageUploadTaskResponse](docs/PackageUploadTaskResponse.md)
219
225
  - [PulpPythonClient::PaginatedRepositoryVersionResponseList](docs/PaginatedRepositoryVersionResponseList.md)
220
226
  - [PulpPythonClient::PaginatedpythonPackageProvenanceResponseList](docs/PaginatedpythonPackageProvenanceResponseList.md)
227
+ - [PulpPythonClient::PaginatedpythonPackageYankResponseList](docs/PaginatedpythonPackageYankResponseList.md)
221
228
  - [PulpPythonClient::PaginatedpythonPythonBlocklistEntryResponseList](docs/PaginatedpythonPythonBlocklistEntryResponseList.md)
222
229
  - [PulpPythonClient::PaginatedpythonPythonDistributionResponseList](docs/PaginatedpythonPythonDistributionResponseList.md)
223
230
  - [PulpPythonClient::PaginatedpythonPythonPackageContentResponseList](docs/PaginatedpythonPythonPackageContentResponseList.md)
@@ -230,6 +237,7 @@ Class | Method | HTTP request | Description
230
237
  - [PulpPythonClient::PolicyEnum](docs/PolicyEnum.md)
231
238
  - [PulpPythonClient::ProtocolVersionEnum](docs/ProtocolVersionEnum.md)
232
239
  - [PulpPythonClient::PythonPackageProvenanceResponse](docs/PythonPackageProvenanceResponse.md)
240
+ - [PulpPythonClient::PythonPackageYankResponse](docs/PythonPackageYankResponse.md)
233
241
  - [PulpPythonClient::PythonPythonBlocklistEntry](docs/PythonPythonBlocklistEntry.md)
234
242
  - [PulpPythonClient::PythonPythonBlocklistEntryResponse](docs/PythonPythonBlocklistEntryResponse.md)
235
243
  - [PulpPythonClient::PythonPythonDistribution](docs/PythonPythonDistribution.md)
@@ -253,6 +261,7 @@ Class | Method | HTTP request | Description
253
261
  - [PulpPythonClient::SummaryResponse](docs/SummaryResponse.md)
254
262
  - [PulpPythonClient::UnsetLabel](docs/UnsetLabel.md)
255
263
  - [PulpPythonClient::UnsetLabelResponse](docs/UnsetLabelResponse.md)
264
+ - [PulpPythonClient::Yank](docs/Yank.md)
256
265
 
257
266
 
258
267
  ## Documentation for Authorization
@@ -216,6 +216,7 @@ opts = {
216
216
  version__gte: 'version__gte_example', # String | Filter results where version is greater than or equal to value
217
217
  version__lt: 'version__lt_example', # String | Filter results where version is less than value
218
218
  version__lte: 'version__lte_example', # String | Filter results where version is less than or equal to value
219
+ version_specifier: 'version_specifier_example', # String | Filter by PEP 440 version specifier (e.g., >=2.4,<3.0 or ~=1.26)
219
220
  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
220
221
  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
221
222
  }
@@ -287,6 +288,7 @@ end
287
288
  | **version__gte** | **String** | Filter results where version is greater than or equal to value | [optional] |
288
289
  | **version__lt** | **String** | Filter results where version is less than value | [optional] |
289
290
  | **version__lte** | **String** | Filter results where version is less than or equal to value | [optional] |
291
+ | **version_specifier** | **String** | Filter by PEP 440 version specifier (e.g., &gt;&#x3D;2.4,&lt;3.0 or ~&#x3D;1.26) | [optional] |
290
292
  | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
291
293
  | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
292
294
 
@@ -0,0 +1,341 @@
1
+ # PulpPythonClient::ContentYanksApi
2
+
3
+ All URIs are relative to *http://localhost:24817*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**list**](ContentYanksApi.md#list) | **GET** /pulp/api/v3/content/python/yanks/ | List package yanks |
8
+ | [**read**](ContentYanksApi.md#read) | **GET** {python_package_yank_href} | Inspect a package yank |
9
+ | [**set_label**](ContentYanksApi.md#set_label) | **POST** {python_package_yank_href}set_label/ | Set a label |
10
+ | [**unset_label**](ContentYanksApi.md#unset_label) | **POST** {python_package_yank_href}unset_label/ | Unset a label |
11
+
12
+
13
+ ## list
14
+
15
+ > <PaginatedpythonPackageYankResponseList> list(opts)
16
+
17
+ List package yanks
18
+
19
+ Read-only viewset for PackageYank content units (PEP 592). PackageYank markers indicate that a package version has been yanked in a repository. Use the /yank/ and /unyank/ PyPI endpoints to create or remove these markers.
20
+
21
+ ### Examples
22
+
23
+ ```ruby
24
+ require 'time'
25
+ require 'pulp_python_client'
26
+ # setup authorization
27
+ PulpPythonClient.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 = PulpPythonClient::ContentYanksApi.new
34
+ opts = {
35
+ x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
36
+ limit: 56, # Integer | Number of results to return per page.
37
+ offset: 56, # Integer | The initial index from which to return the results.
38
+ ordering: ['-pk'], # Array<String> | Ordering * `pk` - Pk * `-pk` - Pk (descending)
39
+ orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
40
+ prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
41
+ pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
42
+ pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
43
+ pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
44
+ q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
45
+ repository_version: 'repository_version_example', # String |
46
+ repository_version_added: 'repository_version_added_example', # String |
47
+ repository_version_removed: 'repository_version_removed_example', # String |
48
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
49
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
50
+ }
51
+
52
+ begin
53
+ # List package yanks
54
+ result = api_instance.list(opts)
55
+ p result
56
+ rescue PulpPythonClient::ApiError => e
57
+ puts "Error when calling ContentYanksApi->list: #{e}"
58
+ end
59
+ ```
60
+
61
+ #### Using the list_with_http_info variant
62
+
63
+ This returns an Array which contains the response data, status code and headers.
64
+
65
+ > <Array(<PaginatedpythonPackageYankResponseList>, Integer, Hash)> list_with_http_info(opts)
66
+
67
+ ```ruby
68
+ begin
69
+ # List package yanks
70
+ data, status_code, headers = api_instance.list_with_http_info(opts)
71
+ p status_code # => 2xx
72
+ p headers # => { ... }
73
+ p data # => <PaginatedpythonPackageYankResponseList>
74
+ rescue PulpPythonClient::ApiError => e
75
+ puts "Error when calling ContentYanksApi->list_with_http_info: #{e}"
76
+ end
77
+ ```
78
+
79
+ ### Parameters
80
+
81
+ | Name | Type | Description | Notes |
82
+ | ---- | ---- | ----------- | ----- |
83
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
84
+ | **limit** | **Integer** | Number of results to return per page. | [optional] |
85
+ | **offset** | **Integer** | The initial index from which to return the results. | [optional] |
86
+ | **ordering** | [**Array&lt;String&gt;**](String.md) | Ordering * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
87
+ | **orphaned_for** | **Float** | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] |
88
+ | **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
89
+ | **pulp_href__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
90
+ | **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
91
+ | **pulp_label_select** | **String** | Filter labels by search string | [optional] |
92
+ | **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
93
+ | **repository_version** | **String** | | [optional] |
94
+ | **repository_version_added** | **String** | | [optional] |
95
+ | **repository_version_removed** | **String** | | [optional] |
96
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
97
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
98
+
99
+ ### Return type
100
+
101
+ [**PaginatedpythonPackageYankResponseList**](PaginatedpythonPackageYankResponseList.md)
102
+
103
+ ### Authorization
104
+
105
+ [basicAuth](../README.md#basicAuth)
106
+
107
+ ### HTTP request headers
108
+
109
+ - **Content-Type**: Not defined
110
+ - **Accept**: application/json
111
+
112
+
113
+ ## read
114
+
115
+ > <PythonPackageYankResponse> read(python_package_yank_href, opts)
116
+
117
+ Inspect a package yank
118
+
119
+ Read-only viewset for PackageYank content units (PEP 592). PackageYank markers indicate that a package version has been yanked in a repository. Use the /yank/ and /unyank/ PyPI endpoints to create or remove these markers.
120
+
121
+ ### Examples
122
+
123
+ ```ruby
124
+ require 'time'
125
+ require 'pulp_python_client'
126
+ # setup authorization
127
+ PulpPythonClient.configure do |config|
128
+ # Configure HTTP basic authorization: basicAuth
129
+ config.username = 'YOUR USERNAME'
130
+ config.password = 'YOUR PASSWORD'
131
+ end
132
+
133
+ api_instance = PulpPythonClient::ContentYanksApi.new
134
+ python_package_yank_href = 'python_package_yank_href_example' # String |
135
+ opts = {
136
+ x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
137
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
138
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
139
+ }
140
+
141
+ begin
142
+ # Inspect a package yank
143
+ result = api_instance.read(python_package_yank_href, opts)
144
+ p result
145
+ rescue PulpPythonClient::ApiError => e
146
+ puts "Error when calling ContentYanksApi->read: #{e}"
147
+ end
148
+ ```
149
+
150
+ #### Using the read_with_http_info variant
151
+
152
+ This returns an Array which contains the response data, status code and headers.
153
+
154
+ > <Array(<PythonPackageYankResponse>, Integer, Hash)> read_with_http_info(python_package_yank_href, opts)
155
+
156
+ ```ruby
157
+ begin
158
+ # Inspect a package yank
159
+ data, status_code, headers = api_instance.read_with_http_info(python_package_yank_href, opts)
160
+ p status_code # => 2xx
161
+ p headers # => { ... }
162
+ p data # => <PythonPackageYankResponse>
163
+ rescue PulpPythonClient::ApiError => e
164
+ puts "Error when calling ContentYanksApi->read_with_http_info: #{e}"
165
+ end
166
+ ```
167
+
168
+ ### Parameters
169
+
170
+ | Name | Type | Description | Notes |
171
+ | ---- | ---- | ----------- | ----- |
172
+ | **python_package_yank_href** | **String** | | |
173
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
174
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
175
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
176
+
177
+ ### Return type
178
+
179
+ [**PythonPackageYankResponse**](PythonPackageYankResponse.md)
180
+
181
+ ### Authorization
182
+
183
+ [basicAuth](../README.md#basicAuth)
184
+
185
+ ### HTTP request headers
186
+
187
+ - **Content-Type**: Not defined
188
+ - **Accept**: application/json
189
+
190
+
191
+ ## set_label
192
+
193
+ > <SetLabelResponse> set_label(python_package_yank_href, set_label, opts)
194
+
195
+ Set a label
196
+
197
+ Set a single pulp_label on the object to a specific value or null.
198
+
199
+ ### Examples
200
+
201
+ ```ruby
202
+ require 'time'
203
+ require 'pulp_python_client'
204
+ # setup authorization
205
+ PulpPythonClient.configure do |config|
206
+ # Configure HTTP basic authorization: basicAuth
207
+ config.username = 'YOUR USERNAME'
208
+ config.password = 'YOUR PASSWORD'
209
+ end
210
+
211
+ api_instance = PulpPythonClient::ContentYanksApi.new
212
+ python_package_yank_href = 'python_package_yank_href_example' # String |
213
+ set_label = PulpPythonClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
214
+ opts = {
215
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
216
+ }
217
+
218
+ begin
219
+ # Set a label
220
+ result = api_instance.set_label(python_package_yank_href, set_label, opts)
221
+ p result
222
+ rescue PulpPythonClient::ApiError => e
223
+ puts "Error when calling ContentYanksApi->set_label: #{e}"
224
+ end
225
+ ```
226
+
227
+ #### Using the set_label_with_http_info variant
228
+
229
+ This returns an Array which contains the response data, status code and headers.
230
+
231
+ > <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(python_package_yank_href, set_label, opts)
232
+
233
+ ```ruby
234
+ begin
235
+ # Set a label
236
+ data, status_code, headers = api_instance.set_label_with_http_info(python_package_yank_href, set_label, opts)
237
+ p status_code # => 2xx
238
+ p headers # => { ... }
239
+ p data # => <SetLabelResponse>
240
+ rescue PulpPythonClient::ApiError => e
241
+ puts "Error when calling ContentYanksApi->set_label_with_http_info: #{e}"
242
+ end
243
+ ```
244
+
245
+ ### Parameters
246
+
247
+ | Name | Type | Description | Notes |
248
+ | ---- | ---- | ----------- | ----- |
249
+ | **python_package_yank_href** | **String** | | |
250
+ | **set_label** | [**SetLabel**](SetLabel.md) | | |
251
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
252
+
253
+ ### Return type
254
+
255
+ [**SetLabelResponse**](SetLabelResponse.md)
256
+
257
+ ### Authorization
258
+
259
+ [basicAuth](../README.md#basicAuth)
260
+
261
+ ### HTTP request headers
262
+
263
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
264
+ - **Accept**: application/json
265
+
266
+
267
+ ## unset_label
268
+
269
+ > <UnsetLabelResponse> unset_label(python_package_yank_href, unset_label, opts)
270
+
271
+ Unset a label
272
+
273
+ Unset a single pulp_label on the object.
274
+
275
+ ### Examples
276
+
277
+ ```ruby
278
+ require 'time'
279
+ require 'pulp_python_client'
280
+ # setup authorization
281
+ PulpPythonClient.configure do |config|
282
+ # Configure HTTP basic authorization: basicAuth
283
+ config.username = 'YOUR USERNAME'
284
+ config.password = 'YOUR PASSWORD'
285
+ end
286
+
287
+ api_instance = PulpPythonClient::ContentYanksApi.new
288
+ python_package_yank_href = 'python_package_yank_href_example' # String |
289
+ unset_label = PulpPythonClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
290
+ opts = {
291
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
292
+ }
293
+
294
+ begin
295
+ # Unset a label
296
+ result = api_instance.unset_label(python_package_yank_href, unset_label, opts)
297
+ p result
298
+ rescue PulpPythonClient::ApiError => e
299
+ puts "Error when calling ContentYanksApi->unset_label: #{e}"
300
+ end
301
+ ```
302
+
303
+ #### Using the unset_label_with_http_info variant
304
+
305
+ This returns an Array which contains the response data, status code and headers.
306
+
307
+ > <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(python_package_yank_href, unset_label, opts)
308
+
309
+ ```ruby
310
+ begin
311
+ # Unset a label
312
+ data, status_code, headers = api_instance.unset_label_with_http_info(python_package_yank_href, unset_label, opts)
313
+ p status_code # => 2xx
314
+ p headers # => { ... }
315
+ p data # => <UnsetLabelResponse>
316
+ rescue PulpPythonClient::ApiError => e
317
+ puts "Error when calling ContentYanksApi->unset_label_with_http_info: #{e}"
318
+ end
319
+ ```
320
+
321
+ ### Parameters
322
+
323
+ | Name | Type | Description | Notes |
324
+ | ---- | ---- | ----------- | ----- |
325
+ | **python_package_yank_href** | **String** | | |
326
+ | **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
327
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
328
+
329
+ ### Return type
330
+
331
+ [**UnsetLabelResponse**](UnsetLabelResponse.md)
332
+
333
+ ### Authorization
334
+
335
+ [basicAuth](../README.md#basicAuth)
336
+
337
+ ### HTTP request headers
338
+
339
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
340
+ - **Accept**: application/json
341
+
@@ -0,0 +1,24 @@
1
+ # PulpPythonClient::PaginatedpythonPackageYankResponseList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **count** | **Integer** | | |
8
+ | **_next** | **String** | | [optional] |
9
+ | **previous** | **String** | | [optional] |
10
+ | **results** | [**Array&lt;PythonPackageYankResponse&gt;**](PythonPackageYankResponse.md) | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'pulp_python_client'
16
+
17
+ instance = PulpPythonClient::PaginatedpythonPackageYankResponseList.new(
18
+ count: 123,
19
+ _next: http://api.example.org/accounts/?offset&#x3D;400&amp;limit&#x3D;100,
20
+ previous: http://api.example.org/accounts/?offset&#x3D;200&amp;limit&#x3D;100,
21
+ results: null
22
+ )
23
+ ```
24
+
@@ -36,7 +36,7 @@ opts = {
36
36
  action: 'action_example', # String | Defaults to `file_upload`, don't change it or request will fail!
37
37
  protocol_version: PulpPythonClient::ProtocolVersionEnum::N1, # ProtocolVersionEnum | Protocol version to use for the upload. Only version 1 is supported. * `1` - 1
38
38
  filetype: PulpPythonClient::FiletypeEnum::BDIST_WHEEL, # FiletypeEnum | Type of artifact to upload. * `bdist_wheel` - bdist_wheel * `sdist` - sdist
39
- metadata_version: PulpPythonClient::MetadataVersionEnum::N1_0, # MetadataVersionEnum | Metadata version of the uploaded package. * `1.0` - 1.0 * `1.1` - 1.1 * `1.2` - 1.2 * `2.0` - 2.0 * `2.1` - 2.1 * `2.2` - 2.2 * `2.3` - 2.3 * `2.4` - 2.4
39
+ metadata_version: PulpPythonClient::MetadataVersionEnum::N1_0, # MetadataVersionEnum | Metadata version of the uploaded package. * `1.0` - 1.0 * `1.1` - 1.1 * `1.2` - 1.2 * `2.0` - 2.0 * `2.1` - 2.1 * `2.2` - 2.2 * `2.3` - 2.3 * `2.4` - 2.4 * `2.5` - 2.5
40
40
  attestations: TODO # Object |
41
41
  }
42
42
 
@@ -78,7 +78,7 @@ end
78
78
  | **action** | **String** | Defaults to &#x60;file_upload&#x60;, don&#39;t change it or request will fail! | [optional][default to &#39;file_upload&#39;] |
79
79
  | **protocol_version** | [**ProtocolVersionEnum**](ProtocolVersionEnum.md) | Protocol version to use for the upload. Only version 1 is supported. * &#x60;1&#x60; - 1 | [optional] |
80
80
  | **filetype** | [**FiletypeEnum**](FiletypeEnum.md) | Type of artifact to upload. * &#x60;bdist_wheel&#x60; - bdist_wheel * &#x60;sdist&#x60; - sdist | [optional] |
81
- | **metadata_version** | [**MetadataVersionEnum**](MetadataVersionEnum.md) | Metadata version of the uploaded package. * &#x60;1.0&#x60; - 1.0 * &#x60;1.1&#x60; - 1.1 * &#x60;1.2&#x60; - 1.2 * &#x60;2.0&#x60; - 2.0 * &#x60;2.1&#x60; - 2.1 * &#x60;2.2&#x60; - 2.2 * &#x60;2.3&#x60; - 2.3 * &#x60;2.4&#x60; - 2.4 | [optional] |
81
+ | **metadata_version** | [**MetadataVersionEnum**](MetadataVersionEnum.md) | Metadata version of the uploaded package. * &#x60;1.0&#x60; - 1.0 * &#x60;1.1&#x60; - 1.1 * &#x60;1.2&#x60; - 1.2 * &#x60;2.0&#x60; - 2.0 * &#x60;2.1&#x60; - 2.1 * &#x60;2.2&#x60; - 2.2 * &#x60;2.3&#x60; - 2.3 * &#x60;2.4&#x60; - 2.4 * &#x60;2.5&#x60; - 2.5 | [optional] |
82
82
  | **attestations** | [**Object**](Object.md) | | [optional] |
83
83
 
84
84
  ### Return type
@@ -38,7 +38,7 @@ opts = {
38
38
  action: 'action_example', # String | Defaults to `file_upload`, don't change it or request will fail!
39
39
  protocol_version: PulpPythonClient::ProtocolVersionEnum::N1, # ProtocolVersionEnum | Protocol version to use for the upload. Only version 1 is supported. * `1` - 1
40
40
  filetype: PulpPythonClient::FiletypeEnum::BDIST_WHEEL, # FiletypeEnum | Type of artifact to upload. * `bdist_wheel` - bdist_wheel * `sdist` - sdist
41
- metadata_version: PulpPythonClient::MetadataVersionEnum::N1_0, # MetadataVersionEnum | Metadata version of the uploaded package. * `1.0` - 1.0 * `1.1` - 1.1 * `1.2` - 1.2 * `2.0` - 2.0 * `2.1` - 2.1 * `2.2` - 2.2 * `2.3` - 2.3 * `2.4` - 2.4
41
+ metadata_version: PulpPythonClient::MetadataVersionEnum::N1_0, # MetadataVersionEnum | Metadata version of the uploaded package. * `1.0` - 1.0 * `1.1` - 1.1 * `1.2` - 1.2 * `2.0` - 2.0 * `2.1` - 2.1 * `2.2` - 2.2 * `2.3` - 2.3 * `2.4` - 2.4 * `2.5` - 2.5
42
42
  attestations: TODO # Object |
43
43
  }
44
44
 
@@ -80,7 +80,7 @@ end
80
80
  | **action** | **String** | Defaults to &#x60;file_upload&#x60;, don&#39;t change it or request will fail! | [optional][default to &#39;file_upload&#39;] |
81
81
  | **protocol_version** | [**ProtocolVersionEnum**](ProtocolVersionEnum.md) | Protocol version to use for the upload. Only version 1 is supported. * &#x60;1&#x60; - 1 | [optional] |
82
82
  | **filetype** | [**FiletypeEnum**](FiletypeEnum.md) | Type of artifact to upload. * &#x60;bdist_wheel&#x60; - bdist_wheel * &#x60;sdist&#x60; - sdist | [optional] |
83
- | **metadata_version** | [**MetadataVersionEnum**](MetadataVersionEnum.md) | Metadata version of the uploaded package. * &#x60;1.0&#x60; - 1.0 * &#x60;1.1&#x60; - 1.1 * &#x60;1.2&#x60; - 1.2 * &#x60;2.0&#x60; - 2.0 * &#x60;2.1&#x60; - 2.1 * &#x60;2.2&#x60; - 2.2 * &#x60;2.3&#x60; - 2.3 * &#x60;2.4&#x60; - 2.4 | [optional] |
83
+ | **metadata_version** | [**MetadataVersionEnum**](MetadataVersionEnum.md) | Metadata version of the uploaded package. * &#x60;1.0&#x60; - 1.0 * &#x60;1.1&#x60; - 1.1 * &#x60;1.2&#x60; - 1.2 * &#x60;2.0&#x60; - 2.0 * &#x60;2.1&#x60; - 2.1 * &#x60;2.2&#x60; - 2.2 * &#x60;2.3&#x60; - 2.3 * &#x60;2.4&#x60; - 2.4 * &#x60;2.5&#x60; - 2.5 | [optional] |
84
84
  | **attestations** | [**Object**](Object.md) | | [optional] |
85
85
 
86
86
  ### Return type
@@ -0,0 +1,84 @@
1
+ # PulpPythonClient::PypiUnyankApi
2
+
3
+ All URIs are relative to *http://localhost:24817*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**unyank**](PypiUnyankApi.md#unyank) | **POST** /pypi/{path}/unyank/ | Unyank a package version |
8
+
9
+
10
+ ## unyank
11
+
12
+ > <AsyncOperationResponse> unyank(path, yank, opts)
13
+
14
+ Unyank a package version
15
+
16
+ Unyank a package version, unmarking all its files with data-yanked.
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'pulp_python_client'
23
+ # setup authorization
24
+ PulpPythonClient.configure do |config|
25
+ # Configure HTTP basic authorization: basicAuth
26
+ config.username = 'YOUR USERNAME'
27
+ config.password = 'YOUR PASSWORD'
28
+ end
29
+
30
+ api_instance = PulpPythonClient::PypiUnyankApi.new
31
+ path = 'path_example' # String |
32
+ yank = PulpPythonClient::Yank.new({name: 'name_example', version: 'version_example'}) # Yank |
33
+ opts = {
34
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
35
+ }
36
+
37
+ begin
38
+ # Unyank a package version
39
+ result = api_instance.unyank(path, yank, opts)
40
+ p result
41
+ rescue PulpPythonClient::ApiError => e
42
+ puts "Error when calling PypiUnyankApi->unyank: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the unyank_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> unyank_with_http_info(path, yank, opts)
51
+
52
+ ```ruby
53
+ begin
54
+ # Unyank a package version
55
+ data, status_code, headers = api_instance.unyank_with_http_info(path, yank, opts)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <AsyncOperationResponse>
59
+ rescue PulpPythonClient::ApiError => e
60
+ puts "Error when calling PypiUnyankApi->unyank_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **path** | **String** | | |
69
+ | **yank** | [**Yank**](Yank.md) | | |
70
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
71
+
72
+ ### Return type
73
+
74
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
75
+
76
+ ### Authorization
77
+
78
+ [basicAuth](../README.md#basicAuth)
79
+
80
+ ### HTTP request headers
81
+
82
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
83
+ - **Accept**: application/json
84
+
@@ -0,0 +1,84 @@
1
+ # PulpPythonClient::PypiYankApi
2
+
3
+ All URIs are relative to *http://localhost:24817*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**yank**](PypiYankApi.md#yank) | **POST** /pypi/{path}/yank/ | Yank a package version |
8
+
9
+
10
+ ## yank
11
+
12
+ > <AsyncOperationResponse> yank(path, yank, opts)
13
+
14
+ Yank a package version
15
+
16
+ Yank a package version, marking all its files with data-yanked.
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'pulp_python_client'
23
+ # setup authorization
24
+ PulpPythonClient.configure do |config|
25
+ # Configure HTTP basic authorization: basicAuth
26
+ config.username = 'YOUR USERNAME'
27
+ config.password = 'YOUR PASSWORD'
28
+ end
29
+
30
+ api_instance = PulpPythonClient::PypiYankApi.new
31
+ path = 'path_example' # String |
32
+ yank = PulpPythonClient::Yank.new({name: 'name_example', version: 'version_example'}) # Yank |
33
+ opts = {
34
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
35
+ }
36
+
37
+ begin
38
+ # Yank a package version
39
+ result = api_instance.yank(path, yank, opts)
40
+ p result
41
+ rescue PulpPythonClient::ApiError => e
42
+ puts "Error when calling PypiYankApi->yank: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the yank_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> yank_with_http_info(path, yank, opts)
51
+
52
+ ```ruby
53
+ begin
54
+ # Yank a package version
55
+ data, status_code, headers = api_instance.yank_with_http_info(path, yank, opts)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <AsyncOperationResponse>
59
+ rescue PulpPythonClient::ApiError => e
60
+ puts "Error when calling PypiYankApi->yank_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **path** | **String** | | |
69
+ | **yank** | [**Yank**](Yank.md) | | |
70
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
71
+
72
+ ### Return type
73
+
74
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
75
+
76
+ ### Authorization
77
+
78
+ [basicAuth](../README.md#basicAuth)
79
+
80
+ ### HTTP request headers
81
+
82
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
83
+ - **Accept**: application/json
84
+