pulp_container_client 1.0.0rc1

data/docs/RepositoriesContainerVersionsApi.md

@@ -0,0 +1,214 @@
+# PulpContainerClient::RepositoriesContainerVersionsApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete**](RepositoriesContainerVersionsApi.md#delete) | **DELETE** {container_repository_version_href} | Delete a repository version
+[**list**](RepositoriesContainerVersionsApi.md#list) | **GET** {container_repository_href}versions/ | List repository versions
+[**read**](RepositoriesContainerVersionsApi.md#read) | **GET** {container_repository_version_href} | Inspect a repository version
+
+
+
+## delete
+
+> AsyncOperationResponse delete(container_repository_version_href)
+
+Delete a repository version
+
+Trigger an asynchronous task to delete a repositroy version.
+
+### 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::RepositoriesContainerVersionsApi.new
+container_repository_version_href = 'container_repository_version_href_example' # String | URI of Repository Version. e.g.: /pulp/api/v3/repositories/container/container/1/versions/1/
+
+begin
+  #Delete a repository version
+  result = api_instance.delete(container_repository_version_href)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling RepositoriesContainerVersionsApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **container_repository_version_href** | **String**| URI of Repository Version. e.g.: /pulp/api/v3/repositories/container/container/1/versions/1/ | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2006 list(container_container_repository_href, opts)
+
+List repository versions
+
+ContainerRepositoryVersion represents a single container repository version.
+
+### 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::RepositoriesContainerVersionsApi.new
+container_container_repository_href = 'container_container_repository_href_example' # String | URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/
+opts = {
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  number: 3.4, # Float | 
+  number__lt: 3.4, # Float | Filter results where number is less than value
+  number__lte: 3.4, # Float | Filter results where number is less than or equal to value
+  number__gt: 3.4, # Float | Filter results where number is greater than value
+  number__gte: 3.4, # Float | Filter results where number is greater than or equal to value
+  number__range: 3.4, # Float | Filter results where number is between two comma separated values
+  pulp_created__lt: 'pulp_created__lt_example', # String | Filter results where pulp_created is less than value
+  pulp_created__lte: 'pulp_created__lte_example', # String | Filter results where pulp_created is less than or equal to value
+  pulp_created__gt: 'pulp_created__gt_example', # String | Filter results where pulp_created is greater than value
+  pulp_created__gte: 'pulp_created__gte_example', # String | Filter results where pulp_created is greater than or equal to value
+  pulp_created__range: 'pulp_created__range_example', # String | Filter results where pulp_created is between two comma separated values
+  content: 'content_example', # String | Content Unit referenced by HREF
+  pulp_created: 'pulp_created_example', # String | ISO 8601 formatted dates are supported
+  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 repository versions
+  result = api_instance.list(container_container_repository_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling RepositoriesContainerVersionsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **container_container_repository_href** | **String**| URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/ | 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **number** | **Float**|  | [optional] 
+ **number__lt** | **Float**| Filter results where number is less than value | [optional] 
+ **number__lte** | **Float**| Filter results where number is less than or equal to value | [optional] 
+ **number__gt** | **Float**| Filter results where number is greater than value | [optional] 
+ **number__gte** | **Float**| Filter results where number is greater than or equal to value | [optional] 
+ **number__range** | **Float**| Filter results where number is between two comma separated values | [optional] 
+ **pulp_created__lt** | **String**| Filter results where pulp_created is less than value | [optional] 
+ **pulp_created__lte** | **String**| Filter results where pulp_created is less than or equal to value | [optional] 
+ **pulp_created__gt** | **String**| Filter results where pulp_created is greater than value | [optional] 
+ **pulp_created__gte** | **String**| Filter results where pulp_created is greater than or equal to value | [optional] 
+ **pulp_created__range** | **String**| Filter results where pulp_created is between two comma separated values | [optional] 
+ **content** | **String**| Content Unit referenced by HREF | [optional] 
+ **pulp_created** | **String**| ISO 8601 formatted dates are supported | [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
+
+[**InlineResponse2006**](InlineResponse2006.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> RepositoryVersion read(container_repository_version_href, opts)
+
+Inspect a repository version
+
+ContainerRepositoryVersion represents a single container repository version.
+
+### 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::RepositoriesContainerVersionsApi.new
+container_repository_version_href = 'container_repository_version_href_example' # String | URI of Repository Version. e.g.: /pulp/api/v3/repositories/container/container/1/versions/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 repository version
+  result = api_instance.read(container_repository_version_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling RepositoriesContainerVersionsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **container_repository_version_href** | **String**| URI of Repository Version. e.g.: /pulp/api/v3/repositories/container/container/1/versions/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
+
+[**RepositoryVersion**](RepositoryVersion.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RepositorySyncURL.md

@@ -0,0 +1,19 @@
+# PulpContainerClient::RepositorySyncURL
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**remote** | **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 'PulpContainerClient'
+
+instance = PulpContainerClient::RepositorySyncURL.new(remote: null,
+                                 mirror: null)
+```
+
+

data/docs/RepositoryVersion.md

@@ -0,0 +1,25 @@
+# PulpContainerClient::RepositoryVersion
+
+## 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 'PulpContainerClient'
+
+instance = PulpContainerClient::RepositoryVersion.new(pulp_href: null,
+                                 pulp_created: null,
+                                 number: null,
+                                 base_version: null,
+                                 content_summary: null)
+```
+
+

data/docs/TagCopy.md

@@ -0,0 +1,21 @@
+# PulpContainerClient::TagCopy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source_repository** | **String** | A URI of the repository to copy content from. | [optional] 
+**source_repository_version** | **String** | A URI of the repository version to copy content from. | [optional] 
+**names** | **Array<String>** | A list of tag names to copy. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::TagCopy.new(source_repository: null,
+                                 source_repository_version: null,
+                                 names: null)
+```
+
+

data/docs/TagImage.md

@@ -0,0 +1,19 @@
+# PulpContainerClient::TagImage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **String** | A tag name | 
+**digest** | **String** | sha256 of the Manifest file | 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::TagImage.new(tag: null,
+                                 digest: null)
+```
+
+

data/docs/UnTagImage.md

@@ -0,0 +1,17 @@
+# PulpContainerClient::UnTagImage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **String** | A tag name | 
+
+## Code Sample
+
+```ruby
+require 'PulpContainerClient'
+
+instance = PulpContainerClient::UnTagImage.new(tag: 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_container_client/api/content_blobs_api.rb

@@ -0,0 +1,176 @@
+=begin
+#Pulp 3 API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.2-SNAPSHOT
+
+=end
+
+require 'cgi'
+
+module PulpContainerClient
+  class ContentBlobsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List blobs
+    # ViewSet for Blobs.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :digest Filter results where digest matches value
+    # @option opts [String] :digest__in Filter results where digest is in a comma-separated list of values
+    # @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] :media_type 
+    # @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] :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 [InlineResponse200]
+    def list(opts = {})
+      data, _status_code, _headers = list_with_http_info(opts)
+      data
+    end
+
+    # List blobs
+    # ViewSet for Blobs.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :digest Filter results where digest matches value
+    # @option opts [String] :digest__in Filter results where digest is in a comma-separated list of values
+    # @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] :media_type 
+    # @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] :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<(InlineResponse200, Integer, Hash)>] InlineResponse200 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: ContentBlobsApi.list ...'
+      end
+      # resource path
+      local_var_path = '/pulp/api/v3/content/container/blobs/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'digest'] = opts[:'digest'] if !opts[:'digest'].nil?
+      query_params[:'digest__in'] = opts[:'digest__in'] if !opts[:'digest__in'].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[:'media_type'] = opts[:'media_type'] if !opts[:'media_type'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'InlineResponse200' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic']
+
+      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: ContentBlobsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Inspect a blob
+    # ViewSet for Blobs.
+    # @param blob_href [String] URI of Blob. e.g.: /pulp/api/v3/content/container/blobs/1/
+    # @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 [ContainerBlob]
+    def read(blob_href, opts = {})
+      data, _status_code, _headers = read_with_http_info(blob_href, opts)
+      data
+    end
+
+    # Inspect a blob
+    # ViewSet for Blobs.
+    # @param blob_href [String] URI of Blob. e.g.: /pulp/api/v3/content/container/blobs/1/
+    # @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<(ContainerBlob, Integer, Hash)>] ContainerBlob data, response status code and response headers
+    def read_with_http_info(blob_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContentBlobsApi.read ...'
+      end
+      # verify the required parameter 'blob_href' is set
+      if @api_client.config.client_side_validation && blob_href.nil?
+        fail ArgumentError, "Missing the required parameter 'blob_href' when calling ContentBlobsApi.read"
+      end
+      # resource path
+      local_var_path = '{blob_href}'.sub('{' + 'blob_href' + '}', CGI.escape(blob_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] || 'ContainerBlob' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic']
+
+      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: ContentBlobsApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end