pulp_container_client 2.20.2 → 2.21.0

data/docs/DistributionsPullThroughApi.md

@@ -4,24 +4,24 @@ All URIs are relative to *http://localhost:24817*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**add_role**](DistributionsPullThroughApi.md#add_role) | **POST** {container_container_pull_through_distribution_href}add_role/ | Add a role
-[**create**](DistributionsPullThroughApi.md#create) | **POST** /pulp/api/v3/distributions/container/pull-through/ | Create a container pull through distribution
-[**delete**](DistributionsPullThroughApi.md#delete) | **DELETE** {container_container_pull_through_distribution_href} | Delete a container pull through distribution
-[**list**](DistributionsPullThroughApi.md#list) | **GET** /pulp/api/v3/distributions/container/pull-through/ | List container pull through distributions
-[**list_roles**](DistributionsPullThroughApi.md#list_roles) | **GET** {container_container_pull_through_distribution_href}list_roles/ | List roles
-[**my_permissions**](DistributionsPullThroughApi.md#my_permissions) | **GET** {container_container_pull_through_distribution_href}my_permissions/ | List user permissions
-[**partial_update**](DistributionsPullThroughApi.md#partial_update) | **PATCH** {container_container_pull_through_distribution_href} | Update a container pull through distribution
-[**read**](DistributionsPullThroughApi.md#read) | **GET** {container_container_pull_through_distribution_href} | Inspect a container pull through distribution
-[**remove_role**](DistributionsPullThroughApi.md#remove_role) | **POST** {container_container_pull_through_distribution_href}remove_role/ | Remove a role
-[**set_label**](DistributionsPullThroughApi.md#set_label) | **POST** {container_container_pull_through_distribution_href}set_label/ | Set a label
-[**unset_label**](DistributionsPullThroughApi.md#unset_label) | **POST** {container_container_pull_through_distribution_href}unset_label/ | Unset a label
-[**update**](DistributionsPullThroughApi.md#update) | **PUT** {container_container_pull_through_distribution_href} | Update a container pull through distribution
+[**distributions_container_pull_through_add_role**](DistributionsPullThroughApi.md#distributions_container_pull_through_add_role) | **POST** {container_container_pull_through_distribution_href}add_role/ | Add a role
+[**distributions_container_pull_through_create**](DistributionsPullThroughApi.md#distributions_container_pull_through_create) | **POST** /pulp/api/v3/distributions/container/pull-through/ | Create a container pull through distribution
+[**distributions_container_pull_through_delete**](DistributionsPullThroughApi.md#distributions_container_pull_through_delete) | **DELETE** {container_container_pull_through_distribution_href} | Delete a container pull through distribution
+[**distributions_container_pull_through_list**](DistributionsPullThroughApi.md#distributions_container_pull_through_list) | **GET** /pulp/api/v3/distributions/container/pull-through/ | List container pull through distributions
+[**distributions_container_pull_through_list_roles**](DistributionsPullThroughApi.md#distributions_container_pull_through_list_roles) | **GET** {container_container_pull_through_distribution_href}list_roles/ | List roles
+[**distributions_container_pull_through_my_permissions**](DistributionsPullThroughApi.md#distributions_container_pull_through_my_permissions) | **GET** {container_container_pull_through_distribution_href}my_permissions/ | List user permissions
+[**distributions_container_pull_through_partial_update**](DistributionsPullThroughApi.md#distributions_container_pull_through_partial_update) | **PATCH** {container_container_pull_through_distribution_href} | Update a container pull through distribution
+[**distributions_container_pull_through_read**](DistributionsPullThroughApi.md#distributions_container_pull_through_read) | **GET** {container_container_pull_through_distribution_href} | Inspect a container pull through distribution
+[**distributions_container_pull_through_remove_role**](DistributionsPullThroughApi.md#distributions_container_pull_through_remove_role) | **POST** {container_container_pull_through_distribution_href}remove_role/ | Remove a role
+[**distributions_container_pull_through_set_label**](DistributionsPullThroughApi.md#distributions_container_pull_through_set_label) | **POST** {container_container_pull_through_distribution_href}set_label/ | Set a label
+[**distributions_container_pull_through_unset_label**](DistributionsPullThroughApi.md#distributions_container_pull_through_unset_label) | **POST** {container_container_pull_through_distribution_href}unset_label/ | Unset a label
+[**distributions_container_pull_through_update**](DistributionsPullThroughApi.md#distributions_container_pull_through_update) | **PUT** {container_container_pull_through_distribution_href} | Update a container pull through distribution
 
 
 
-## add_role
+## distributions_container_pull_through_add_role
 
-> NestedRoleResponse add_role(container_container_pull_through_distribution_href, nested_role)
+> NestedRoleResponse distributions_container_pull_through_add_role(container_container_pull_through_distribution_href, nested_role)
 
 Add a role
 
@@ -45,10 +45,10 @@ nested_role = PulpContainerClient::NestedRole.new # NestedRole |
 
 begin
   #Add a role
-  result = api_instance.add_role(container_container_pull_through_distribution_href, nested_role)
+  result = api_instance.distributions_container_pull_through_add_role(container_container_pull_through_distribution_href, nested_role)
   p result
 rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling DistributionsPullThroughApi->add_role: #{e}"
+  puts "Exception when calling DistributionsPullThroughApi->distributions_container_pull_through_add_role: #{e}"
 end
 ```
 
@@ -74,9 +74,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## create
+## distributions_container_pull_through_create
 
-> AsyncOperationResponse create(container_container_pull_through_distribution)
+> AsyncOperationResponse distributions_container_pull_through_create(container_container_pull_through_distribution)
 
 Create a container pull through distribution
 
@@ -99,10 +99,10 @@ container_container_pull_through_distribution = PulpContainerClient::ContainerCo
 
 begin
   #Create a container pull through distribution
-  result = api_instance.create(container_container_pull_through_distribution)
+  result = api_instance.distributions_container_pull_through_create(container_container_pull_through_distribution)
   p result
 rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling DistributionsPullThroughApi->create: #{e}"
+  puts "Exception when calling DistributionsPullThroughApi->distributions_container_pull_through_create: #{e}"
 end
 ```
 
@@ -127,9 +127,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## delete
+## distributions_container_pull_through_delete
 
-> AsyncOperationResponse delete(container_container_pull_through_distribution_href)
+> AsyncOperationResponse distributions_container_pull_through_delete(container_container_pull_through_distribution_href)
 
 Delete a container pull through distribution
 
@@ -152,10 +152,10 @@ container_container_pull_through_distribution_href = 'container_container_pull_t
 
 begin
   #Delete a container pull through distribution
-  result = api_instance.delete(container_container_pull_through_distribution_href)
+  result = api_instance.distributions_container_pull_through_delete(container_container_pull_through_distribution_href)
   p result
 rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling DistributionsPullThroughApi->delete: #{e}"
+  puts "Exception when calling DistributionsPullThroughApi->distributions_container_pull_through_delete: #{e}"
 end
 ```
 
@@ -180,9 +180,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## list
+## distributions_container_pull_through_list
 
-> PaginatedcontainerContainerPullThroughDistributionResponseList list(opts)
+> PaginatedcontainerContainerPullThroughDistributionResponseList distributions_container_pull_through_list(opts)
 
 List container pull through distributions
 
@@ -231,10 +231,10 @@ opts = {
 
 begin
   #List container pull through distributions
-  result = api_instance.list(opts)
+  result = api_instance.distributions_container_pull_through_list(opts)
   p result
 rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling DistributionsPullThroughApi->list: #{e}"
+  puts "Exception when calling DistributionsPullThroughApi->distributions_container_pull_through_list: #{e}"
 end
 ```
 
@@ -283,9 +283,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## list_roles
+## distributions_container_pull_through_list_roles
 
-> ObjectRolesResponse list_roles(container_container_pull_through_distribution_href, opts)
+> ObjectRolesResponse distributions_container_pull_through_list_roles(container_container_pull_through_distribution_href, opts)
 
 List roles
 
@@ -312,10 +312,10 @@ opts = {
 
 begin
   #List roles
-  result = api_instance.list_roles(container_container_pull_through_distribution_href, opts)
+  result = api_instance.distributions_container_pull_through_list_roles(container_container_pull_through_distribution_href, opts)
   p result
 rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling DistributionsPullThroughApi->list_roles: #{e}"
+  puts "Exception when calling DistributionsPullThroughApi->distributions_container_pull_through_list_roles: #{e}"
 end
 ```
 
@@ -342,9 +342,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## my_permissions
+## distributions_container_pull_through_my_permissions
 
-> MyPermissionsResponse my_permissions(container_container_pull_through_distribution_href, opts)
+> MyPermissionsResponse distributions_container_pull_through_my_permissions(container_container_pull_through_distribution_href, opts)
 
 List user permissions
 
@@ -371,10 +371,10 @@ opts = {
 
 begin
   #List user permissions
-  result = api_instance.my_permissions(container_container_pull_through_distribution_href, opts)
+  result = api_instance.distributions_container_pull_through_my_permissions(container_container_pull_through_distribution_href, opts)
   p result
 rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling DistributionsPullThroughApi->my_permissions: #{e}"
+  puts "Exception when calling DistributionsPullThroughApi->distributions_container_pull_through_my_permissions: #{e}"
 end
 ```
 
@@ -401,9 +401,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## partial_update
+## distributions_container_pull_through_partial_update
 
-> AsyncOperationResponse partial_update(container_container_pull_through_distribution_href, patchedcontainer_container_pull_through_distribution)
+> AsyncOperationResponse distributions_container_pull_through_partial_update(container_container_pull_through_distribution_href, patchedcontainer_container_pull_through_distribution)
 
 Update a container pull through distribution
 
@@ -427,10 +427,10 @@ patchedcontainer_container_pull_through_distribution = PulpContainerClient::Patc
 
 begin
   #Update a container pull through distribution
-  result = api_instance.partial_update(container_container_pull_through_distribution_href, patchedcontainer_container_pull_through_distribution)
+  result = api_instance.distributions_container_pull_through_partial_update(container_container_pull_through_distribution_href, patchedcontainer_container_pull_through_distribution)
   p result
 rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling DistributionsPullThroughApi->partial_update: #{e}"
+  puts "Exception when calling DistributionsPullThroughApi->distributions_container_pull_through_partial_update: #{e}"
 end
 ```
 
@@ -456,9 +456,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## read
+## distributions_container_pull_through_read
 
-> ContainerContainerPullThroughDistributionResponse read(container_container_pull_through_distribution_href, opts)
+> ContainerContainerPullThroughDistributionResponse distributions_container_pull_through_read(container_container_pull_through_distribution_href, opts)
 
 Inspect a container pull through distribution
 
@@ -485,10 +485,10 @@ opts = {
 
 begin
   #Inspect a container pull through distribution
-  result = api_instance.read(container_container_pull_through_distribution_href, opts)
+  result = api_instance.distributions_container_pull_through_read(container_container_pull_through_distribution_href, opts)
   p result
 rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling DistributionsPullThroughApi->read: #{e}"
+  puts "Exception when calling DistributionsPullThroughApi->distributions_container_pull_through_read: #{e}"
 end
 ```
 
@@ -515,9 +515,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## remove_role
+## distributions_container_pull_through_remove_role
 
-> NestedRoleResponse remove_role(container_container_pull_through_distribution_href, nested_role)
+> NestedRoleResponse distributions_container_pull_through_remove_role(container_container_pull_through_distribution_href, nested_role)
 
 Remove a role
 
@@ -541,10 +541,10 @@ nested_role = PulpContainerClient::NestedRole.new # NestedRole |
 
 begin
   #Remove a role
-  result = api_instance.remove_role(container_container_pull_through_distribution_href, nested_role)
+  result = api_instance.distributions_container_pull_through_remove_role(container_container_pull_through_distribution_href, nested_role)
   p result
 rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling DistributionsPullThroughApi->remove_role: #{e}"
+  puts "Exception when calling DistributionsPullThroughApi->distributions_container_pull_through_remove_role: #{e}"
 end
 ```
 
@@ -570,9 +570,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## set_label
+## distributions_container_pull_through_set_label
 
-> SetLabelResponse set_label(container_container_pull_through_distribution_href, set_label)
+> SetLabelResponse distributions_container_pull_through_set_label(container_container_pull_through_distribution_href, set_label)
 
 Set a label
 
@@ -596,10 +596,10 @@ set_label = PulpContainerClient::SetLabel.new # SetLabel |
 
 begin
   #Set a label
-  result = api_instance.set_label(container_container_pull_through_distribution_href, set_label)
+  result = api_instance.distributions_container_pull_through_set_label(container_container_pull_through_distribution_href, set_label)
   p result
 rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling DistributionsPullThroughApi->set_label: #{e}"
+  puts "Exception when calling DistributionsPullThroughApi->distributions_container_pull_through_set_label: #{e}"
 end
 ```
 
@@ -625,9 +625,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## unset_label
+## distributions_container_pull_through_unset_label
 
-> UnsetLabelResponse unset_label(container_container_pull_through_distribution_href, unset_label)
+> UnsetLabelResponse distributions_container_pull_through_unset_label(container_container_pull_through_distribution_href, unset_label)
 
 Unset a label
 
@@ -651,10 +651,10 @@ unset_label = PulpContainerClient::UnsetLabel.new # UnsetLabel |
 
 begin
   #Unset a label
-  result = api_instance.unset_label(container_container_pull_through_distribution_href, unset_label)
+  result = api_instance.distributions_container_pull_through_unset_label(container_container_pull_through_distribution_href, unset_label)
   p result
 rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling DistributionsPullThroughApi->unset_label: #{e}"
+  puts "Exception when calling DistributionsPullThroughApi->distributions_container_pull_through_unset_label: #{e}"
 end
 ```
 
@@ -680,9 +680,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## update
+## distributions_container_pull_through_update
 
-> AsyncOperationResponse update(container_container_pull_through_distribution_href, container_container_pull_through_distribution)
+> AsyncOperationResponse distributions_container_pull_through_update(container_container_pull_through_distribution_href, container_container_pull_through_distribution)
 
 Update a container pull through distribution
 
@@ -706,10 +706,10 @@ container_container_pull_through_distribution = PulpContainerClient::ContainerCo
 
 begin
   #Update a container pull through distribution
-  result = api_instance.update(container_container_pull_through_distribution_href, container_container_pull_through_distribution)
+  result = api_instance.distributions_container_pull_through_update(container_container_pull_through_distribution_href, container_container_pull_through_distribution)
   p result
 rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling DistributionsPullThroughApi->update: #{e}"
+  puts "Exception when calling DistributionsPullThroughApi->distributions_container_pull_through_update: #{e}"
 end
 ```
 

data/docs/DocsApiJsonApi.md

@@ -0,0 +1,61 @@
+# PulpContainerClient::DocsApiJsonApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**docs_api_json_get**](DocsApiJsonApi.md#docs_api_json_get) | **GET** /pulp/api/v3/docs/api.json | 
+
+
+
+## docs_api_json_get
+
+> Object docs_api_json_get(opts)
+
+
+
+OpenApi3 schema for this API. Format can be selected via content negotiation.  - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+
+api_instance = PulpContainerClient::DocsApiJsonApi.new
+opts = {
+  lang: 'lang_example', # String | 
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.docs_api_json_get(opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling DocsApiJsonApi->docs_api_json_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **lang** | **String**|  | [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
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.oai.openapi+json, application/json
+

data/docs/DocsApiYamlApi.md

@@ -0,0 +1,61 @@
+# PulpContainerClient::DocsApiYamlApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**docs_api_yaml_get**](DocsApiYamlApi.md#docs_api_yaml_get) | **GET** /pulp/api/v3/docs/api.yaml | 
+
+
+
+## docs_api_yaml_get
+
+> Object docs_api_yaml_get(opts)
+
+
+
+OpenApi3 schema for this API. Format can be selected via content negotiation.  - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+
+api_instance = PulpContainerClient::DocsApiYamlApi.new
+opts = {
+  lang: 'lang_example', # String | 
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.docs_api_yaml_get(opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling DocsApiYamlApi->docs_api_yaml_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **lang** | **String**|  | [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
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.oai.openapi, application/yaml
+

data/docs/Domain.md

@@ -0,0 +1,27 @@
+# PulpContainerClient::Domain
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A name for this domain. | 
+**description** | **String** | An optional description. | [optional] 
+**storage_class** | [**StorageClassEnum**](StorageClassEnum.md) | Backend storage class for domain.  * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage | 
+**storage_settings** | [**Object**](.md) | Settings for storage class. | 
+**redirect_to_object_storage** | **Boolean** | Boolean to have the content app redirect to object storage. | [optional] [default to true]
+**hide_guarded_distributions** | **Boolean** | Boolean to hide distributions with a content guard in the content app. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::Domain.new(name: null,
+                                 description: null,
+                                 storage_class: null,
+                                 storage_settings: null,
+                                 redirect_to_object_storage: null,
+                                 hide_guarded_distributions: null)
+```
+
+

data/docs/DomainResponse.md

@@ -0,0 +1,33 @@
+# PulpContainerClient::DomainResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**pulp_last_updated** | **DateTime** | 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] 
+**name** | **String** | A name for this domain. | 
+**description** | **String** | An optional description. | [optional] 
+**storage_class** | [**StorageClassEnum**](StorageClassEnum.md) | Backend storage class for domain.  * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage | 
+**storage_settings** | [**Object**](.md) | Settings for storage class. | 
+**redirect_to_object_storage** | **Boolean** | Boolean to have the content app redirect to object storage. | [optional] [default to true]
+**hide_guarded_distributions** | **Boolean** | Boolean to hide distributions with a content guard in the content app. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::DomainResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 pulp_last_updated: null,
+                                 name: null,
+                                 description: null,
+                                 storage_class: null,
+                                 storage_settings: null,
+                                 redirect_to_object_storage: null,
+                                 hide_guarded_distributions: null)
+```
+
+