pulp_docker_client 4.0.0b5

data/docs/ContentManifestsApi.md

@@ -0,0 +1,180 @@
+# PulpDockerClient::ContentManifestsApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ContentManifestsApi.md#create) | **POST** /pulp/api/v3/content/docker/manifests/ | Create a manifest
+[**list**](ContentManifestsApi.md#list) | **GET** /pulp/api/v3/content/docker/manifests/ | List manifests
+[**read**](ContentManifestsApi.md#read) | **GET** {manifest_href} | Inspect a manifest
+
+
+
+## create
+
+> Manifest create(data)
+
+Create a manifest
+
+Create a new Manifest from a request.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_docker_client'
+# setup authorization
+PulpDockerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDockerClient::ContentManifestsApi.new
+data = PulpDockerClient::Manifest.new # Manifest | 
+
+begin
+  #Create a manifest
+  result = api_instance.create(data)
+  p result
+rescue PulpDockerClient::ApiError => e
+  puts "Exception when calling ContentManifestsApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**Manifest**](Manifest.md)|  | 
+
+### Return type
+
+[**Manifest**](Manifest.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2002 list(opts)
+
+List manifests
+
+ViewSet for Manifest.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_docker_client'
+# setup authorization
+PulpDockerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDockerClient::ContentManifestsApi.new
+opts = {
+  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
+  page: 56, # Integer | A page number within the paginated result set.
+  page_size: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  #List manifests
+  result = api_instance.list(opts)
+  p result
+rescue PulpDockerClient::ApiError => e
+  puts "Exception when calling ContentManifestsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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] 
+ **page** | **Integer**| A page number within the paginated result set. | [optional] 
+ **page_size** | **Integer**| Number of results to return per page. | [optional] 
+
+### Return type
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> Manifest read(manifest_href)
+
+Inspect a manifest
+
+ViewSet for Manifest.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_docker_client'
+# setup authorization
+PulpDockerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDockerClient::ContentManifestsApi.new
+manifest_href = 'manifest_href_example' # String | URI of Manifest. e.g.: /pulp/api/v3/content/docker/manifests/1/
+
+begin
+  #Inspect a manifest
+  result = api_instance.read(manifest_href)
+  p result
+rescue PulpDockerClient::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/docker/manifests/1/ | 
+
+### Return type
+
+[**Manifest**](Manifest.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DistributionsDockerApi.md

@@ -0,0 +1,352 @@
+# PulpDockerClient::DistributionsDockerApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](DistributionsDockerApi.md#create) | **POST** /pulp/api/v3/distributions/docker/docker/ | Create a docker distribution
+[**delete**](DistributionsDockerApi.md#delete) | **DELETE** {docker_distribution_href} | Delete a docker distribution
+[**list**](DistributionsDockerApi.md#list) | **GET** /pulp/api/v3/distributions/docker/docker/ | List docker distributions
+[**partial_update**](DistributionsDockerApi.md#partial_update) | **PATCH** {docker_distribution_href} | Partially update a docker distribution
+[**read**](DistributionsDockerApi.md#read) | **GET** {docker_distribution_href} | Inspect a docker distribution
+[**update**](DistributionsDockerApi.md#update) | **PUT** {docker_distribution_href} | Update a docker distribution
+
+
+
+## create
+
+> AsyncOperationResponse create(data)
+
+Create a docker distribution
+
+Trigger an asynchronous create task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_docker_client'
+# setup authorization
+PulpDockerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDockerClient::DistributionsDockerApi.new
+data = PulpDockerClient::DockerDistribution.new # DockerDistribution | 
+
+begin
+  #Create a docker distribution
+  result = api_instance.create(data)
+  p result
+rescue PulpDockerClient::ApiError => e
+  puts "Exception when calling DistributionsDockerApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**DockerDistribution**](DockerDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> AsyncOperationResponse delete(docker_distribution_href)
+
+Delete a docker distribution
+
+Trigger an asynchronous delete task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_docker_client'
+# setup authorization
+PulpDockerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDockerClient::DistributionsDockerApi.new
+docker_distribution_href = 'docker_distribution_href_example' # String | URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/
+
+begin
+  #Delete a docker distribution
+  result = api_instance.delete(docker_distribution_href)
+  p result
+rescue PulpDockerClient::ApiError => e
+  puts "Exception when calling DistributionsDockerApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **docker_distribution_href** | **String**| URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/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 docker distributions
+
+ViewSet for DockerDistribution model.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_docker_client'
+# setup authorization
+PulpDockerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDockerClient::DistributionsDockerApi.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
+  page: 56, # Integer | A page number within the paginated result set.
+  page_size: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  #List docker distributions
+  result = api_instance.list(opts)
+  p result
+rescue PulpDockerClient::ApiError => e
+  puts "Exception when calling DistributionsDockerApi->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] 
+ **page** | **Integer**| A page number within the paginated result set. | [optional] 
+ **page_size** | **Integer**| Number of results to return per page. | [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(docker_distribution_href, data)
+
+Partially update a docker distribution
+
+Trigger an asynchronous partial update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_docker_client'
+# setup authorization
+PulpDockerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDockerClient::DistributionsDockerApi.new
+docker_distribution_href = 'docker_distribution_href_example' # String | URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/
+data = PulpDockerClient::DockerDistribution.new # DockerDistribution | 
+
+begin
+  #Partially update a docker distribution
+  result = api_instance.partial_update(docker_distribution_href, data)
+  p result
+rescue PulpDockerClient::ApiError => e
+  puts "Exception when calling DistributionsDockerApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **docker_distribution_href** | **String**| URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/ | 
+ **data** | [**DockerDistribution**](DockerDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## read
+
+> DockerDistribution read(docker_distribution_href)
+
+Inspect a docker distribution
+
+ViewSet for DockerDistribution model.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_docker_client'
+# setup authorization
+PulpDockerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDockerClient::DistributionsDockerApi.new
+docker_distribution_href = 'docker_distribution_href_example' # String | URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/
+
+begin
+  #Inspect a docker distribution
+  result = api_instance.read(docker_distribution_href)
+  p result
+rescue PulpDockerClient::ApiError => e
+  puts "Exception when calling DistributionsDockerApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **docker_distribution_href** | **String**| URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/ | 
+
+### Return type
+
+[**DockerDistribution**](DockerDistribution.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(docker_distribution_href, data)
+
+Update a docker distribution
+
+Trigger an asynchronous update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_docker_client'
+# setup authorization
+PulpDockerClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDockerClient::DistributionsDockerApi.new
+docker_distribution_href = 'docker_distribution_href_example' # String | URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/
+data = PulpDockerClient::DockerDistribution.new # DockerDistribution | 
+
+begin
+  #Update a docker distribution
+  result = api_instance.update(docker_distribution_href, data)
+  p result
+rescue PulpDockerClient::ApiError => e
+  puts "Exception when calling DistributionsDockerApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **docker_distribution_href** | **String**| URI of Docker Distribution. e.g.: /pulp/api/v3/distributions/docker/docker/1/ | 
+ **data** | [**DockerDistribution**](DockerDistribution.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/DockerDistribution.md

@@ -0,0 +1,31 @@
+# PulpDockerClient::DockerDistribution
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**repository_version** | **String** | RepositoryVersion to be served | [optional] 
+**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] 
+**_created** | **DateTime** | Timestamp of creation. | [optional] 
+**content_guard** | **String** | An optional content-guard. | [optional] 
+**_href** | **String** |  | [optional] 
+**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | 
+**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\") | 
+**registry_path** | **String** | The Registry hostame:port/name/ to use with docker pull command defined by this distribution. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpDockerClient'
+
+instance = PulpDockerClient::DockerDistribution.new(repository_version: null,
+                                 repository: null,
+                                 _created: null,
+                                 content_guard: null,
+                                 _href: null,
+                                 name: null,
+                                 base_path: null,
+                                 registry_path: null)
+```
+
+

data/docs/DockerRemote.md

@@ -0,0 +1,49 @@
+# PulpDockerClient::DockerRemote
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_href** | **String** |  | [optional] 
+**_created** | **DateTime** | Timestamp of creation. | [optional] 
+**_type** | **String** |  | [optional] 
+**name** | **String** | A unique name for this remote. | 
+**url** | **String** | The URL of an external content source. | 
+**ssl_ca_certificate** | **String** | A string containing the PEM encoded CA certificate used to validate the server certificate presented by the remote server. All new line characters must be escaped. Returns SHA256 sum on GET. | [optional] 
+**ssl_client_certificate** | **String** | A string containing the PEM encoded client certificate used for authentication. All new line characters must be escaped. Returns SHA256 sum on GET. | [optional] 
+**ssl_client_key** | **String** | A PEM encoded private key used for authentication. Returns SHA256 sum on GET. | [optional] 
+**ssl_validation** | **Boolean** | If True, SSL peer validation must be performed. | [optional] 
+**proxy_url** | **String** | The proxy URL. Format: scheme://user:password@host:port | [optional] 
+**username** | **String** | The username to be used for authentication when syncing. | [optional] 
+**password** | **String** | The password to be used for authentication when syncing. | [optional] 
+**_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional] 
+**download_concurrency** | **Integer** | Total number of simultaneous connections. | [optional] 
+**policy** | **String** | The policy to use when downloading content. | [optional] [default to 'immediate']
+**upstream_name** | **String** | Name of the upstream repository | 
+**whitelist_tags** | **String** | A comma separated string of tags to sync.         Example:          latest,1.27.0          | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpDockerClient'
+
+instance = PulpDockerClient::DockerRemote.new(_href: null,
+                                 _created: null,
+                                 _type: null,
+                                 name: null,
+                                 url: null,
+                                 ssl_ca_certificate: null,
+                                 ssl_client_certificate: null,
+                                 ssl_client_key: null,
+                                 ssl_validation: null,
+                                 proxy_url: null,
+                                 username: null,
+                                 password: null,
+                                 _last_updated: null,
+                                 download_concurrency: null,
+                                 policy: null,
+                                 upstream_name: null,
+                                 whitelist_tags: null)
+```
+
+

data/docs/InlineResponse200.md

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

data/docs/InlineResponse2001.md

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

data/docs/InlineResponse2002.md

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

data/docs/InlineResponse2003.md

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