pulp_ostree_client 2.0.0a1

data/docs/RepositoriesOstreeVersionsApi.md

@@ -0,0 +1,271 @@
+# PulpOstreeClient::RepositoriesOstreeVersionsApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete**](RepositoriesOstreeVersionsApi.md#delete) | **DELETE** {ostree_ostree_repository_version_href} | Delete a repository version
+[**list**](RepositoriesOstreeVersionsApi.md#list) | **GET** {ostree_ostree_repository_href}versions/ | List repository versions
+[**read**](RepositoriesOstreeVersionsApi.md#read) | **GET** {ostree_ostree_repository_version_href} | Inspect a repository version
+[**repair**](RepositoriesOstreeVersionsApi.md#repair) | **POST** {ostree_ostree_repository_version_href}repair/ | 
+
+
+
+## delete
+
+> AsyncOperationResponse delete(ostree_ostree_repository_version_href)
+
+Delete a repository version
+
+Trigger an asynchronous task to delete a repository version.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ostree_client'
+# setup authorization
+PulpOstreeClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpOstreeClient::RepositoriesOstreeVersionsApi.new
+ostree_ostree_repository_version_href = 'ostree_ostree_repository_version_href_example' # String | 
+
+begin
+  #Delete a repository version
+  result = api_instance.delete(ostree_ostree_repository_version_href)
+  p result
+rescue PulpOstreeClient::ApiError => e
+  puts "Exception when calling RepositoriesOstreeVersionsApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ostree_ostree_repository_version_href** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> PaginatedRepositoryVersionResponseList list(ostree_ostree_repository_href, opts)
+
+List repository versions
+
+A ViewSet class that represents a single OSTree repository version.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ostree_client'
+# setup authorization
+PulpOstreeClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpOstreeClient::RepositoriesOstreeVersionsApi.new
+ostree_ostree_repository_href = 'ostree_ostree_repository_href_example' # String | 
+opts = {
+  content: 'content_example', # String | Content Unit referenced by HREF
+  content__in: 'content__in_example', # String | Content Unit referenced by HREF
+  limit: 56, # Integer | Number of results to return per page.
+  number: 56, # Integer | 
+  number__gt: 56, # Integer | Filter results where number is greater than value
+  number__gte: 56, # Integer | Filter results where number is greater than or equal to value
+  number__lt: 56, # Integer | Filter results where number is less than value
+  number__lte: 56, # Integer | Filter results where number is less than or equal to value
+  number__range: [56], # Array<Integer> | Filter results where number is between two comma separated values
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  pulp_created: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | ISO 8601 formatted dates are supported
+  pulp_created__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than value
+  pulp_created__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than or equal to value
+  pulp_created__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than value
+  pulp_created__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than or equal to value
+  pulp_created__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_created is between two comma separated values
+  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 repository versions
+  result = api_instance.list(ostree_ostree_repository_href, opts)
+  p result
+rescue PulpOstreeClient::ApiError => e
+  puts "Exception when calling RepositoriesOstreeVersionsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ostree_ostree_repository_href** | **String**|  | 
+ **content** | **String**| Content Unit referenced by HREF | [optional] 
+ **content__in** | **String**| Content Unit referenced by HREF | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **number** | **Integer**|  | [optional] 
+ **number__gt** | **Integer**| Filter results where number is greater than value | [optional] 
+ **number__gte** | **Integer**| Filter results where number is greater than or equal to value | [optional] 
+ **number__lt** | **Integer**| Filter results where number is less than value | [optional] 
+ **number__lte** | **Integer**| Filter results where number is less than or equal to value | [optional] 
+ **number__range** | [**Array&lt;Integer&gt;**](Integer.md)| Filter results where number is between two comma separated values | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **pulp_created** | **DateTime**| ISO 8601 formatted dates are supported | [optional] 
+ **pulp_created__gt** | **DateTime**| Filter results where pulp_created is greater than value | [optional] 
+ **pulp_created__gte** | **DateTime**| Filter results where pulp_created is greater than or equal to value | [optional] 
+ **pulp_created__lt** | **DateTime**| Filter results where pulp_created is less than value | [optional] 
+ **pulp_created__lte** | **DateTime**| Filter results where pulp_created is less than or equal to value | [optional] 
+ **pulp_created__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_created is between two comma separated values | [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
+
+[**PaginatedRepositoryVersionResponseList**](PaginatedRepositoryVersionResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> RepositoryVersionResponse read(ostree_ostree_repository_version_href, opts)
+
+Inspect a repository version
+
+A ViewSet class that represents a single OSTree repository version.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ostree_client'
+# setup authorization
+PulpOstreeClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpOstreeClient::RepositoriesOstreeVersionsApi.new
+ostree_ostree_repository_version_href = 'ostree_ostree_repository_version_href_example' # String | 
+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 repository version
+  result = api_instance.read(ostree_ostree_repository_version_href, opts)
+  p result
+rescue PulpOstreeClient::ApiError => e
+  puts "Exception when calling RepositoriesOstreeVersionsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ostree_ostree_repository_version_href** | **String**|  | 
+ **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
+
+[**RepositoryVersionResponse**](RepositoryVersionResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## repair
+
+> AsyncOperationResponse repair(ostree_ostree_repository_version_href, repository_version)
+
+
+
+Trigger an asynchronous task to repair a repository version.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ostree_client'
+# setup authorization
+PulpOstreeClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpOstreeClient::RepositoriesOstreeVersionsApi.new
+ostree_ostree_repository_version_href = 'ostree_ostree_repository_version_href_example' # String | 
+repository_version = PulpOstreeClient::RepositoryVersion.new # RepositoryVersion | 
+
+begin
+  result = api_instance.repair(ostree_ostree_repository_version_href, repository_version)
+  p result
+rescue PulpOstreeClient::ApiError => e
+  puts "Exception when calling RepositoriesOstreeVersionsApi->repair: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ostree_ostree_repository_version_href** | **String**|  | 
+ **repository_version** | [**RepositoryVersion**](RepositoryVersion.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/RepositoryAddRemoveContent.md

@@ -0,0 +1,21 @@
+# PulpOstreeClient::RepositoryAddRemoveContent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**add_content_units** | [**Array<AnyType>**](AnyType.md) | A list of content units to add to a new repository version. This content is added after remove_content_units are removed. | [optional] 
+**remove_content_units** | [**Array<AnyType>**](AnyType.md) | A list of content units to remove from the latest repository version. You may also specify '*' as an entry to remove all content. This content is removed before add_content_units are added. | [optional] 
+**base_version** | **String** | A repository version whose content will be used as the initial set of content for the new repository version | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::RepositoryAddRemoveContent.new(add_content_units: null,
+                                 remove_content_units: null,
+                                 base_version: null)
+```
+
+

data/docs/RepositorySyncURL.md

@@ -0,0 +1,19 @@
+# PulpOstreeClient::RepositorySyncURL
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**remote** | **String** | A remote to sync from. This will override a remote set on repository. | [optional] 
+**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 'PulpOstreeClient'
+
+instance = PulpOstreeClient::RepositorySyncURL.new(remote: null,
+                                 mirror: null)
+```
+
+

data/docs/RepositoryVersion.md

@@ -0,0 +1,17 @@
+# PulpOstreeClient::RepositoryVersion
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**base_version** | **String** | A repository version whose content was used as the initial set of content for this repository version | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::RepositoryVersion.new(base_version: null)
+```
+
+

data/docs/RepositoryVersionResponse.md

@@ -0,0 +1,27 @@
+# PulpOstreeClient::RepositoryVersionResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**number** | **Integer** |  | [optional] [readonly] 
+**repository** | **String** |  | [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** | [**ContentSummaryResponse**](ContentSummaryResponse.md) | Various count summaries of the content in the version and the HREF to view them. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::RepositoryVersionResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 number: null,
+                                 repository: null,
+                                 base_version: null,
+                                 content_summary: null)
+```
+
+

data/git_push.sh

@@ -0,0 +1,58 @@
+#!/bin/sh
+# 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" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+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://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${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://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/pulp_ostree_client/api/content_commits_api.rb

@@ -0,0 +1,170 @@
+=begin
+#Pulp 3 API
+
+#Fetch, Upload, Organize, and Distribute Software Packages
+
+The version of the OpenAPI document: v3
+Contact: pulp-list@redhat.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module PulpOstreeClient
+  class ContentCommitsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List ostree commits
+    # A ViewSet class for OSTree commits.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @option opts [String] :ordering Which field to use when ordering the results.
+    # @option opts [String] :repository_version Repository Version referenced by HREF
+    # @option opts [String] :repository_version_added Repository Version referenced by HREF
+    # @option opts [String] :repository_version_removed Repository Version referenced by HREF
+    # @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 [PaginatedostreeOstreeCommitResponseList]
+    def list(opts = {})
+      data, _status_code, _headers = list_with_http_info(opts)
+      data
+    end
+
+    # List ostree commits
+    # A ViewSet class for OSTree commits.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @option opts [String] :ordering Which field to use when ordering the results.
+    # @option opts [String] :repository_version Repository Version referenced by HREF
+    # @option opts [String] :repository_version_added Repository Version referenced by HREF
+    # @option opts [String] :repository_version_removed Repository Version referenced by HREF
+    # @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<(PaginatedostreeOstreeCommitResponseList, Integer, Hash)>] PaginatedostreeOstreeCommitResponseList data, response status code and response headers
+    def list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContentCommitsApi.list ...'
+      end
+      # resource path
+      local_var_path = '/pulp/api/v3/content/ostree/commits/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
+      query_params[:'repository_version'] = opts[:'repository_version'] if !opts[:'repository_version'].nil?
+      query_params[:'repository_version_added'] = opts[:'repository_version_added'] if !opts[:'repository_version_added'].nil?
+      query_params[:'repository_version_removed'] = opts[:'repository_version_removed'] if !opts[:'repository_version_removed'].nil?
+      query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
+      query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PaginatedostreeOstreeCommitResponseList' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ContentCommitsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Inspect an ostree commit
+    # A ViewSet class for OSTree commits.
+    # @param ostree_ostree_commit_href [String] 
+    # @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 [OstreeOstreeCommitResponse]
+    def read(ostree_ostree_commit_href, opts = {})
+      data, _status_code, _headers = read_with_http_info(ostree_ostree_commit_href, opts)
+      data
+    end
+
+    # Inspect an ostree commit
+    # A ViewSet class for OSTree commits.
+    # @param ostree_ostree_commit_href [String] 
+    # @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<(OstreeOstreeCommitResponse, Integer, Hash)>] OstreeOstreeCommitResponse data, response status code and response headers
+    def read_with_http_info(ostree_ostree_commit_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContentCommitsApi.read ...'
+      end
+      # verify the required parameter 'ostree_ostree_commit_href' is set
+      if @api_client.config.client_side_validation && ostree_ostree_commit_href.nil?
+        fail ArgumentError, "Missing the required parameter 'ostree_ostree_commit_href' when calling ContentCommitsApi.read"
+      end
+      # resource path
+      local_var_path = '{ostree_ostree_commit_href}'.sub('{' + 'ostree_ostree_commit_href' + '}', CGI.escape(ostree_ostree_commit_href.to_s).gsub('%2F', '/'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
+      query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'OstreeOstreeCommitResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ContentCommitsApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end