pulp_python_client 3.21.0 → 3.22.0

data/docs/PypiProvenanceApi.md

@@ -0,0 +1,91 @@
+# PulpPythonClient::PypiProvenanceApi
+
+All URIs are relative to *http://localhost:24817*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**read**](PypiProvenanceApi.md#read) | **GET** /pypi/{path}/integrity/{package}/{version}/{filename}/provenance/ | Get package provenance |
+
+
+## read
+
+> read(filename, package, path, version, opts)
+
+Get package provenance
+
+Gets the provenance for a package.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::PypiProvenanceApi.new
+filename = 'filename_example' # String | 
+package = 'package_example' # String | 
+path = 'path_example' # String | 
+version = 'version_example' # String | 
+opts = {
+  x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  # Get package provenance
+  api_instance.read(filename, package, path, version, opts)
+rescue PulpPythonClient::ApiError => e
+  puts "Error when calling PypiProvenanceApi->read: #{e}"
+end
+```
+
+#### Using the read_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> read_with_http_info(filename, package, path, version, opts)
+
+```ruby
+begin
+  # Get package provenance
+  data, status_code, headers = api_instance.read_with_http_info(filename, package, path, version, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PulpPythonClient::ApiError => e
+  puts "Error when calling PypiProvenanceApi->read_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filename** | **String** |  |  |
+| **package** | **String** |  |  |
+| **path** | **String** |  |  |
+| **version** | **String** |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
+| **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
+| **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/PypiSimpleApi.md

@@ -35,7 +35,11 @@ content = File.new('/path/to/some/file') # File | A Python package release file
 sha256_digest = 'sha256_digest_example' # String | SHA256 of package to validate upload integrity.
 opts = {
   x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
-  action: 'action_example' # String | Defaults to `file_upload`, don't change it or request will fail!
+  action: 'action_example', # String | Defaults to `file_upload`, don't change it or request will fail!
+  protocol_version: PulpPythonClient::ProtocolVersionEnum::N1, # ProtocolVersionEnum | Protocol version to use for the upload. Only version 1 is supported.  * `1` - 1
+  filetype: PulpPythonClient::FiletypeEnum::BDIST_WHEEL, # FiletypeEnum | Type of artifact to upload.  * `bdist_wheel` - bdist_wheel * `sdist` - sdist
+  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
+  attestations: TODO # Object | 
 }
 
 begin
@@ -74,6 +78,10 @@ end
 | **sha256_digest** | **String** | SHA256 of package to validate upload integrity. |  |
 | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
 | **action** | **String** | Defaults to &#x60;file_upload&#x60;, don&#39;t change it or request will fail! | [optional][default to &#39;file_upload&#39;] |
+| **protocol_version** | [**ProtocolVersionEnum**](ProtocolVersionEnum.md) | Protocol version to use for the upload. Only version 1 is supported.  * &#x60;1&#x60; - 1 | [optional] |
+| **filetype** | [**FiletypeEnum**](FiletypeEnum.md) | Type of artifact to upload.  * &#x60;bdist_wheel&#x60; - bdist_wheel * &#x60;sdist&#x60; - sdist | [optional] |
+| **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] |
+| **attestations** | [**Object**](Object.md) |  | [optional] |
 
 ### Return type
 

data/docs/PythonPackageProvenanceResponse.md

@@ -0,0 +1,34 @@
+# PulpPythonClient::PythonPackageProvenanceResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_href** | **String** |  | [optional][readonly] |
+| **prn** | **String** | The Pulp Resource Name (PRN). | [optional][readonly] |
+| **pulp_created** | **Time** | Timestamp of creation. | [optional][readonly] |
+| **pulp_last_updated** | **Time** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional][readonly] |
+| **pulp_labels** | **Hash<String, String>** | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional] |
+| **vuln_report** | **String** |  | [optional][readonly] |
+| **package** | **String** | The package that the provenance is for. |  |
+| **provenance** | **Object** |  | [optional] |
+| **sha256** | **String** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'pulp_python_client'
+
+instance = PulpPythonClient::PythonPackageProvenanceResponse.new(
+  pulp_href: null,
+  prn: null,
+  pulp_created: null,
+  pulp_last_updated: null,
+  pulp_labels: null,
+  vuln_report: null,
+  package: null,
+  provenance: null,
+  sha256: null
+)
+```
+

data/docs/PythonPythonPackageContentResponse.md

@@ -45,6 +45,7 @@
 | **size** | **Integer** | The size of the package in bytes. | [optional][readonly] |
 | **sha256** | **String** | The SHA256 digest of this package. | [optional][default to ''] |
 | **metadata_sha256** | **String** | The SHA256 digest of the package's METADATA file. | [optional] |
+| **provenance** | **String** | The created provenance object on upload. | [optional][readonly] |
 
 ## Example
 
@@ -92,7 +93,8 @@ instance = PulpPythonClient::PythonPythonPackageContentResponse.new(
   python_version: null,
   size: null,
   sha256: null,
-  metadata_sha256: null
+  metadata_sha256: null,
+  provenance: null
 )
 ```
 

data/docs/PythonPythonRemote.md

@@ -31,6 +31,7 @@
 | **package_types** | [**Array<PackageTypesEnum>**](PackageTypesEnum.md) | The package types to sync for Python content. Leave blank to get everypackage type. | [optional] |
 | **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] |
 | **exclude_platforms** | [**Array<ExcludePlatformsEnum>**](ExcludePlatformsEnum.md) | List of platforms to exclude syncing Python packages for. Possible valuesinclude: windows, macos, freebsd, and linux. | [optional] |
+| **provenance** | **Boolean** | Whether to sync available provenances for Python packages. | [optional][default to false] |
 
 ## Example
 
@@ -64,7 +65,8 @@ instance = PulpPythonClient::PythonPythonRemote.new(
   prereleases: null,
   package_types: null,
   keep_latest_packages: null,
-  exclude_platforms: null
+  exclude_platforms: null,
+  provenance: null
 )
 ```
 

data/docs/PythonPythonRemoteResponse.md

@@ -31,6 +31,7 @@
 | **package_types** | [**Array<PackageTypesEnum>**](PackageTypesEnum.md) | The package types to sync for Python content. Leave blank to get everypackage type. | [optional] |
 | **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] |
 | **exclude_platforms** | [**Array<ExcludePlatformsEnum>**](ExcludePlatformsEnum.md) | List of platforms to exclude syncing Python packages for. Possible valuesinclude: windows, macos, freebsd, and linux. | [optional] |
+| **provenance** | **Boolean** | Whether to sync available provenances for Python packages. | [optional][default to false] |
 
 ## Example
 
@@ -64,7 +65,8 @@ instance = PulpPythonClient::PythonPythonRemoteResponse.new(
   prereleases: null,
   package_types: null,
   keep_latest_packages: null,
-  exclude_platforms: null
+  exclude_platforms: null,
+  provenance: null
 )
 ```
 

data/lib/pulp_python_client/api/content_packages_api.rb

@@ -57,6 +57,7 @@ module PulpPythonClient
     # @option opts [Object] :license_file 
     # @option opts [String] :sha256 The SHA256 digest of this package. (default to '')
     # @option opts [String] :metadata_sha256 The SHA256 digest of the package's METADATA file.
+    # @option opts [Object] :attestations 
     # @return [AsyncOperationResponse]
     def create(relative_path, opts = {})
       data, _status_code, _headers = create_with_http_info(relative_path, opts)
@@ -101,6 +102,7 @@ module PulpPythonClient
     # @option opts [Object] :license_file 
     # @option opts [String] :sha256 The SHA256 digest of this package. (default to '')
     # @option opts [String] :metadata_sha256 The SHA256 digest of the package's METADATA file.
+    # @option opts [Object] :attestations 
     # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
     def create_with_http_info(relative_path, opts = {})
       if @api_client.config.debugging
@@ -179,6 +181,7 @@ module PulpPythonClient
       form_params['license_file'] = opts[:'license_file'] if !opts[:'license_file'].nil?
       form_params['sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil?
       form_params['metadata_sha256'] = opts[:'metadata_sha256'] if !opts[:'metadata_sha256'].nil?
+      form_params['attestations'] = opts[:'attestations'] if !opts[:'attestations'].nil?
 
       # http body (model)
       post_body = opts[:debug_body]
@@ -641,6 +644,7 @@ module PulpPythonClient
     # @option opts [Object] :license_file 
     # @option opts [String] :sha256 The SHA256 digest of this package. (default to '')
     # @option opts [String] :metadata_sha256 The SHA256 digest of the package&#39;s METADATA file.
+    # @option opts [Object] :attestations 
     # @return [PythonPythonPackageContentResponse]
     def upload(opts = {})
       data, _status_code, _headers = upload_with_http_info(opts)
@@ -683,6 +687,7 @@ module PulpPythonClient
     # @option opts [Object] :license_file 
     # @option opts [String] :sha256 The SHA256 digest of this package. (default to '')
     # @option opts [String] :metadata_sha256 The SHA256 digest of the package&#39;s METADATA file.
+    # @option opts [Object] :attestations 
     # @return [Array<(PythonPythonPackageContentResponse, Integer, Hash)>] PythonPythonPackageContentResponse data, response status code and response headers
     def upload_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -751,6 +756,7 @@ module PulpPythonClient
       form_params['license_file'] = opts[:'license_file'] if !opts[:'license_file'].nil?
       form_params['sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil?
       form_params['metadata_sha256'] = opts[:'metadata_sha256'] if !opts[:'metadata_sha256'].nil?
+      form_params['attestations'] = opts[:'attestations'] if !opts[:'attestations'].nil?
 
       # http body (model)
       post_body = opts[:debug_body]