pulp_container_client 1.0.0rc1

data/docs/ContentManifestsApi.md

@@ -0,0 +1,142 @@
+# PulpContainerClient::ContentManifestsApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](ContentManifestsApi.md#list) | **GET** /pulp/api/v3/content/container/manifests/ | List manifests
+[**read**](ContentManifestsApi.md#read) | **GET** {manifest_href} | Inspect a manifest
+
+
+
+## list
+
+> InlineResponse2001 list(opts)
+
+List manifests
+
+ViewSet for Manifest.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ContentManifestsApi.new
+opts = {
+  digest: 'digest_example', # String | Filter results where digest matches value
+  digest__in: 'digest__in_example', # String | Filter results where digest is in a comma-separated list of values
+  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
+  media_type: 'media_type_example', # String | 
+  limit: 56, # Integer | Number of results to return per page.
+  offset: 56, # Integer | The initial index from which to return the results.
+  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 manifests
+  result = api_instance.list(opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ContentManifestsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **digest** | **String**| Filter results where digest matches value | [optional] 
+ **digest__in** | **String**| Filter results where digest is in a comma-separated list of values | [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] 
+ **media_type** | **String**|  | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [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
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> ContainerManifest read(manifest_href, opts)
+
+Inspect a manifest
+
+ViewSet for Manifest.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ContentManifestsApi.new
+manifest_href = 'manifest_href_example' # String | URI of Manifest. e.g.: /pulp/api/v3/content/container/manifests/1/
+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
+  result = api_instance.read(manifest_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ContentManifestsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **manifest_href** | **String**| URI of Manifest. e.g.: /pulp/api/v3/content/container/manifests/1/ | 
+ **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
+
+[**ContainerManifest**](ContainerManifest.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### 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, Hash<String, String>>** |  | 
+**removed** | **Hash<String, Hash<String, String>>** |  | 
+**present** | **Hash<String, Hash<String, String>>** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::ContentSummary.new(added: null,
+                                 removed: null,
+                                 present: null)
+```
+
+

data/docs/ContentTagsApi.md

@@ -0,0 +1,144 @@
+# PulpContainerClient::ContentTagsApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](ContentTagsApi.md#list) | **GET** /pulp/api/v3/content/container/tags/ | List tags
+[**read**](ContentTagsApi.md#read) | **GET** {tag_href} | Inspect a tag
+
+
+
+## list
+
+> InlineResponse2002 list(opts)
+
+List tags
+
+ViewSet for Tag.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ContentTagsApi.new
+opts = {
+  name: 'name_example', # String | Filter results where name matches value
+  name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
+  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
+  media_type: 'media_type_example', # String | 
+  digest: 'digest_example', # String | Multiple values may be separated by commas.
+  limit: 56, # Integer | Number of results to return per page.
+  offset: 56, # Integer | The initial index from which to return the results.
+  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 tags
+  result = api_instance.list(opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ContentTagsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Filter results where name matches value | [optional] 
+ **name__in** | **String**| Filter results where name is in a comma-separated list of values | [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] 
+ **media_type** | **String**|  | [optional] 
+ **digest** | **String**| Multiple values may be separated by commas. | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [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
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> ContainerTag read(tag_href, opts)
+
+Inspect a tag
+
+ViewSet for Tag.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ContentTagsApi.new
+tag_href = 'tag_href_example' # String | URI of Tag. e.g.: /pulp/api/v3/content/container/tags/1/
+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 tag
+  result = api_instance.read(tag_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ContentTagsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **tag_href** | **String**| URI of Tag. e.g.: /pulp/api/v3/content/container/tags/1/ | 
+ **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
+
+[**ContainerTag**](ContainerTag.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DistributionsContainerApi.md

@@ -0,0 +1,362 @@
+# PulpContainerClient::DistributionsContainerApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](DistributionsContainerApi.md#create) | **POST** /pulp/api/v3/distributions/container/container/ | Create a container distribution
+[**delete**](DistributionsContainerApi.md#delete) | **DELETE** {container_distribution_href} | Delete a container distribution
+[**list**](DistributionsContainerApi.md#list) | **GET** /pulp/api/v3/distributions/container/container/ | List container distributions
+[**partial_update**](DistributionsContainerApi.md#partial_update) | **PATCH** {container_distribution_href} | Partially update a container distribution
+[**read**](DistributionsContainerApi.md#read) | **GET** {container_distribution_href} | Inspect a container distribution
+[**update**](DistributionsContainerApi.md#update) | **PUT** {container_distribution_href} | Update a container distribution
+
+
+
+## create
+
+> AsyncOperationResponse create(data)
+
+Create a container distribution
+
+Trigger an asynchronous create task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::DistributionsContainerApi.new
+data = PulpContainerClient::ContainerContainerDistribution.new # ContainerContainerDistribution | 
+
+begin
+  #Create a container distribution
+  result = api_instance.create(data)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling DistributionsContainerApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**ContainerContainerDistribution**](ContainerContainerDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> AsyncOperationResponse delete(container_distribution_href)
+
+Delete a container distribution
+
+Trigger an asynchronous delete task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::DistributionsContainerApi.new
+container_distribution_href = 'container_distribution_href_example' # String | URI of Container Distribution. e.g.: /pulp/api/v3/distributions/container/container/1/
+
+begin
+  #Delete a container distribution
+  result = api_instance.delete(container_distribution_href)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling DistributionsContainerApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **container_distribution_href** | **String**| URI of Container Distribution. e.g.: /pulp/api/v3/distributions/container/container/1/ | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2003 list(opts)
+
+List container distributions
+
+The Container Distribution will serve the latest version of a Repository if ``repository`` is specified. The Container Distribution will serve a specific repository version if ``repository_version``. Note that **either** ``repository`` or ``repository_version`` can be set on a Container Distribution, but not both.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::DistributionsContainerApi.new
+opts = {
+  name: 'name_example', # String | 
+  name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
+  base_path: 'base_path_example', # String | 
+  base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
+  base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
+  base_path__in: 'base_path__in_example', # String | Filter results where base_path is in a comma-separated list of values
+  limit: 56, # Integer | Number of results to return per page.
+  offset: 56, # Integer | The initial index from which to return the results.
+  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 container distributions
+  result = api_instance.list(opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling DistributionsContainerApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**|  | [optional] 
+ **name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional] 
+ **base_path** | **String**|  | [optional] 
+ **base_path__contains** | **String**| Filter results where base_path contains value | [optional] 
+ **base_path__icontains** | **String**| Filter results where base_path contains value | [optional] 
+ **base_path__in** | **String**| Filter results where base_path is in a comma-separated list of values | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [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
+
+[**InlineResponse2003**](InlineResponse2003.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(container_distribution_href, data)
+
+Partially update a container distribution
+
+Trigger an asynchronous partial update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::DistributionsContainerApi.new
+container_distribution_href = 'container_distribution_href_example' # String | URI of Container Distribution. e.g.: /pulp/api/v3/distributions/container/container/1/
+data = PulpContainerClient::ContainerContainerDistribution.new # ContainerContainerDistribution | 
+
+begin
+  #Partially update a container distribution
+  result = api_instance.partial_update(container_distribution_href, data)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling DistributionsContainerApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **container_distribution_href** | **String**| URI of Container Distribution. e.g.: /pulp/api/v3/distributions/container/container/1/ | 
+ **data** | [**ContainerContainerDistribution**](ContainerContainerDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## read
+
+> ContainerContainerDistribution read(container_distribution_href, opts)
+
+Inspect a container distribution
+
+The Container Distribution will serve the latest version of a Repository if ``repository`` is specified. The Container Distribution will serve a specific repository version if ``repository_version``. Note that **either** ``repository`` or ``repository_version`` can be set on a Container Distribution, but not both.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::DistributionsContainerApi.new
+container_distribution_href = 'container_distribution_href_example' # String | URI of Container Distribution. e.g.: /pulp/api/v3/distributions/container/container/1/
+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 container distribution
+  result = api_instance.read(container_distribution_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling DistributionsContainerApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **container_distribution_href** | **String**| URI of Container Distribution. e.g.: /pulp/api/v3/distributions/container/container/1/ | 
+ **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
+
+[**ContainerContainerDistribution**](ContainerContainerDistribution.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(container_distribution_href, data)
+
+Update a container distribution
+
+Trigger an asynchronous update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::DistributionsContainerApi.new
+container_distribution_href = 'container_distribution_href_example' # String | URI of Container Distribution. e.g.: /pulp/api/v3/distributions/container/container/1/
+data = PulpContainerClient::ContainerContainerDistribution.new # ContainerContainerDistribution | 
+
+begin
+  #Update a container distribution
+  result = api_instance.update(container_distribution_href, data)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling DistributionsContainerApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **container_distribution_href** | **String**| URI of Container Distribution. e.g.: /pulp/api/v3/distributions/container/container/1/ | 
+ **data** | [**ContainerContainerDistribution**](ContainerContainerDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/InlineResponse200.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::InlineResponse200
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<ContainerBlob>**](ContainerBlob.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::InlineResponse200.new(count: null,
+                                 _next: null,
+                                 previous: null,
+                                 results: null)
+```
+
+