pulp_container_client 2.14.16 → 2.15.0

data/docs/ArtifactsApi.md

@@ -1,269 +0,0 @@
-# PulpContainerClient::ArtifactsApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**artifacts_create**](ArtifactsApi.md#artifacts_create) | **POST** /pulp/api/v3/artifacts/ | Create an artifact
-[**artifacts_delete**](ArtifactsApi.md#artifacts_delete) | **DELETE** {artifact_href} | Delete an artifact
-[**artifacts_list**](ArtifactsApi.md#artifacts_list) | **GET** /pulp/api/v3/artifacts/ | List artifacts
-[**artifacts_read**](ArtifactsApi.md#artifacts_read) | **GET** {artifact_href} | Inspect an artifact
-
-
-
-## artifacts_create
-
-> ArtifactResponse artifacts_create(file, opts)
-
-Create an artifact
-
-A customized named ModelViewSet that knows how to register itself with the Pulp API router.  This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method.  Attributes:     lookup_field (str): The name of the field by which an object should be looked up, in         addition to any parent lookups if this ViewSet is nested. Defaults to 'pk'     endpoint_name (str): The name of the final path segment that should identify the ViewSet's         collection endpoint.     nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must         correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin.         None indicates this ViewSet should not be nested.     parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs         to django model filter expressions that can be used with the corresponding value from         self.kwargs, used only by a nested ViewSet to filter based on the parent object's         identity.     schema (DefaultSchema): The schema class to use by default in a viewset.
-
-### 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::ArtifactsApi.new
-file = File.new('/path/to/file') # File | The stored file.
-opts = {
-  size: 56, # Integer | The size of the file in bytes.
-  md5: 'md5_example', # String | The MD5 checksum of the file if available.
-  sha1: 'sha1_example', # String | The SHA-1 checksum of the file if available.
-  sha224: 'sha224_example', # String | The SHA-224 checksum of the file if available.
-  sha256: 'sha256_example', # String | The SHA-256 checksum of the file if available.
-  sha384: 'sha384_example', # String | The SHA-384 checksum of the file if available.
-  sha512: 'sha512_example' # String | The SHA-512 checksum of the file if available.
-}
-
-begin
-  #Create an artifact
-  result = api_instance.artifacts_create(file, opts)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling ArtifactsApi->artifacts_create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **file** | **File**| The stored file. | 
- **size** | **Integer**| The size of the file in bytes. | [optional] 
- **md5** | **String**| The MD5 checksum of the file if available. | [optional] 
- **sha1** | **String**| The SHA-1 checksum of the file if available. | [optional] 
- **sha224** | **String**| The SHA-224 checksum of the file if available. | [optional] 
- **sha256** | **String**| The SHA-256 checksum of the file if available. | [optional] 
- **sha384** | **String**| The SHA-384 checksum of the file if available. | [optional] 
- **sha512** | **String**| The SHA-512 checksum of the file if available. | [optional] 
-
-### Return type
-
-[**ArtifactResponse**](ArtifactResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
-- **Accept**: application/json
-
-
-## artifacts_delete
-
-> artifacts_delete(artifact_href)
-
-Delete an artifact
-
-Remove Artifact only if it is not associated with any Content.
-
-### 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::ArtifactsApi.new
-artifact_href = 'artifact_href_example' # String | 
-
-begin
-  #Delete an artifact
-  api_instance.artifacts_delete(artifact_href)
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling ArtifactsApi->artifacts_delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **artifact_href** | **String**|  | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## artifacts_list
-
-> PaginatedArtifactResponseList artifacts_list(opts)
-
-List artifacts
-
-A customized named ModelViewSet that knows how to register itself with the Pulp API router.  This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method.  Attributes:     lookup_field (str): The name of the field by which an object should be looked up, in         addition to any parent lookups if this ViewSet is nested. Defaults to 'pk'     endpoint_name (str): The name of the final path segment that should identify the ViewSet's         collection endpoint.     nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must         correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin.         None indicates this ViewSet should not be nested.     parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs         to django model filter expressions that can be used with the corresponding value from         self.kwargs, used only by a nested ViewSet to filter based on the parent object's         identity.     schema (DefaultSchema): The schema class to use by default in a viewset.
-
-### 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::ArtifactsApi.new
-opts = {
-  limit: 56, # Integer | Number of results to return per page.
-  md5: 'md5_example', # String | Filter results where md5 matches value
-  offset: 56, # Integer | The initial index from which to return the results.
-  ordering: ['ordering_example'], # Array<String> | Ordering
-  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
-  sha1: 'sha1_example', # String | Filter results where sha1 matches value
-  sha224: 'sha224_example', # String | Filter results where sha224 matches value
-  sha256: 'sha256_example', # String | Filter results where sha256 matches value
-  sha384: 'sha384_example', # String | Filter results where sha384 matches value
-  sha512: 'sha512_example', # String | Filter results where sha512 matches value
-  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
-  #List artifacts
-  result = api_instance.artifacts_list(opts)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling ArtifactsApi->artifacts_list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **md5** | **String**| Filter results where md5 matches value | [optional] 
- **offset** | **Integer**| The initial index from which to return the results. | [optional] 
- **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional] 
- **repository_version** | **String**| Repository Version referenced by HREF | [optional] 
- **sha1** | **String**| Filter results where sha1 matches value | [optional] 
- **sha224** | **String**| Filter results where sha224 matches value | [optional] 
- **sha256** | **String**| Filter results where sha256 matches value | [optional] 
- **sha384** | **String**| Filter results where sha384 matches value | [optional] 
- **sha512** | **String**| Filter results where sha512 matches value | [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
-
-[**PaginatedArtifactResponseList**](PaginatedArtifactResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## artifacts_read
-
-> ArtifactResponse artifacts_read(artifact_href, opts)
-
-Inspect an artifact
-
-A customized named ModelViewSet that knows how to register itself with the Pulp API router.  This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method.  Attributes:     lookup_field (str): The name of the field by which an object should be looked up, in         addition to any parent lookups if this ViewSet is nested. Defaults to 'pk'     endpoint_name (str): The name of the final path segment that should identify the ViewSet's         collection endpoint.     nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must         correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin.         None indicates this ViewSet should not be nested.     parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs         to django model filter expressions that can be used with the corresponding value from         self.kwargs, used only by a nested ViewSet to filter based on the parent object's         identity.     schema (DefaultSchema): The schema class to use by default in a viewset.
-
-### 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::ArtifactsApi.new
-artifact_href = 'artifact_href_example' # String | 
-opts = {
-  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
-  #Inspect an artifact
-  result = api_instance.artifacts_read(artifact_href, opts)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling ArtifactsApi->artifacts_read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **artifact_href** | **String**|  | 
- **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
-
-[**ArtifactResponse**](ArtifactResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/ContentApi.md

@@ -1,78 +0,0 @@
-# PulpContainerClient::ContentApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**content_list**](ContentApi.md#content_list) | **GET** /pulp/api/v3/content/ | List content
-
-
-
-## content_list
-
-> PaginatedMultipleArtifactContentResponseList content_list(opts)
-
-List content
-
-Endpoint to list all content.
-
-### 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::ContentApi.new
-opts = {
-  limit: 56, # Integer | Number of results to return per page.
-  offset: 56, # Integer | The initial index from which to return the results.
-  ordering: ['ordering_example'], # Array<String> | Ordering
-  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'], # 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
-  #List content
-  result = api_instance.content_list(opts)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling ContentApi->content_list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **offset** | **Integer**| The initial index from which to return the results. | [optional] 
- **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [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** | [**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
-
-[**PaginatedMultipleArtifactContentResponseList**](PaginatedMultipleArtifactContentResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/ContentAppStatusResponse.md

@@ -1,19 +0,0 @@
-# PulpContainerClient::ContentAppStatusResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The name of the worker. | [optional] [readonly] 
-**last_heartbeat** | **DateTime** | Timestamp of the last time the worker talked to the service. | [optional] [readonly] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::ContentAppStatusResponse.new(name: null,
-                                 last_heartbeat: null)
-```
-
-

data/docs/ContentGuardResponse.md

@@ -1,23 +0,0 @@
-# PulpContainerClient::ContentGuardResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
-**name** | **String** | The unique name. | 
-**description** | **String** | An optional description. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::ContentGuardResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 name: null,
-                                 description: null)
-```
-
-

data/docs/ContentRedirectContentGuard.md

@@ -1,19 +0,0 @@
-# PulpContainerClient::ContentRedirectContentGuard
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The unique name. | 
-**description** | **String** | An optional description. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::ContentRedirectContentGuard.new(name: null,
-                                 description: null)
-```
-
-

data/docs/ContentRedirectContentGuardResponse.md

@@ -1,23 +0,0 @@
-# PulpContainerClient::ContentRedirectContentGuardResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
-**name** | **String** | The unique name. | 
-**description** | **String** | An optional description. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::ContentRedirectContentGuardResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 name: null,
-                                 description: null)
-```
-
-

data/docs/ContentSettingsResponse.md

@@ -1,19 +0,0 @@
-# PulpContainerClient::ContentSettingsResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**content_origin** | **String** | The CONTENT_ORIGIN setting for this Pulp instance | 
-**content_path_prefix** | **String** | The CONTENT_PATH_PREFIX setting for this Pulp instance | 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::ContentSettingsResponse.new(content_origin: null,
-                                 content_path_prefix: null)
-```
-
-

data/docs/ContentguardsApi.md

@@ -1,82 +0,0 @@
-# PulpContainerClient::ContentguardsApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**contentguards_list**](ContentguardsApi.md#contentguards_list) | **GET** /pulp/api/v3/contentguards/ | List content guards
-
-
-
-## contentguards_list
-
-> PaginatedContentGuardResponseList contentguards_list(opts)
-
-List content guards
-
-Endpoint to list all contentguards.
-
-### 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::ContentguardsApi.new
-opts = {
-  limit: 56, # Integer | Number of results to return per page.
-  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'], # Array<String> | Ordering
-  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
-  #List content guards
-  result = api_instance.contentguards_list(opts)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling ContentguardsApi->contentguards_list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **limit** | **Integer**| Number of results to return per page. | [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** | [**Array&lt;String&gt;**](String.md)| Ordering | [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
-
-[**PaginatedContentGuardResponseList**](PaginatedContentGuardResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-