pulp_python_client 3.21.0 → 3.22.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 (47) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +17 -5
  3. data/docs/ContentPackagesApi.md +6 -2
  4. data/docs/ContentProvenanceApi.md +428 -0
  5. data/docs/FiletypeEnum.md +15 -0
  6. data/docs/MetadataVersionEnum.md +15 -0
  7. data/docs/PaginatedpythonPackageProvenanceResponseList.md +24 -0
  8. data/docs/PatchedpythonPythonRemote.md +3 -1
  9. data/docs/ProtocolVersionEnum.md +15 -0
  10. data/docs/PypiLegacyApi.md +9 -1
  11. data/docs/PypiProvenanceApi.md +91 -0
  12. data/docs/PypiSimpleApi.md +9 -1
  13. data/docs/PythonPackageProvenanceResponse.md +34 -0
  14. data/docs/PythonPythonPackageContentResponse.md +3 -1
  15. data/docs/PythonPythonRemote.md +3 -1
  16. data/docs/PythonPythonRemoteResponse.md +3 -1
  17. data/lib/pulp_python_client/api/content_packages_api.rb +6 -0
  18. data/lib/pulp_python_client/api/content_provenance_api.rb +448 -0
  19. data/lib/pulp_python_client/api/pypi_legacy_api.rb +12 -0
  20. data/lib/pulp_python_client/api/pypi_provenance_api.rb +110 -0
  21. data/lib/pulp_python_client/api/pypi_simple_api.rb +12 -0
  22. data/lib/pulp_python_client/models/filetype_enum.rb +40 -0
  23. data/lib/pulp_python_client/models/metadata_version_enum.rb +46 -0
  24. data/lib/pulp_python_client/models/paginatedpython_package_provenance_response_list.rb +257 -0
  25. data/lib/pulp_python_client/models/patchedpython_python_remote.rb +16 -4
  26. data/lib/pulp_python_client/models/protocol_version_enum.rb +39 -0
  27. data/lib/pulp_python_client/models/python_package_provenance_response.rb +302 -0
  28. data/lib/pulp_python_client/models/python_python_package_content_response.rb +15 -5
  29. data/lib/pulp_python_client/models/python_python_remote.rb +16 -4
  30. data/lib/pulp_python_client/models/python_python_remote_response.rb +16 -4
  31. data/lib/pulp_python_client/version.rb +1 -1
  32. data/lib/pulp_python_client.rb +7 -0
  33. data/spec/api/content_packages_api_spec.rb +2 -0
  34. data/spec/api/content_provenance_api_spec.rb +123 -0
  35. data/spec/api/pypi_legacy_api_spec.rb +4 -0
  36. data/spec/api/pypi_provenance_api_spec.rb +53 -0
  37. data/spec/api/pypi_simple_api_spec.rb +4 -0
  38. data/spec/models/filetype_enum_spec.rb +30 -0
  39. data/spec/models/metadata_version_enum_spec.rb +30 -0
  40. data/spec/models/paginatedpython_package_provenance_response_list_spec.rb +54 -0
  41. data/spec/models/patchedpython_python_remote_spec.rb +6 -0
  42. data/spec/models/protocol_version_enum_spec.rb +30 -0
  43. data/spec/models/python_package_provenance_response_spec.rb +84 -0
  44. data/spec/models/python_python_package_content_response_spec.rb +6 -0
  45. data/spec/models/python_python_remote_response_spec.rb +6 -0
  46. data/spec/models/python_python_remote_spec.rb +6 -0
  47. metadata +30 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bd2faff8fd16ad8cbdd6a3024965f9c9899a1af927f249696b1b090eb3d8680f
4
- data.tar.gz: ccf5460223c52ef36351a401086acea06b8d953ee93b50f60146c7eb11b4ba0f
3
+ metadata.gz: eaedb15c33a0adb96f4f9794c2bb392653cb13fe5a292d44ff153eb535a82ae3
4
+ data.tar.gz: 1a315d9b3a3d42071dfc1c854b8604bba7adbccc1c75bb027624c9a3d49dfb24
5
5
  SHA512:
6
- metadata.gz: 8918ba5a0d977d1a4bf03738a3fa6ff8c8f013bd3cf00935fda0de899f190bd56b9c9a42f49c0f0db02b9d08e178f4aed70f92c8f990755891aa5cc354aa302a
7
- data.tar.gz: 1e11c2f9a9a301f5b07e53877c4093c46385a0ae9766a212753770d52e9b7b4693defcee986f593c3a8f39e6032d21c6ae147c302a00b8cd8d0a2bf3d2b80344
6
+ metadata.gz: '0051969400b005329c29a4d5ac3b177cee4a11b53c33ed80aceb06bd5a5662cece827c1d5722fbeca72c8dc83e9fbf1a67829982f6d799d9c37b31ee4217cdc6'
7
+ data.tar.gz: 01636a659458d89567d60a73c11d9456b8c8bfad39d90fb160ac27092c01b50d9ac4f1884a9be4d8d0dc67a7f316ee98c08e3c84f54ccdef77bcb63e580a9955
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.21.0
10
+ - Package version: 3.22.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.21.0.gem
28
+ gem install ./pulp_python_client-3.22.0.gem
29
29
  ```
30
30
 
31
- (for development, run `gem install --dev ./pulp_python_client-3.21.0.gem` to install the development dependencies)
31
+ (for development, run `gem install --dev ./pulp_python_client-3.22.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.21.0'
37
+ gem 'pulp_python_client', '~> 3.22.0'
38
38
 
39
39
  ### Install from Git
40
40
 
@@ -103,7 +103,8 @@ opts = {
103
103
  license_expression: 'license_expression_example', # String | Text string that is a valid SPDX license expression.
104
104
  license_file: TODO, # Object |
105
105
  sha256: 'sha256_example', # String | The SHA256 digest of this package.
106
- metadata_sha256: 'metadata_sha256_example' # String | The SHA256 digest of the package's METADATA file.
106
+ metadata_sha256: 'metadata_sha256_example', # String | The SHA256 digest of the package's METADATA file.
107
+ attestations: TODO # Object |
107
108
  }
108
109
 
109
110
  begin
@@ -128,6 +129,11 @@ Class | Method | HTTP request | Description
128
129
  *PulpPythonClient::ContentPackagesApi* | [**set_label**](docs/ContentPackagesApi.md#set_label) | **POST** {python_python_package_content_href}set_label/ | Set a label
129
130
  *PulpPythonClient::ContentPackagesApi* | [**unset_label**](docs/ContentPackagesApi.md#unset_label) | **POST** {python_python_package_content_href}unset_label/ | Unset a label
130
131
  *PulpPythonClient::ContentPackagesApi* | [**upload**](docs/ContentPackagesApi.md#upload) | **POST** /pulp/api/v3/content/python/packages/upload/ | Synchronous Python package upload
132
+ *PulpPythonClient::ContentProvenanceApi* | [**create**](docs/ContentProvenanceApi.md#create) | **POST** /pulp/api/v3/content/python/provenance/ | Create a package provenance
133
+ *PulpPythonClient::ContentProvenanceApi* | [**list**](docs/ContentProvenanceApi.md#list) | **GET** /pulp/api/v3/content/python/provenance/ | List package provenances
134
+ *PulpPythonClient::ContentProvenanceApi* | [**read**](docs/ContentProvenanceApi.md#read) | **GET** {python_package_provenance_href} | Inspect a package provenance
135
+ *PulpPythonClient::ContentProvenanceApi* | [**set_label**](docs/ContentProvenanceApi.md#set_label) | **POST** {python_package_provenance_href}set_label/ | Set a label
136
+ *PulpPythonClient::ContentProvenanceApi* | [**unset_label**](docs/ContentProvenanceApi.md#unset_label) | **POST** {python_package_provenance_href}unset_label/ | Unset a label
131
137
  *PulpPythonClient::DistributionsPypiApi* | [**add_role**](docs/DistributionsPypiApi.md#add_role) | **POST** {python_python_distribution_href}add_role/ | Add a role
132
138
  *PulpPythonClient::DistributionsPypiApi* | [**create**](docs/DistributionsPypiApi.md#create) | **POST** /pulp/api/v3/distributions/python/pypi/ | Create a python distribution
133
139
  *PulpPythonClient::DistributionsPypiApi* | [**delete**](docs/DistributionsPypiApi.md#delete) | **DELETE** {python_python_distribution_href} | Delete a python distribution
@@ -151,6 +157,7 @@ Class | Method | HTTP request | Description
151
157
  *PulpPythonClient::PypiApi* | [**read**](docs/PypiApi.md#read) | **GET** /pypi/{path}/ | Get index summary
152
158
  *PulpPythonClient::PypiLegacyApi* | [**create**](docs/PypiLegacyApi.md#create) | **POST** /pypi/{path}/legacy/ | Upload a package
153
159
  *PulpPythonClient::PypiMetadataApi* | [**read**](docs/PypiMetadataApi.md#read) | **GET** /pypi/{path}/pypi/{meta}/ | Get package metadata
160
+ *PulpPythonClient::PypiProvenanceApi* | [**read**](docs/PypiProvenanceApi.md#read) | **GET** /pypi/{path}/integrity/{package}/{version}/{filename}/provenance/ | Get package provenance
154
161
  *PulpPythonClient::PypiSimpleApi* | [**create**](docs/PypiSimpleApi.md#create) | **POST** /pypi/{path}/simple/ | Upload a package
155
162
  *PulpPythonClient::PypiSimpleApi* | [**pypi_simple_package_read**](docs/PypiSimpleApi.md#pypi_simple_package_read) | **GET** /pypi/{path}/simple/{package}/ | Get package simple page
156
163
  *PulpPythonClient::PypiSimpleApi* | [**read**](docs/PypiSimpleApi.md#read) | **GET** /pypi/{path}/simple/ | Get index simple page
@@ -194,6 +201,8 @@ Class | Method | HTTP request | Description
194
201
  - [PulpPythonClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
195
202
  - [PulpPythonClient::ContentSummaryResponse](docs/ContentSummaryResponse.md)
196
203
  - [PulpPythonClient::ExcludePlatformsEnum](docs/ExcludePlatformsEnum.md)
204
+ - [PulpPythonClient::FiletypeEnum](docs/FiletypeEnum.md)
205
+ - [PulpPythonClient::MetadataVersionEnum](docs/MetadataVersionEnum.md)
197
206
  - [PulpPythonClient::MyPermissionsResponse](docs/MyPermissionsResponse.md)
198
207
  - [PulpPythonClient::NestedRole](docs/NestedRole.md)
199
208
  - [PulpPythonClient::NestedRoleResponse](docs/NestedRoleResponse.md)
@@ -202,6 +211,7 @@ Class | Method | HTTP request | Description
202
211
  - [PulpPythonClient::PackageTypesEnum](docs/PackageTypesEnum.md)
203
212
  - [PulpPythonClient::PackageUploadTaskResponse](docs/PackageUploadTaskResponse.md)
204
213
  - [PulpPythonClient::PaginatedRepositoryVersionResponseList](docs/PaginatedRepositoryVersionResponseList.md)
214
+ - [PulpPythonClient::PaginatedpythonPackageProvenanceResponseList](docs/PaginatedpythonPackageProvenanceResponseList.md)
205
215
  - [PulpPythonClient::PaginatedpythonPythonDistributionResponseList](docs/PaginatedpythonPythonDistributionResponseList.md)
206
216
  - [PulpPythonClient::PaginatedpythonPythonPackageContentResponseList](docs/PaginatedpythonPythonPackageContentResponseList.md)
207
217
  - [PulpPythonClient::PaginatedpythonPythonPublicationResponseList](docs/PaginatedpythonPythonPublicationResponseList.md)
@@ -211,6 +221,8 @@ Class | Method | HTTP request | Description
211
221
  - [PulpPythonClient::PatchedpythonPythonRemote](docs/PatchedpythonPythonRemote.md)
212
222
  - [PulpPythonClient::PatchedpythonPythonRepository](docs/PatchedpythonPythonRepository.md)
213
223
  - [PulpPythonClient::PolicyEnum](docs/PolicyEnum.md)
224
+ - [PulpPythonClient::ProtocolVersionEnum](docs/ProtocolVersionEnum.md)
225
+ - [PulpPythonClient::PythonPackageProvenanceResponse](docs/PythonPackageProvenanceResponse.md)
214
226
  - [PulpPythonClient::PythonPythonDistribution](docs/PythonPythonDistribution.md)
215
227
  - [PulpPythonClient::PythonPythonDistributionResponse](docs/PythonPythonDistributionResponse.md)
216
228
  - [PulpPythonClient::PythonPythonPackageContentResponse](docs/PythonPythonPackageContentResponse.md)
@@ -68,7 +68,8 @@ opts = {
68
68
  license_expression: 'license_expression_example', # String | Text string that is a valid SPDX license expression.
69
69
  license_file: TODO, # Object |
70
70
  sha256: 'sha256_example', # String | The SHA256 digest of this package.
71
- metadata_sha256: 'metadata_sha256_example' # String | The SHA256 digest of the package's METADATA file.
71
+ metadata_sha256: 'metadata_sha256_example', # String | The SHA256 digest of the package's METADATA file.
72
+ attestations: TODO # Object |
72
73
  }
73
74
 
74
75
  begin
@@ -137,6 +138,7 @@ end
137
138
  | **license_file** | [**Object**](Object.md) | | [optional] |
138
139
  | **sha256** | **String** | The SHA256 digest of this package. | [optional][default to ''] |
139
140
  | **metadata_sha256** | **String** | The SHA256 digest of the package's METADATA file. | [optional] |
141
+ | **attestations** | [**Object**](Object.md) | | [optional] |
140
142
 
141
143
  ### Return type
142
144
 
@@ -578,7 +580,8 @@ opts = {
578
580
  license_expression: 'license_expression_example', # String | Text string that is a valid SPDX license expression.
579
581
  license_file: TODO, # Object |
580
582
  sha256: 'sha256_example', # String | The SHA256 digest of this package.
581
- metadata_sha256: 'metadata_sha256_example' # String | The SHA256 digest of the package's METADATA file.
583
+ metadata_sha256: 'metadata_sha256_example', # String | The SHA256 digest of the package's METADATA file.
584
+ attestations: TODO # Object |
582
585
  }
583
586
 
584
587
  begin
@@ -645,6 +648,7 @@ end
645
648
  | **license_file** | [**Object**](Object.md) | | [optional] |
646
649
  | **sha256** | **String** | The SHA256 digest of this package. | [optional][default to ''] |
647
650
  | **metadata_sha256** | **String** | The SHA256 digest of the package's METADATA file. | [optional] |
651
+ | **attestations** | [**Object**](Object.md) | | [optional] |
648
652
 
649
653
  ### Return type
650
654
 
@@ -0,0 +1,428 @@
1
+ # PulpPythonClient::ContentProvenanceApi
2
+
3
+ All URIs are relative to *http://localhost:24817*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create**](ContentProvenanceApi.md#create) | **POST** /pulp/api/v3/content/python/provenance/ | Create a package provenance |
8
+ | [**list**](ContentProvenanceApi.md#list) | **GET** /pulp/api/v3/content/python/provenance/ | List package provenances |
9
+ | [**read**](ContentProvenanceApi.md#read) | **GET** {python_package_provenance_href} | Inspect a package provenance |
10
+ | [**set_label**](ContentProvenanceApi.md#set_label) | **POST** {python_package_provenance_href}set_label/ | Set a label |
11
+ | [**unset_label**](ContentProvenanceApi.md#unset_label) | **POST** {python_package_provenance_href}unset_label/ | Unset a label |
12
+
13
+
14
+ ## create
15
+
16
+ > <AsyncOperationResponse> create(package, opts)
17
+
18
+ Create a package provenance
19
+
20
+ Trigger an asynchronous task to create content,optionally create new repository version.
21
+
22
+ ### Examples
23
+
24
+ ```ruby
25
+ require 'time'
26
+ require 'pulp_python_client'
27
+ # setup authorization
28
+ PulpPythonClient.configure do |config|
29
+ # Configure HTTP basic authorization: basicAuth
30
+ config.username = 'YOUR USERNAME'
31
+ config.password = 'YOUR PASSWORD'
32
+ end
33
+
34
+ api_instance = PulpPythonClient::ContentProvenanceApi.new
35
+ package = 'package_example' # String | The package that the provenance is for.
36
+ opts = {
37
+ x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
38
+ repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
39
+ pulp_labels: { key: 'inner_example'}, # Hash<String, String> | A dictionary of arbitrary key/value pairs used to describe a specific Content instance.
40
+ file: File.new('/path/to/some/file'), # File | An uploaded file that may be turned into the content unit.
41
+ upload: 'upload_example', # String | An uncommitted upload that may be turned into the content unit.
42
+ file_url: 'file_url_example', # String | A url that Pulp can download and turn into the content unit.
43
+ verify: true # Boolean | Verify each attestation in the provenance.
44
+ }
45
+
46
+ begin
47
+ # Create a package provenance
48
+ result = api_instance.create(package, opts)
49
+ p result
50
+ rescue PulpPythonClient::ApiError => e
51
+ puts "Error when calling ContentProvenanceApi->create: #{e}"
52
+ end
53
+ ```
54
+
55
+ #### Using the create_with_http_info variant
56
+
57
+ This returns an Array which contains the response data, status code and headers.
58
+
59
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> create_with_http_info(package, opts)
60
+
61
+ ```ruby
62
+ begin
63
+ # Create a package provenance
64
+ data, status_code, headers = api_instance.create_with_http_info(package, opts)
65
+ p status_code # => 2xx
66
+ p headers # => { ... }
67
+ p data # => <AsyncOperationResponse>
68
+ rescue PulpPythonClient::ApiError => e
69
+ puts "Error when calling ContentProvenanceApi->create_with_http_info: #{e}"
70
+ end
71
+ ```
72
+
73
+ ### Parameters
74
+
75
+ | Name | Type | Description | Notes |
76
+ | ---- | ---- | ----------- | ----- |
77
+ | **package** | **String** | The package that the provenance is for. | |
78
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
79
+ | **repository** | **String** | A URI of a repository the new content unit should be associated with. | [optional] |
80
+ | **pulp_labels** | [**Hash&lt;String, String&gt;**](Hash.md) | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional] |
81
+ | **file** | **File** | An uploaded file that may be turned into the content unit. | [optional] |
82
+ | **upload** | **String** | An uncommitted upload that may be turned into the content unit. | [optional] |
83
+ | **file_url** | **String** | A url that Pulp can download and turn into the content unit. | [optional] |
84
+ | **verify** | **Boolean** | Verify each attestation in the provenance. | [optional][default to true] |
85
+
86
+ ### Return type
87
+
88
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
89
+
90
+ ### Authorization
91
+
92
+ [basicAuth](../README.md#basicAuth)
93
+
94
+ ### HTTP request headers
95
+
96
+ - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
97
+ - **Accept**: application/json
98
+
99
+
100
+ ## list
101
+
102
+ > <PaginatedpythonPackageProvenanceResponseList> list(opts)
103
+
104
+ List package provenances
105
+
106
+ PackageProvenance represents a PEP 740 provenance object for a Python package. Use ?minimal=true to get a human readable representation of the provenance.
107
+
108
+ ### Examples
109
+
110
+ ```ruby
111
+ require 'time'
112
+ require 'pulp_python_client'
113
+ # setup authorization
114
+ PulpPythonClient.configure do |config|
115
+ # Configure HTTP basic authorization: basicAuth
116
+ config.username = 'YOUR USERNAME'
117
+ config.password = 'YOUR PASSWORD'
118
+ end
119
+
120
+ api_instance = PulpPythonClient::ContentProvenanceApi.new
121
+ opts = {
122
+ x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
123
+ limit: 56, # Integer | Number of results to return per page.
124
+ offset: 56, # Integer | The initial index from which to return the results.
125
+ ordering: ['-pk'], # Array<String> | Ordering * `pk` - Pk * `-pk` - Pk (descending)
126
+ orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
127
+ prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
128
+ pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
129
+ pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
130
+ pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
131
+ q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
132
+ repository_version: 'repository_version_example', # String | Repository Version referenced by HREF/PRN
133
+ repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF/PRN
134
+ repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF/PRN
135
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
136
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
137
+ }
138
+
139
+ begin
140
+ # List package provenances
141
+ result = api_instance.list(opts)
142
+ p result
143
+ rescue PulpPythonClient::ApiError => e
144
+ puts "Error when calling ContentProvenanceApi->list: #{e}"
145
+ end
146
+ ```
147
+
148
+ #### Using the list_with_http_info variant
149
+
150
+ This returns an Array which contains the response data, status code and headers.
151
+
152
+ > <Array(<PaginatedpythonPackageProvenanceResponseList>, Integer, Hash)> list_with_http_info(opts)
153
+
154
+ ```ruby
155
+ begin
156
+ # List package provenances
157
+ data, status_code, headers = api_instance.list_with_http_info(opts)
158
+ p status_code # => 2xx
159
+ p headers # => { ... }
160
+ p data # => <PaginatedpythonPackageProvenanceResponseList>
161
+ rescue PulpPythonClient::ApiError => e
162
+ puts "Error when calling ContentProvenanceApi->list_with_http_info: #{e}"
163
+ end
164
+ ```
165
+
166
+ ### Parameters
167
+
168
+ | Name | Type | Description | Notes |
169
+ | ---- | ---- | ----------- | ----- |
170
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
171
+ | **limit** | **Integer** | Number of results to return per page. | [optional] |
172
+ | **offset** | **Integer** | The initial index from which to return the results. | [optional] |
173
+ | **ordering** | [**Array&lt;String&gt;**](String.md) | Ordering * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
174
+ | **orphaned_for** | **Float** | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] |
175
+ | **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
176
+ | **pulp_href__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
177
+ | **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
178
+ | **pulp_label_select** | **String** | Filter labels by search string | [optional] |
179
+ | **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
180
+ | **repository_version** | **String** | Repository Version referenced by HREF/PRN | [optional] |
181
+ | **repository_version_added** | **String** | Repository Version referenced by HREF/PRN | [optional] |
182
+ | **repository_version_removed** | **String** | Repository Version referenced by HREF/PRN | [optional] |
183
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
184
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
185
+
186
+ ### Return type
187
+
188
+ [**PaginatedpythonPackageProvenanceResponseList**](PaginatedpythonPackageProvenanceResponseList.md)
189
+
190
+ ### Authorization
191
+
192
+ [basicAuth](../README.md#basicAuth)
193
+
194
+ ### HTTP request headers
195
+
196
+ - **Content-Type**: Not defined
197
+ - **Accept**: application/json
198
+
199
+
200
+ ## read
201
+
202
+ > <PythonPackageProvenanceResponse> read(python_package_provenance_href, opts)
203
+
204
+ Inspect a package provenance
205
+
206
+ PackageProvenance represents a PEP 740 provenance object for a Python package. Use ?minimal=true to get a human readable representation of the provenance.
207
+
208
+ ### Examples
209
+
210
+ ```ruby
211
+ require 'time'
212
+ require 'pulp_python_client'
213
+ # setup authorization
214
+ PulpPythonClient.configure do |config|
215
+ # Configure HTTP basic authorization: basicAuth
216
+ config.username = 'YOUR USERNAME'
217
+ config.password = 'YOUR PASSWORD'
218
+ end
219
+
220
+ api_instance = PulpPythonClient::ContentProvenanceApi.new
221
+ python_package_provenance_href = 'python_package_provenance_href_example' # String |
222
+ opts = {
223
+ x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
224
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
225
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
226
+ }
227
+
228
+ begin
229
+ # Inspect a package provenance
230
+ result = api_instance.read(python_package_provenance_href, opts)
231
+ p result
232
+ rescue PulpPythonClient::ApiError => e
233
+ puts "Error when calling ContentProvenanceApi->read: #{e}"
234
+ end
235
+ ```
236
+
237
+ #### Using the read_with_http_info variant
238
+
239
+ This returns an Array which contains the response data, status code and headers.
240
+
241
+ > <Array(<PythonPackageProvenanceResponse>, Integer, Hash)> read_with_http_info(python_package_provenance_href, opts)
242
+
243
+ ```ruby
244
+ begin
245
+ # Inspect a package provenance
246
+ data, status_code, headers = api_instance.read_with_http_info(python_package_provenance_href, opts)
247
+ p status_code # => 2xx
248
+ p headers # => { ... }
249
+ p data # => <PythonPackageProvenanceResponse>
250
+ rescue PulpPythonClient::ApiError => e
251
+ puts "Error when calling ContentProvenanceApi->read_with_http_info: #{e}"
252
+ end
253
+ ```
254
+
255
+ ### Parameters
256
+
257
+ | Name | Type | Description | Notes |
258
+ | ---- | ---- | ----------- | ----- |
259
+ | **python_package_provenance_href** | **String** | | |
260
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
261
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
262
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
263
+
264
+ ### Return type
265
+
266
+ [**PythonPackageProvenanceResponse**](PythonPackageProvenanceResponse.md)
267
+
268
+ ### Authorization
269
+
270
+ [basicAuth](../README.md#basicAuth)
271
+
272
+ ### HTTP request headers
273
+
274
+ - **Content-Type**: Not defined
275
+ - **Accept**: application/json
276
+
277
+
278
+ ## set_label
279
+
280
+ > <SetLabelResponse> set_label(python_package_provenance_href, set_label, opts)
281
+
282
+ Set a label
283
+
284
+ Set a single pulp_label on the object to a specific value or null.
285
+
286
+ ### Examples
287
+
288
+ ```ruby
289
+ require 'time'
290
+ require 'pulp_python_client'
291
+ # setup authorization
292
+ PulpPythonClient.configure do |config|
293
+ # Configure HTTP basic authorization: basicAuth
294
+ config.username = 'YOUR USERNAME'
295
+ config.password = 'YOUR PASSWORD'
296
+ end
297
+
298
+ api_instance = PulpPythonClient::ContentProvenanceApi.new
299
+ python_package_provenance_href = 'python_package_provenance_href_example' # String |
300
+ set_label = PulpPythonClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
301
+ opts = {
302
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
303
+ }
304
+
305
+ begin
306
+ # Set a label
307
+ result = api_instance.set_label(python_package_provenance_href, set_label, opts)
308
+ p result
309
+ rescue PulpPythonClient::ApiError => e
310
+ puts "Error when calling ContentProvenanceApi->set_label: #{e}"
311
+ end
312
+ ```
313
+
314
+ #### Using the set_label_with_http_info variant
315
+
316
+ This returns an Array which contains the response data, status code and headers.
317
+
318
+ > <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(python_package_provenance_href, set_label, opts)
319
+
320
+ ```ruby
321
+ begin
322
+ # Set a label
323
+ data, status_code, headers = api_instance.set_label_with_http_info(python_package_provenance_href, set_label, opts)
324
+ p status_code # => 2xx
325
+ p headers # => { ... }
326
+ p data # => <SetLabelResponse>
327
+ rescue PulpPythonClient::ApiError => e
328
+ puts "Error when calling ContentProvenanceApi->set_label_with_http_info: #{e}"
329
+ end
330
+ ```
331
+
332
+ ### Parameters
333
+
334
+ | Name | Type | Description | Notes |
335
+ | ---- | ---- | ----------- | ----- |
336
+ | **python_package_provenance_href** | **String** | | |
337
+ | **set_label** | [**SetLabel**](SetLabel.md) | | |
338
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
339
+
340
+ ### Return type
341
+
342
+ [**SetLabelResponse**](SetLabelResponse.md)
343
+
344
+ ### Authorization
345
+
346
+ [basicAuth](../README.md#basicAuth)
347
+
348
+ ### HTTP request headers
349
+
350
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
351
+ - **Accept**: application/json
352
+
353
+
354
+ ## unset_label
355
+
356
+ > <UnsetLabelResponse> unset_label(python_package_provenance_href, unset_label, opts)
357
+
358
+ Unset a label
359
+
360
+ Unset a single pulp_label on the object.
361
+
362
+ ### Examples
363
+
364
+ ```ruby
365
+ require 'time'
366
+ require 'pulp_python_client'
367
+ # setup authorization
368
+ PulpPythonClient.configure do |config|
369
+ # Configure HTTP basic authorization: basicAuth
370
+ config.username = 'YOUR USERNAME'
371
+ config.password = 'YOUR PASSWORD'
372
+ end
373
+
374
+ api_instance = PulpPythonClient::ContentProvenanceApi.new
375
+ python_package_provenance_href = 'python_package_provenance_href_example' # String |
376
+ unset_label = PulpPythonClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
377
+ opts = {
378
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
379
+ }
380
+
381
+ begin
382
+ # Unset a label
383
+ result = api_instance.unset_label(python_package_provenance_href, unset_label, opts)
384
+ p result
385
+ rescue PulpPythonClient::ApiError => e
386
+ puts "Error when calling ContentProvenanceApi->unset_label: #{e}"
387
+ end
388
+ ```
389
+
390
+ #### Using the unset_label_with_http_info variant
391
+
392
+ This returns an Array which contains the response data, status code and headers.
393
+
394
+ > <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(python_package_provenance_href, unset_label, opts)
395
+
396
+ ```ruby
397
+ begin
398
+ # Unset a label
399
+ data, status_code, headers = api_instance.unset_label_with_http_info(python_package_provenance_href, unset_label, opts)
400
+ p status_code # => 2xx
401
+ p headers # => { ... }
402
+ p data # => <UnsetLabelResponse>
403
+ rescue PulpPythonClient::ApiError => e
404
+ puts "Error when calling ContentProvenanceApi->unset_label_with_http_info: #{e}"
405
+ end
406
+ ```
407
+
408
+ ### Parameters
409
+
410
+ | Name | Type | Description | Notes |
411
+ | ---- | ---- | ----------- | ----- |
412
+ | **python_package_provenance_href** | **String** | | |
413
+ | **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
414
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
415
+
416
+ ### Return type
417
+
418
+ [**UnsetLabelResponse**](UnsetLabelResponse.md)
419
+
420
+ ### Authorization
421
+
422
+ [basicAuth](../README.md#basicAuth)
423
+
424
+ ### HTTP request headers
425
+
426
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
427
+ - **Accept**: application/json
428
+
@@ -0,0 +1,15 @@
1
+ # PulpPythonClient::FiletypeEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'pulp_python_client'
12
+
13
+ instance = PulpPythonClient::FiletypeEnum.new()
14
+ ```
15
+
@@ -0,0 +1,15 @@
1
+ # PulpPythonClient::MetadataVersionEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'pulp_python_client'
12
+
13
+ instance = PulpPythonClient::MetadataVersionEnum.new()
14
+ ```
15
+
@@ -0,0 +1,24 @@
1
+ # PulpPythonClient::PaginatedpythonPackageProvenanceResponseList
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;PythonPackageProvenanceResponse&gt;**](PythonPackageProvenanceResponse.md) | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'pulp_python_client'
16
+
17
+ instance = PulpPythonClient::PaginatedpythonPackageProvenanceResponseList.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
+
@@ -31,6 +31,7 @@
31
31
  | **package_types** | [**Array&lt;PackageTypesEnum&gt;**](PackageTypesEnum.md) | The package types to sync for Python content. Leave blank to get everypackage type. | [optional] |
32
32
  | **keep_latest_packages** | **Integer** | The amount of latest versions of a package to keep on sync, includespre-releases if synced. Default 0 keeps all versions. | [optional][default to 0] |
33
33
  | **exclude_platforms** | [**Array&lt;ExcludePlatformsEnum&gt;**](ExcludePlatformsEnum.md) | List of platforms to exclude syncing Python packages for. Possible valuesinclude: windows, macos, freebsd, and linux. | [optional] |
34
+ | **provenance** | **Boolean** | Whether to sync available provenances for Python packages. | [optional][default to false] |
34
35
 
35
36
  ## Example
36
37
 
@@ -64,7 +65,8 @@ instance = PulpPythonClient::PatchedpythonPythonRemote.new(
64
65
  prereleases: null,
65
66
  package_types: null,
66
67
  keep_latest_packages: null,
67
- exclude_platforms: null
68
+ exclude_platforms: null,
69
+ provenance: null
68
70
  )
69
71
  ```
70
72
 
@@ -0,0 +1,15 @@
1
+ # PulpPythonClient::ProtocolVersionEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'pulp_python_client'
12
+
13
+ instance = PulpPythonClient::ProtocolVersionEnum.new()
14
+ ```
15
+
@@ -33,7 +33,11 @@ content = File.new('/path/to/some/file') # File | A Python package release file
33
33
  sha256_digest = 'sha256_digest_example' # String | SHA256 of package to validate upload integrity.
34
34
  opts = {
35
35
  x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
36
- action: 'action_example' # String | Defaults to `file_upload`, don't change it or request will fail!
36
+ action: 'action_example', # String | Defaults to `file_upload`, don't change it or request will fail!
37
+ protocol_version: PulpPythonClient::ProtocolVersionEnum::N1, # ProtocolVersionEnum | Protocol version to use for the upload. Only version 1 is supported. * `1` - 1
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
40
+ attestations: TODO # Object |
37
41
  }
38
42
 
39
43
  begin
@@ -72,6 +76,10 @@ end
72
76
  | **sha256_digest** | **String** | SHA256 of package to validate upload integrity. | |
73
77
  | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
74
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
+ | **protocol_version** | [**ProtocolVersionEnum**](ProtocolVersionEnum.md) | Protocol version to use for the upload. Only version 1 is supported. * &#x60;1&#x60; - 1 | [optional] |
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] |
82
+ | **attestations** | [**Object**](Object.md) | | [optional] |
75
83
 
76
84
  ### Return type
77
85