pulp_file_client 0.3.0 → 1.0.0

data/docs/FileFileFilesystemExporterRead.md

@@ -0,0 +1,23 @@
+# PulpFileClient::FileFileFilesystemExporterRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**name** | **String** | Unique name of the file system exporter. | 
+**path** | **String** | File system location to export to. | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::FileFileFilesystemExporterRead.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 path: null)
+```
+
+

data/docs/FileFilePublicationRead.md

@@ -0,0 +1,27 @@
+# PulpFileClient::FileFilePublicationRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**repository_version** | **String** |  | [optional] 
+**repository** | **String** | A URI of the repository to be published. | [optional] 
+**distributions** | **Array<String>** | This publication is currently hosted as defined by these distributions. | [optional] [readonly] 
+**manifest** | **String** | Filename to use for manifest file containing metadata for all the files. | [optional] [default to 'PULP_MANIFEST']
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::FileFilePublicationRead.new(pulp_href: null,
+                                 pulp_created: null,
+                                 repository_version: null,
+                                 repository: null,
+                                 distributions: null,
+                                 manifest: null)
+```
+
+

data/docs/FileFileRemote.md

@@ -8,11 +8,13 @@ Name | Type | Description | Notes
 **pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
 **name** | **String** | A unique name for this remote. | 
 **url** | **String** | The URL of an external content source. | 
-**ca_cert** | **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 checksum of the certificate file on GET. | [optional] 
-**client_cert** | **String** | A string containing the PEM encoded client certificate used for authentication. All new line characters must be escaped. Returns SHA256 checksum of the certificate file on GET. | [optional] 
-**client_key** | **String** | A PEM encoded private key used for authentication. Returns SHA256 checksum of the certificate file on GET. | [optional] 
+**ca_cert** | **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. | [optional] 
+**client_cert** | **String** | A string containing the PEM encoded client certificate used for authentication. All new line characters must be escaped. | [optional] 
+**client_key** | **String** | A PEM encoded private key used for authentication. | [optional] 
 **tls_validation** | **Boolean** | If True, TLS 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] 
 **pulp_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional] [readonly] 
 **download_concurrency** | **Integer** | Total number of simultaneous connections. | [optional] 
 **policy** | **String** | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. | [optional] [default to 'immediate']
@@ -31,6 +33,8 @@ instance = PulpFileClient::FileFileRemote.new(pulp_href: null,
                                  client_key: null,
                                  tls_validation: null,
                                  proxy_url: null,
+                                 username: null,
+                                 password: null,
                                  pulp_last_updated: null,
                                  download_concurrency: null,
                                  policy: null)

data/docs/FileFileRemoteRead.md

@@ -0,0 +1,43 @@
+# PulpFileClient::FileFileRemoteRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**name** | **String** | A unique name for this remote. | 
+**url** | **String** | The URL of an external content source. | 
+**ca_cert** | **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. | [optional] 
+**client_cert** | **String** | A string containing the PEM encoded client certificate used for authentication. All new line characters must be escaped. | [optional] 
+**client_key** | **String** | A PEM encoded private key used for authentication. | [optional] 
+**tls_validation** | **Boolean** | If True, TLS 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] 
+**pulp_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional] [readonly] 
+**download_concurrency** | **Integer** | Total number of simultaneous connections. | [optional] 
+**policy** | **String** | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. | [optional] [default to 'immediate']
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::FileFileRemoteRead.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 url: null,
+                                 ca_cert: null,
+                                 client_cert: null,
+                                 client_key: null,
+                                 tls_validation: null,
+                                 proxy_url: null,
+                                 username: null,
+                                 password: null,
+                                 pulp_last_updated: null,
+                                 download_concurrency: null,
+                                 policy: null)
+```
+
+

data/docs/FileFileRepositoryRead.md

@@ -0,0 +1,27 @@
+# PulpFileClient::FileFileRepositoryRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**versions_href** | **String** |  | [optional] [readonly] 
+**latest_version_href** | **String** |  | [optional] [readonly] 
+**name** | **String** | A unique name for this repository. | 
+**description** | **String** | An optional description. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::FileFileRepositoryRead.new(pulp_href: null,
+                                 pulp_created: null,
+                                 versions_href: null,
+                                 latest_version_href: null,
+                                 name: null,
+                                 description: null)
+```
+
+

data/docs/InlineResponse200.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **count** | **Integer** |  | 
 **_next** | **String** |  | [optional] 
 **previous** | **String** |  | [optional] 
-**results** | [**Array<FileFileContent>**](FileFileContent.md) |  | 
+**results** | [**Array<FileFileContentRead>**](FileFileContentRead.md) |  | 
 
 ## Code Sample
 

data/docs/InlineResponse2001.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **count** | **Integer** |  | 
 **_next** | **String** |  | [optional] 
 **previous** | **String** |  | [optional] 
-**results** | [**Array<FileFileDistribution>**](FileFileDistribution.md) |  | 
+**results** | [**Array<FileFileDistributionRead>**](FileFileDistributionRead.md) |  | 
 
 ## Code Sample
 

data/docs/InlineResponse2002.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **count** | **Integer** |  | 
 **_next** | **String** |  | [optional] 
 **previous** | **String** |  | [optional] 
-**results** | [**Array<FileFileFileSystemExporter>**](FileFileFileSystemExporter.md) |  | 
+**results** | [**Array<FileFileFilesystemExporterRead>**](FileFileFilesystemExporterRead.md) |  | 
 
 ## Code Sample
 

data/docs/InlineResponse2003.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **count** | **Integer** |  | 
 **_next** | **String** |  | [optional] 
 **previous** | **String** |  | [optional] 
-**results** | [**Array<Export>**](Export.md) |  | 
+**results** | [**Array<ExportRead>**](ExportRead.md) |  | 
 
 ## Code Sample
 

data/docs/InlineResponse2004.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **count** | **Integer** |  | 
 **_next** | **String** |  | [optional] 
 **previous** | **String** |  | [optional] 
-**results** | [**Array<FileFilePublication>**](FileFilePublication.md) |  | 
+**results** | [**Array<FileFilePublicationRead>**](FileFilePublicationRead.md) |  | 
 
 ## Code Sample
 

data/docs/InlineResponse2005.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **count** | **Integer** |  | 
 **_next** | **String** |  | [optional] 
 **previous** | **String** |  | [optional] 
-**results** | [**Array<FileFileRemote>**](FileFileRemote.md) |  | 
+**results** | [**Array<FileFileRemoteRead>**](FileFileRemoteRead.md) |  | 
 
 ## Code Sample
 

data/docs/InlineResponse2006.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **count** | **Integer** |  | 
 **_next** | **String** |  | [optional] 
 **previous** | **String** |  | [optional] 
-**results** | [**Array<FileFileRepository>**](FileFileRepository.md) |  | 
+**results** | [**Array<FileFileRepositoryRead>**](FileFileRepositoryRead.md) |  | 
 
 ## Code Sample
 

data/docs/InlineResponse2007.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **count** | **Integer** |  | 
 **_next** | **String** |  | [optional] 
 **previous** | **String** |  | [optional] 
-**results** | [**Array<RepositoryVersion>**](RepositoryVersion.md) |  | 
+**results** | [**Array<RepositoryVersionRead>**](RepositoryVersionRead.md) |  | 
 
 ## Code Sample
 

data/docs/PublicationsFileApi.md

@@ -1,6 +1,6 @@
 # PulpFileClient::PublicationsFileApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -195,7 +195,7 @@ Name | Type | Description  | Notes
 
 ## read
 
-> FileFilePublication read(file_publication_href, opts)
+> FileFilePublicationRead read(file_publication_href, opts)
 
 Inspect a file publication
 
@@ -240,7 +240,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**FileFilePublication**](FileFilePublication.md)
+[**FileFilePublicationRead**](FileFilePublicationRead.md)
 
 ### Authorization
 

data/docs/RemotesFileApi.md

@@ -1,6 +1,6 @@
 # PulpFileClient::RemotesFileApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -15,7 +15,7 @@ Method | HTTP request | Description
 
 ## create
 
-> FileFileRemote create(data)
+> FileFileRemoteRead create(data)
 
 Create a file remote
 
@@ -54,7 +54,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**FileFileRemote**](FileFileRemote.md)
+[**FileFileRemoteRead**](FileFileRemoteRead.md)
 
 ### Authorization
 
@@ -255,7 +255,7 @@ Name | Type | Description  | Notes
 
 ## read
 
-> FileFileRemote read(file_remote_href, opts)
+> FileFileRemoteRead read(file_remote_href, opts)
 
 Inspect a file remote
 
@@ -300,7 +300,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**FileFileRemote**](FileFileRemote.md)
+[**FileFileRemoteRead**](FileFileRemoteRead.md)
 
 ### Authorization
 

data/docs/RepositoriesFileApi.md

@@ -1,6 +1,6 @@
 # PulpFileClient::RepositoriesFileApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -17,7 +17,7 @@ Method | HTTP request | Description
 
 ## create
 
-> FileFileRepository create(data)
+> FileFileRepositoryRead create(data)
 
 Create a file repository
 
@@ -56,7 +56,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**FileFileRepository**](FileFileRepository.md)
+[**FileFileRepositoryRead**](FileFileRepositoryRead.md)
 
 ### Authorization
 
@@ -74,7 +74,7 @@ Name | Type | Description  | Notes
 
 Delete a file repository
 
-Trigger an asynchronous task to delete a repository.
+Trigger an asynchronous delete task
 
 ### Example
 
@@ -245,11 +245,11 @@ Name | Type | Description  | Notes
 
 ## partial_update
 
-> FileFileRepository partial_update(file_repository_href, data)
+> AsyncOperationResponse partial_update(file_repository_href, data)
 
 Partially update a file repository
 
- FileRepository represents a single file repository, to which content can be synced, added, or removed.
+Trigger an asynchronous partial update task
 
 ### Example
 
@@ -286,7 +286,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**FileFileRepository**](FileFileRepository.md)
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
 
 ### Authorization
 
@@ -300,7 +300,7 @@ Name | Type | Description  | Notes
 
 ## read
 
-> FileFileRepository read(file_repository_href, opts)
+> FileFileRepositoryRead read(file_repository_href, opts)
 
 Inspect a file repository
 
@@ -345,7 +345,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**FileFileRepository**](FileFileRepository.md)
+[**FileFileRepositoryRead**](FileFileRepositoryRead.md)
 
 ### Authorization
 
@@ -417,7 +417,7 @@ Name | Type | Description  | Notes
 
 Update a file repository
 
-Trigger an asynchronous task to update a repository.
+Trigger an asynchronous update task
 
 ### Example
 

data/docs/RepositoriesFileVersionsApi.md

@@ -1,6 +1,6 @@
 # PulpFileClient::RepositoriesFileVersionsApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -157,7 +157,7 @@ Name | Type | Description  | Notes
 
 ## read
 
-> RepositoryVersion read(file_repository_version_href, opts)
+> RepositoryVersionRead read(file_repository_version_href, opts)
 
 Inspect a repository version
 
@@ -202,7 +202,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**RepositoryVersion**](RepositoryVersion.md)
+[**RepositoryVersionRead**](RepositoryVersionRead.md)
 
 ### Authorization
 

data/docs/RepositoryVersionRead.md

@@ -0,0 +1,25 @@
+# PulpFileClient::RepositoryVersionRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**number** | **Integer** |  | [optional] [readonly] 
+**base_version** | **String** | A repository version whose content was used as the initial set of content for this repository version | [optional] 
+**content_summary** | [**ContentSummary**](ContentSummary.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::RepositoryVersionRead.new(pulp_href: null,
+                                 pulp_created: null,
+                                 number: null,
+                                 base_version: null,
+                                 content_summary: null)
+```
+
+

data/lib/pulp_file_client/api/content_files_api.rb

@@ -24,7 +24,7 @@ module PulpFileClient
     # @param relative_path [String] Path where the artifact is located relative to distributions base_path
     # @param [Hash] opts the optional parameters
     # @option opts [String] :artifact Artifact file representing the physical content
-    # @option opts [File] :file An uploaded file that should be turned into the artifact of the content unit.
+    # @option opts [File] :file An uploaded file that may be turned into the artifact of the content unit.
     # @option opts [String] :repository A URI of a repository the new content unit should be associated with.
     # @return [AsyncOperationResponse]
     def create(relative_path, opts = {})
@@ -37,7 +37,7 @@ module PulpFileClient
     # @param relative_path [String] Path where the artifact is located relative to distributions base_path
     # @param [Hash] opts the optional parameters
     # @option opts [String] :artifact Artifact file representing the physical content
-    # @option opts [File] :file An uploaded file that should be turned into the artifact of the content unit.
+    # @option opts [File] :file An uploaded file that may be turned into the artifact of the content unit.
     # @option opts [String] :repository A URI of a repository the new content unit should be associated with.
     # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
     def create_with_http_info(relative_path, opts = {})
@@ -189,7 +189,7 @@ module PulpFileClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :fields A list of fields to include in the response.
     # @option opts [String] :exclude_fields A list of fields to exclude from the response.
-    # @return [FileFileContent]
+    # @return [FileFileContentRead]
     def read(file_content_href, opts = {})
       data, _status_code, _headers = read_with_http_info(file_content_href, opts)
       data
@@ -201,7 +201,7 @@ module PulpFileClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :fields A list of fields to include in the response.
     # @option opts [String] :exclude_fields A list of fields to exclude from the response.
-    # @return [Array<(FileFileContent, Integer, Hash)>] FileFileContent data, response status code and response headers
+    # @return [Array<(FileFileContentRead, Integer, Hash)>] FileFileContentRead data, response status code and response headers
     def read_with_http_info(file_content_href, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ContentFilesApi.read ...'
@@ -230,7 +230,7 @@ module PulpFileClient
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'FileFileContent' 
+      return_type = opts[:return_type] || 'FileFileContentRead' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['Basic']

data/lib/pulp_file_client/api/distributions_file_api.rb

@@ -310,7 +310,7 @@ module PulpFileClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :fields A list of fields to include in the response.
     # @option opts [String] :exclude_fields A list of fields to exclude from the response.
-    # @return [FileFileDistribution]
+    # @return [FileFileDistributionRead]
     def read(file_distribution_href, opts = {})
       data, _status_code, _headers = read_with_http_info(file_distribution_href, opts)
       data
@@ -322,7 +322,7 @@ module PulpFileClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :fields A list of fields to include in the response.
     # @option opts [String] :exclude_fields A list of fields to exclude from the response.
-    # @return [Array<(FileFileDistribution, Integer, Hash)>] FileFileDistribution data, response status code and response headers
+    # @return [Array<(FileFileDistributionRead, Integer, Hash)>] FileFileDistributionRead data, response status code and response headers
     def read_with_http_info(file_distribution_href, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DistributionsFileApi.read ...'
@@ -351,7 +351,7 @@ module PulpFileClient
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'FileFileDistribution' 
+      return_type = opts[:return_type] || 'FileFileDistributionRead' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['Basic']