pulp_file_client 0.1.0b1

data/docs/PublicationsFileApi.md

@@ -0,0 +1,229 @@
+# PulpFileClient::PublicationsFileApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](PublicationsFileApi.md#create) | **POST** /pulp/api/v3/publications/file/file/ | Create a file publication
+[**delete**](PublicationsFileApi.md#delete) | **DELETE** {file_publication_href} | Delete a file publication
+[**list**](PublicationsFileApi.md#list) | **GET** /pulp/api/v3/publications/file/file/ | List file publications
+[**read**](PublicationsFileApi.md#read) | **GET** {file_publication_href} | Inspect a file publication
+
+
+
+## create
+
+> AsyncOperationResponse create(data)
+
+Create a file publication
+
+Trigger an asynchronous task to publish file content.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::PublicationsFileApi.new
+data = PulpFileClient::FilePublication.new # FilePublication | 
+
+begin
+  #Create a file publication
+  result = api_instance.create(data)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling PublicationsFileApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**FilePublication**](FilePublication.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> delete(file_publication_href)
+
+Delete a file publication
+
+<!-- User-facing documentation, rendered as html--> A FilePublication contains metadata about all the <a href=\"#operation/content_file_files_list\">File Content</a> in a particular <a href=\"https://docs.pulpproject.org/en/3.0/nightly/restapi.html#operation/repositories_versions_list\">Repository Version.</a> Once a FilePublication has been created, it can be hosted using the <a href=\"#operation/distributions_file_file_list\">File Distribution API.</a>
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::PublicationsFileApi.new
+file_publication_href = 'file_publication_href_example' # String | URI of File Publication. e.g.: /pulp/api/v3/publications/file/file/1/
+
+begin
+  #Delete a file publication
+  api_instance.delete(file_publication_href)
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling PublicationsFileApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_publication_href** | **String**| URI of File Publication. e.g.: /pulp/api/v3/publications/file/file/1/ | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> InlineResponse2002 list(opts)
+
+List file publications
+
+<!-- User-facing documentation, rendered as html--> A FilePublication contains metadata about all the <a href=\"#operation/content_file_files_list\">File Content</a> in a particular <a href=\"https://docs.pulpproject.org/en/3.0/nightly/restapi.html#operation/repositories_versions_list\">Repository Version.</a> Once a FilePublication has been created, it can be hosted using the <a href=\"#operation/distributions_file_file_list\">File Distribution API.</a>
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::PublicationsFileApi.new
+opts = {
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  page: 56, # Integer | A page number within the paginated result set.
+  page_size: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  #List file publications
+  result = api_instance.list(opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling PublicationsFileApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ordering** | **String**| Which field to use when ordering the results. | [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
+
+> FilePublication read(file_publication_href)
+
+Inspect a file publication
+
+<!-- User-facing documentation, rendered as html--> A FilePublication contains metadata about all the <a href=\"#operation/content_file_files_list\">File Content</a> in a particular <a href=\"https://docs.pulpproject.org/en/3.0/nightly/restapi.html#operation/repositories_versions_list\">Repository Version.</a> Once a FilePublication has been created, it can be hosted using the <a href=\"#operation/distributions_file_file_list\">File Distribution API.</a>
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::PublicationsFileApi.new
+file_publication_href = 'file_publication_href_example' # String | URI of File Publication. e.g.: /pulp/api/v3/publications/file/file/1/
+
+begin
+  #Inspect a file publication
+  result = api_instance.read(file_publication_href)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling PublicationsFileApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_publication_href** | **String**| URI of File Publication. e.g.: /pulp/api/v3/publications/file/file/1/ | 
+
+### Return type
+
+[**FilePublication**](FilePublication.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RemotesFileApi.md

@@ -0,0 +1,411 @@
+# PulpFileClient::RemotesFileApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](RemotesFileApi.md#create) | **POST** /pulp/api/v3/remotes/file/file/ | Create a file remote
+[**delete**](RemotesFileApi.md#delete) | **DELETE** {file_remote_href} | Delete a file remote
+[**list**](RemotesFileApi.md#list) | **GET** /pulp/api/v3/remotes/file/file/ | List file remotes
+[**partial_update**](RemotesFileApi.md#partial_update) | **PATCH** {file_remote_href} | Partially update a file remote
+[**read**](RemotesFileApi.md#read) | **GET** {file_remote_href} | Inspect a file remote
+[**sync**](RemotesFileApi.md#sync) | **POST** {file_remote_href}sync/ | 
+[**update**](RemotesFileApi.md#update) | **PUT** {file_remote_href} | Update a file remote
+
+
+
+## create
+
+> FileRemote create(data)
+
+Create a file remote
+
+<!-- User-facing documentation, rendered as html--> FileRemote represents an external source of <a href=\"#operation/content_file_files_list\">File Content</a>.  The target url of a FileRemote must contain a file manifest, which contains the metadata for all files at the source.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::RemotesFileApi.new
+data = PulpFileClient::FileRemote.new # FileRemote | 
+
+begin
+  #Create a file remote
+  result = api_instance.create(data)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling RemotesFileApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**FileRemote**](FileRemote.md)|  | 
+
+### Return type
+
+[**FileRemote**](FileRemote.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> AsyncOperationResponse delete(file_remote_href)
+
+Delete a file remote
+
+Trigger an asynchronous delete task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::RemotesFileApi.new
+file_remote_href = 'file_remote_href_example' # String | URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/
+
+begin
+  #Delete a file remote
+  result = api_instance.delete(file_remote_href)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling RemotesFileApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_remote_href** | **String**| URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/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 file remotes
+
+<!-- User-facing documentation, rendered as html--> FileRemote represents an external source of <a href=\"#operation/content_file_files_list\">File Content</a>.  The target url of a FileRemote must contain a file manifest, which contains the metadata for all files at the source.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::RemotesFileApi.new
+opts = {
+  name: 'name_example', # String | 
+  name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
+  _last_updated__lt: '_last_updated__lt_example', # String | Filter results where _last_updated is less than value
+  _last_updated__lte: '_last_updated__lte_example', # String | Filter results where _last_updated is less than or equal to value
+  _last_updated__gt: '_last_updated__gt_example', # String | Filter results where _last_updated is greater than value
+  _last_updated__gte: '_last_updated__gte_example', # String | Filter results where _last_updated is greater than or equal to value
+  _last_updated__range: '_last_updated__range_example', # String | Filter results where _last_updated is between two comma separated values
+  _last_updated: '_last_updated_example', # String | ISO 8601 formatted dates are supported
+  page: 56, # Integer | A page number within the paginated result set.
+  page_size: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  #List file remotes
+  result = api_instance.list(opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling RemotesFileApi->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] 
+ **_last_updated__lt** | **String**| Filter results where _last_updated is less than value | [optional] 
+ **_last_updated__lte** | **String**| Filter results where _last_updated is less than or equal to value | [optional] 
+ **_last_updated__gt** | **String**| Filter results where _last_updated is greater than value | [optional] 
+ **_last_updated__gte** | **String**| Filter results where _last_updated is greater than or equal to value | [optional] 
+ **_last_updated__range** | **String**| Filter results where _last_updated is between two comma separated values | [optional] 
+ **_last_updated** | **String**| ISO 8601 formatted dates are supported | [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(file_remote_href, data)
+
+Partially update a file remote
+
+Trigger an asynchronous partial update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::RemotesFileApi.new
+file_remote_href = 'file_remote_href_example' # String | URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/
+data = PulpFileClient::FileRemote.new # FileRemote | 
+
+begin
+  #Partially update a file remote
+  result = api_instance.partial_update(file_remote_href, data)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling RemotesFileApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_remote_href** | **String**| URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/ | 
+ **data** | [**FileRemote**](FileRemote.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## read
+
+> FileRemote read(file_remote_href)
+
+Inspect a file remote
+
+<!-- User-facing documentation, rendered as html--> FileRemote represents an external source of <a href=\"#operation/content_file_files_list\">File Content</a>.  The target url of a FileRemote must contain a file manifest, which contains the metadata for all files at the source.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::RemotesFileApi.new
+file_remote_href = 'file_remote_href_example' # String | URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/
+
+begin
+  #Inspect a file remote
+  result = api_instance.read(file_remote_href)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling RemotesFileApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_remote_href** | **String**| URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/ | 
+
+### Return type
+
+[**FileRemote**](FileRemote.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## sync
+
+> AsyncOperationResponse sync(file_remote_href, data)
+
+
+
+Trigger an asynchronous task to sync file content.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::RemotesFileApi.new
+file_remote_href = 'file_remote_href_example' # String | URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/
+data = PulpFileClient::RepositorySyncURL.new # RepositorySyncURL | 
+
+begin
+  result = api_instance.sync(file_remote_href, data)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling RemotesFileApi->sync: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_remote_href** | **String**| URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/ | 
+ **data** | [**RepositorySyncURL**](RepositorySyncURL.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(file_remote_href, data)
+
+Update a file remote
+
+Trigger an asynchronous update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::RemotesFileApi.new
+file_remote_href = 'file_remote_href_example' # String | URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/
+data = PulpFileClient::FileRemote.new # FileRemote | 
+
+begin
+  #Update a file remote
+  result = api_instance.update(file_remote_href, data)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling RemotesFileApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_remote_href** | **String**| URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/ | 
+ **data** | [**FileRemote**](FileRemote.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/RepositorySyncURL.md

@@ -0,0 +1,19 @@
+# PulpFileClient::RepositorySyncURL
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**repository** | **String** | A URI of the repository to be synchronized. | 
+**mirror** | **Boolean** | If ``True``, synchronization will remove all content that is not present in the remote repository. If ``False``, sync will be additive only. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::RepositorySyncURL.new(repository: null,
+                                 mirror: null)
+```
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://openapi-generator.tech
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+