pulp_container_client 2.10.13 → 2.11.0

data/docs/ContentSignaturesApi.md

@@ -0,0 +1,158 @@
+# PulpContainerClient::ContentSignaturesApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](ContentSignaturesApi.md#list) | **GET** /pulp/api/v3/content/container/signatures/ | List manifest signatures
+[**read**](ContentSignaturesApi.md#read) | **GET** {container_manifest_signature_href} | Inspect a manifest signature
+
+
+
+## list
+
+> PaginatedcontainerManifestSignatureResponseList list(opts)
+
+List manifest signatures
+
+ViewSet for image signatures.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ContentSignaturesApi.new
+opts = {
+  digest: 'digest_example', # String | Filter results where digest matches value
+  digest__in: ['digest__in_example'], # Array<String> | Filter results where digest is in a comma-separated list of values
+  key_id: 'key_id_example', # String | Filter results where key_id matches value
+  key_id__in: ['key_id__in_example'], # Array<String> | Filter results where key_id is in a comma-separated list of values
+  limit: 56, # Integer | Number of results to return per page.
+  manifest: ['manifest_example'], # Array<String> | Multiple values may be separated by commas.
+  name: 'name_example', # String | Filter results where name matches value
+  name__contains: 'name__contains_example', # String | Filter results where name contains value
+  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
+  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
+  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
+  repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
+  repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #List manifest signatures
+  result = api_instance.list(opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ContentSignaturesApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **digest** | **String**| Filter results where digest matches value | [optional] 
+ **digest__in** | [**Array&lt;String&gt;**](String.md)| Filter results where digest is in a comma-separated list of values | [optional] 
+ **key_id** | **String**| Filter results where key_id matches value | [optional] 
+ **key_id__in** | [**Array&lt;String&gt;**](String.md)| Filter results where key_id is in a comma-separated list of values | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **manifest** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
+ **name** | **String**| Filter results where name matches value | [optional] 
+ **name__contains** | **String**| Filter results where name contains value | [optional] 
+ **name__icontains** | **String**| Filter results where name contains value | [optional] 
+ **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional] 
+ **name__startswith** | **String**| Filter results where name starts with value | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **repository_version** | **String**| Repository Version referenced by HREF | [optional] 
+ **repository_version_added** | **String**| Repository Version referenced by HREF | [optional] 
+ **repository_version_removed** | **String**| Repository Version referenced by HREF | [optional] 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**PaginatedcontainerManifestSignatureResponseList**](PaginatedcontainerManifestSignatureResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> ContainerManifestSignatureResponse read(container_manifest_signature_href, opts)
+
+Inspect a manifest signature
+
+ViewSet for image signatures.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ContentSignaturesApi.new
+container_manifest_signature_href = 'container_manifest_signature_href_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #Inspect a manifest signature
+  result = api_instance.read(container_manifest_signature_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ContentSignaturesApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **container_manifest_signature_href** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**ContainerManifestSignatureResponse**](ContainerManifestSignatureResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ContentSummary.md

@@ -0,0 +1,21 @@
+# PulpContainerClient::ContentSummary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**added** | **Hash<String, Object>** |  | 
+**removed** | **Hash<String, Object>** |  | 
+**present** | **Hash<String, Object>** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::ContentSummary.new(added: null,
+                                 removed: null,
+                                 present: null)
+```
+
+

data/docs/DistributionsContainerApi.md

@@ -4,15 +4,73 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**add_role**](DistributionsContainerApi.md#add_role) | **POST** {container_container_distribution_href}add_role/ | 
 [**create**](DistributionsContainerApi.md#create) | **POST** /pulp/api/v3/distributions/container/container/ | Create a container distribution
 [**delete**](DistributionsContainerApi.md#delete) | **DELETE** {container_container_distribution_href} | Delete a container distribution
 [**list**](DistributionsContainerApi.md#list) | **GET** /pulp/api/v3/distributions/container/container/ | List container distributions
+[**list_roles**](DistributionsContainerApi.md#list_roles) | **GET** {container_container_distribution_href}list_roles/ | 
+[**my_permissions**](DistributionsContainerApi.md#my_permissions) | **GET** {container_container_distribution_href}my_permissions/ | 
 [**partial_update**](DistributionsContainerApi.md#partial_update) | **PATCH** {container_container_distribution_href} | Update a container distribution
 [**read**](DistributionsContainerApi.md#read) | **GET** {container_container_distribution_href} | Inspect a container distribution
+[**remove_role**](DistributionsContainerApi.md#remove_role) | **POST** {container_container_distribution_href}remove_role/ | 
 [**update**](DistributionsContainerApi.md#update) | **PUT** {container_container_distribution_href} | Update a container distribution
 
 
 
+## add_role
+
+> NestedRoleResponse add_role(container_container_distribution_href, nested_role)
+
+
+
+Add a role for this object to users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::DistributionsContainerApi.new
+container_container_distribution_href = 'container_container_distribution_href_example' # String | 
+nested_role = PulpContainerClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.add_role(container_container_distribution_href, nested_role)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling DistributionsContainerApi->add_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **container_container_distribution_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## create
 
 > AsyncOperationResponse create(container_container_distribution)
@@ -204,6 +262,122 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## list_roles
+
+> ObjectRolesResponse list_roles(container_container_distribution_href, opts)
+
+
+
+List roles assigned to this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::DistributionsContainerApi.new
+container_container_distribution_href = 'container_container_distribution_href_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.list_roles(container_container_distribution_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling DistributionsContainerApi->list_roles: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **container_container_distribution_href** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**ObjectRolesResponse**](ObjectRolesResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## my_permissions
+
+> MyPermissionsResponse my_permissions(container_container_distribution_href, opts)
+
+
+
+List permissions available to the current user on this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::DistributionsContainerApi.new
+container_container_distribution_href = 'container_container_distribution_href_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.my_permissions(container_container_distribution_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling DistributionsContainerApi->my_permissions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **container_container_distribution_href** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**MyPermissionsResponse**](MyPermissionsResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## partial_update
 
 > AsyncOperationResponse partial_update(container_container_distribution_href, patchedcontainer_container_distribution)
@@ -318,6 +492,60 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## remove_role
+
+> NestedRoleResponse remove_role(container_container_distribution_href, nested_role)
+
+
+
+Remove a role for this object from users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::DistributionsContainerApi.new
+container_container_distribution_href = 'container_container_distribution_href_example' # String | 
+nested_role = PulpContainerClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.remove_role(container_container_distribution_href, nested_role)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling DistributionsContainerApi->remove_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **container_container_distribution_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## update
 
 > AsyncOperationResponse update(container_container_distribution_href, container_container_distribution)

data/docs/MyPermissionsResponse.md

@@ -0,0 +1,17 @@
+# PulpContainerClient::MyPermissionsResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**permissions** | **Array<String>** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::MyPermissionsResponse.new(permissions: null)
+```
+
+

data/docs/NestedRole.md

@@ -0,0 +1,21 @@
+# PulpContainerClient::NestedRole
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**users** | **Array<String>** |  | [optional] 
+**groups** | **Array<String>** |  | [optional] 
+**role** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::NestedRole.new(users: null,
+                                 groups: null,
+                                 role: null)
+```
+
+

data/docs/NestedRoleResponse.md

@@ -0,0 +1,21 @@
+# PulpContainerClient::NestedRoleResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**users** | **Array<String>** |  | [optional] 
+**groups** | **Array<String>** |  | [optional] 
+**role** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::NestedRoleResponse.new(users: null,
+                                 groups: null,
+                                 role: null)
+```
+
+

data/docs/ObjectRolesResponse.md

@@ -0,0 +1,17 @@
+# PulpContainerClient::ObjectRolesResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**roles** | [**Array<NestedRoleResponse>**](NestedRoleResponse.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::ObjectRolesResponse.new(roles: null)
+```
+
+

data/docs/{PaginatedcontainerContentRedirectContentGuardResponseList.md → PaginatedcontainerManifestSignatureResponseList.md}

@@ -1,4 +1,4 @@
-# PulpContainerClient::PaginatedcontainerContentRedirectContentGuardResponseList
+# PulpContainerClient::PaginatedcontainerManifestSignatureResponseList
 
 ## Properties
 
@@ -7,14 +7,14 @@ Name | Type | Description | Notes
 **count** | **Integer** |  | [optional] 
 **_next** | **String** |  | [optional] 
 **previous** | **String** |  | [optional] 
-**results** | [**Array<ContainerContentRedirectContentGuardResponse>**](ContainerContentRedirectContentGuardResponse.md) |  | [optional] 
+**results** | [**Array<ContainerManifestSignatureResponse>**](ContainerManifestSignatureResponse.md) |  | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'PulpContainerClient'
 
-instance = PulpContainerClient::PaginatedcontainerContentRedirectContentGuardResponseList.new(count: 123,
+instance = PulpContainerClient::PaginatedcontainerManifestSignatureResponseList.new(count: 123,
                                  _next: http://api.example.org/accounts/?offset=400&limit=100,
                                  previous: http://api.example.org/accounts/?offset=200&limit=100,
                                  results: null)

data/docs/PatchedcontainerContainerDistribution.md

@@ -4,11 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | [optional] 
-**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | [optional] 
 **content_guard** | **String** | An optional content-guard. If none is specified, a default one will be used. | [optional] 
 **pulp_labels** | [**Object**](.md) |  | [optional] 
+**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | [optional] 
 **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] 
+**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | [optional] 
 **repository_version** | **String** | RepositoryVersion to be served | [optional] 
 **private** | **Boolean** | Restrict pull access to explicitly authorized users. Defaults to unrestricted pull access. | [optional] 
 **description** | **String** | An optional description. | [optional] 
@@ -18,11 +18,11 @@ Name | Type | Description | Notes
 ```ruby
 require 'PulpContainerClient'
 
-instance = PulpContainerClient::PatchedcontainerContainerDistribution.new(name: null,
-                                 base_path: null,
-                                 content_guard: null,
+instance = PulpContainerClient::PatchedcontainerContainerDistribution.new(content_guard: null,
                                  pulp_labels: null,
+                                 name: null,
                                  repository: null,
+                                 base_path: null,
                                  repository_version: null,
                                  private: null,
                                  description: null)

data/docs/PatchedcontainerContainerPushRepository.md

@@ -4,20 +4,22 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**manifest_signing_service** | **String** | A reference to an associated signing service. | [optional] 
+**pulp_labels** | [**Object**](.md) |  | [optional] 
 **name** | **String** | A unique name for this repository. | [optional] 
-**description** | **String** | An optional description. | [optional] 
 **retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. This is provided as a tech preview in Pulp 3 and may change in the future. | [optional] 
-**pulp_labels** | [**Object**](.md) |  | [optional] 
+**description** | **String** | An optional description. | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'PulpContainerClient'
 
-instance = PulpContainerClient::PatchedcontainerContainerPushRepository.new(name: null,
-                                 description: null,
+instance = PulpContainerClient::PatchedcontainerContainerPushRepository.new(manifest_signing_service: null,
+                                 pulp_labels: null,
+                                 name: null,
                                  retain_repo_versions: null,
-                                 pulp_labels: null)
+                                 description: null)
 ```
 
 

data/docs/PatchedcontainerContainerRemote.md

@@ -28,6 +28,7 @@ Name | Type | Description | Notes
 **upstream_name** | **String** | Name of the upstream repository | [optional] 
 **include_tags** | **Array<String>** |              A list of tags to include during sync.             Wildcards *, ? are recognized.             'include_tags' is evaluated before 'exclude_tags'.              | [optional] 
 **exclude_tags** | **Array<String>** |              A list of tags to exclude during sync.             Wildcards *, ? are recognized.             'exclude_tags' is evaluated after 'include_tags'.              | [optional] 
+**sigstore** | **String** | A URL to a sigstore to download image signatures from | [optional] 
 
 ## Code Sample
 
@@ -57,7 +58,8 @@ instance = PulpContainerClient::PatchedcontainerContainerRemote.new(name: null,
                                  rate_limit: null,
                                  upstream_name: null,
                                  include_tags: null,
-                                 exclude_tags: null)
+                                 exclude_tags: null,
+                                 sigstore: null)
 ```
 
 

data/docs/PatchedcontainerContainerRepository.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **description** | **String** | An optional description. | [optional] 
 **retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. This is provided as a tech preview in Pulp 3 and may change in the future. | [optional] 
 **remote** | **String** | An optional remote to use by default when syncing. | [optional] 
+**manifest_signing_service** | **String** | A reference to an associated signing service. | [optional] 
 
 ## Code Sample
 
@@ -19,7 +20,8 @@ instance = PulpContainerClient::PatchedcontainerContainerRepository.new(pulp_lab
                                  name: null,
                                  description: null,
                                  retain_repo_versions: null,
-                                 remote: null)
+                                 remote: null,
+                                 manifest_signing_service: null)
 ```