zest

Zest - the Ruby gem for the Pulp3 API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This SDK is automatically generated by the Swagger Codegen project:

• API version: v3
• Package version: 0.0.4
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build zest.gemspec

Then either install the gem locally:

gem install ./zest-0.0.4.gem

(for development, run gem install --dev ./zest-0.0.4.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'zest', '~> 0.0.4'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'zest', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'zest'

# Setup authorization
Zest.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Zest::PulpApi.new

data = Zest::Artifact.new # Artifact | 


begin
  result = api_instance.artifacts_create(data)
  p result
rescue Zest::ApiError => e
  puts "Exception when calling PulpApi->artifacts_create: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://zest-builder

Class	Method	HTTP request	Description
Zest::PulpApi	artifacts_create	POST /pulp/api/v3/artifacts/
Zest::PulpApi	artifacts_delete	DELETE artifact_href
Zest::PulpApi	artifacts_list	GET /pulp/api/v3/artifacts/
Zest::PulpApi	artifacts_read	GET artifact_href
Zest::PulpApi	content_file_files_create	POST /pulp/api/v3/content/file/files/
Zest::PulpApi	content_file_files_list	GET /pulp/api/v3/content/file/files/
Zest::PulpApi	content_file_files_read	GET file_content_href
Zest::PulpApi	distributions_create	POST /pulp/api/v3/distributions/
Zest::PulpApi	distributions_delete	DELETE distribution_href
Zest::PulpApi	distributions_list	GET /pulp/api/v3/distributions/
Zest::PulpApi	distributions_partial_update	PATCH distribution_href
Zest::PulpApi	distributions_read	GET distribution_href
Zest::PulpApi	distributions_update	PUT distribution_href
Zest::PulpApi	orphans_delete	DELETE /pulp/api/v3/orphans/
Zest::PulpApi	publications_delete	DELETE publication_href
Zest::PulpApi	publications_list	GET /pulp/api/v3/publications/
Zest::PulpApi	publications_read	GET publication_href
Zest::PulpApi	publishers_file_file_create	POST /pulp/api/v3/publishers/file/file/
Zest::PulpApi	publishers_file_file_delete	DELETE file_publisher_href
Zest::PulpApi	publishers_file_file_list	GET /pulp/api/v3/publishers/file/file/
Zest::PulpApi	publishers_file_file_partial_update	PATCH file_publisher_href
Zest::PulpApi	publishers_file_file_publish	POST file_publisher_hrefpublish/
Zest::PulpApi	publishers_file_file_read	GET file_publisher_href
Zest::PulpApi	publishers_file_file_update	PUT file_publisher_href
Zest::PulpApi	remotes_file_file_create	POST /pulp/api/v3/remotes/file/file/
Zest::PulpApi	remotes_file_file_delete	DELETE file_remote_href
Zest::PulpApi	remotes_file_file_list	GET /pulp/api/v3/remotes/file/file/
Zest::PulpApi	remotes_file_file_partial_update	PATCH file_remote_href
Zest::PulpApi	remotes_file_file_read	GET file_remote_href
Zest::PulpApi	remotes_file_file_sync	POST file_remote_hrefsync/
Zest::PulpApi	remotes_file_file_update	PUT file_remote_href
Zest::PulpApi	repositories_create	POST /pulp/api/v3/repositories/
Zest::PulpApi	repositories_delete	DELETE repository_href
Zest::PulpApi	repositories_list	GET /pulp/api/v3/repositories/
Zest::PulpApi	repositories_partial_update	PATCH repository_href
Zest::PulpApi	repositories_read	GET repository_href
Zest::PulpApi	repositories_update	PUT repository_href
Zest::PulpApi	repositories_versions_create	POST repository_hrefversions/
Zest::PulpApi	repositories_versions_delete	DELETE repository_version_href
Zest::PulpApi	repositories_versions_list	GET repository_hrefversions/
Zest::PulpApi	repositories_versions_partial_update	PATCH repository_version_href
Zest::PulpApi	repositories_versions_read	GET repository_version_href
Zest::PulpApi	repositories_versions_update	PUT repository_version_href
Zest::PulpApi	status_list	GET /pulp/api/v3/status/
Zest::PulpApi	tasks_cancel	POST task_hrefcancel/
Zest::PulpApi	tasks_delete	DELETE task_href
Zest::PulpApi	tasks_list	GET /pulp/api/v3/tasks/
Zest::PulpApi	tasks_read	GET task_href
Zest::PulpApi	uploads_create	POST /pulp/api/v3/uploads/
Zest::PulpApi	uploads_create_0	POST upload_href
Zest::PulpApi	uploads_read	GET /pulp/api/v3/uploads/
Zest::PulpApi	uploads_read_0	GET upload_href
Zest::PulpApi	uploads_update	PUT /pulp/api/v3/uploads/
Zest::PulpApi	uploads_update_0	PUT upload_href
Zest::PulpApi	workers_list	GET /pulp/api/v3/workers/
Zest::PulpApi	workers_read	GET worker_href

Documentation for Models

• Zest::Artifact
• Zest::AsyncOperationResponse
• Zest::Distribution
• Zest::FileContent
• Zest::FilePublisher
• Zest::FileRemote
• Zest::InlineResponse200
• Zest::InlineResponse2001
• Zest::InlineResponse2002
• Zest::InlineResponse2003
• Zest::InlineResponse2004
• Zest::InlineResponse2005
• Zest::InlineResponse2006
• Zest::InlineResponse2007
• Zest::InlineResponse2008
• Zest::InlineResponse2009
• Zest::ProgressReport
• Zest::Publication
• Zest::Repository
• Zest::RepositoryPublishURL
• Zest::RepositorySyncURL
• Zest::RepositoryVersion
• Zest::RepositoryVersionCreate
• Zest::Task
• Zest::Upload
• Zest::Worker

Documentation for Authorization

Basic

• Type: HTTP basic authentication