pulp_cookbook_client

PulpCookbookClient - the Ruby gem for the Pulp 3 API

Fetch, Upload, Organize, and Distribute Software Packages

This SDK is automatically generated by the OpenAPI Generator project:

• API version: v3
• Package version: 0.1.0b10.dev1674790537
• Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://pulpproject.org

Installation

Build a gem

To build the Ruby code into a gem:

gem build pulp_cookbook_client.gemspec

Then either install the gem locally:

gem install ./pulp_cookbook_client-0.1.0b10.dev1674790537.gem

(for development, run gem install --dev ./pulp_cookbook_client-0.1.0b10.dev1674790537.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 'pulp_cookbook_client', '~> 0.1.0b10.dev1674790537'

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 'pulp_cookbook_client', :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 'pulp_cookbook_client'

# Setup authorization
PulpCookbookClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'
end

api_instance = PulpCookbookClient::ContentCookbooksApi.new
name = 'name_example' # String | name of the cookbook
opts = {
  repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
  artifact: 'artifact_example', # String | Artifact file representing the physical content
  upload: 'upload_example', # String | An uncommitted upload that may be turned into the artifact of the content unit.
  version: 'version_example' # String | version of the cookbook
}

begin
  #Create a cookbook package content
  result = api_instance.create(name, opts)
  p result
rescue PulpCookbookClient::ApiError => e
  puts "Exception when calling ContentCookbooksApi->create: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://pulp

Class	Method	HTTP request	Description
PulpCookbookClient::ContentCookbooksApi	create	POST /pulp/api/v3/content/cookbook/cookbooks/	Create a cookbook package content
PulpCookbookClient::ContentCookbooksApi	list	GET /pulp/api/v3/content/cookbook/cookbooks/	List cookbook package contents
PulpCookbookClient::ContentCookbooksApi	read	GET cookbook_cookbook_package_content_href	Inspect a cookbook package content
PulpCookbookClient::DistributionsCookbookApi	create	POST /pulp/api/v3/distributions/cookbook/cookbook/	Create a cookbook distribution
PulpCookbookClient::DistributionsCookbookApi	delete	DELETE cookbook_cookbook_distribution_href	Delete a cookbook distribution
PulpCookbookClient::DistributionsCookbookApi	list	GET /pulp/api/v3/distributions/cookbook/cookbook/	List cookbook distributions
PulpCookbookClient::DistributionsCookbookApi	partial_update	PATCH cookbook_cookbook_distribution_href	Update a cookbook distribution
PulpCookbookClient::DistributionsCookbookApi	read	GET cookbook_cookbook_distribution_href	Inspect a cookbook distribution
PulpCookbookClient::DistributionsCookbookApi	update	PUT cookbook_cookbook_distribution_href	Update a cookbook distribution
PulpCookbookClient::PublicationsCookbookApi	create	POST /pulp/api/v3/publications/cookbook/cookbook/	Create a cookbook publication
PulpCookbookClient::PublicationsCookbookApi	delete	DELETE cookbook_cookbook_publication_href	Delete a cookbook publication
PulpCookbookClient::PublicationsCookbookApi	list	GET /pulp/api/v3/publications/cookbook/cookbook/	List cookbook publications
PulpCookbookClient::PublicationsCookbookApi	read	GET cookbook_cookbook_publication_href	Inspect a cookbook publication
PulpCookbookClient::RemotesCookbookApi	create	POST /pulp/api/v3/remotes/cookbook/cookbook/	Create a cookbook remote
PulpCookbookClient::RemotesCookbookApi	delete	DELETE cookbook_cookbook_remote_href	Delete a cookbook remote
PulpCookbookClient::RemotesCookbookApi	list	GET /pulp/api/v3/remotes/cookbook/cookbook/	List cookbook remotes
PulpCookbookClient::RemotesCookbookApi	partial_update	PATCH cookbook_cookbook_remote_href	Update a cookbook remote
PulpCookbookClient::RemotesCookbookApi	read	GET cookbook_cookbook_remote_href	Inspect a cookbook remote
PulpCookbookClient::RemotesCookbookApi	update	PUT cookbook_cookbook_remote_href	Update a cookbook remote
PulpCookbookClient::RepositoriesCookbookApi	create	POST /pulp/api/v3/repositories/cookbook/cookbook/	Create a cookbook repository
PulpCookbookClient::RepositoriesCookbookApi	delete	DELETE cookbook_cookbook_repository_href	Delete a cookbook repository
PulpCookbookClient::RepositoriesCookbookApi	list	GET /pulp/api/v3/repositories/cookbook/cookbook/	List cookbook repositorys
PulpCookbookClient::RepositoriesCookbookApi	modify	POST cookbook_cookbook_repository_hrefmodify/	Modify Repository Content
PulpCookbookClient::RepositoriesCookbookApi	partial_update	PATCH cookbook_cookbook_repository_href	Update a cookbook repository
PulpCookbookClient::RepositoriesCookbookApi	read	GET cookbook_cookbook_repository_href	Inspect a cookbook repository
PulpCookbookClient::RepositoriesCookbookApi	sync	POST cookbook_cookbook_repository_hrefsync/
PulpCookbookClient::RepositoriesCookbookApi	update	PUT cookbook_cookbook_repository_href	Update a cookbook repository
PulpCookbookClient::RepositoriesCookbookVersionsApi	delete	DELETE cookbook_cookbook_repository_version_href	Delete a repository version
PulpCookbookClient::RepositoriesCookbookVersionsApi	list	GET cookbook_cookbook_repository_hrefversions/	List repository versions
PulpCookbookClient::RepositoriesCookbookVersionsApi	read	GET cookbook_cookbook_repository_version_href	Inspect a repository version
PulpCookbookClient::RepositoriesCookbookVersionsApi	repair	POST cookbook_cookbook_repository_version_hrefrepair/

Documentation for Models

• PulpCookbookClient::AsyncOperationResponse
• PulpCookbookClient::ContentSummaryResponse
• PulpCookbookClient::CookbookCookbookDistribution
• PulpCookbookClient::CookbookCookbookDistributionResponse
• PulpCookbookClient::CookbookCookbookPackageContent
• PulpCookbookClient::CookbookCookbookPackageContentResponse
• PulpCookbookClient::CookbookCookbookPublication
• PulpCookbookClient::CookbookCookbookPublicationResponse
• PulpCookbookClient::CookbookCookbookRemote
• PulpCookbookClient::CookbookCookbookRemoteResponse
• PulpCookbookClient::CookbookCookbookRemoteResponseHiddenFields
• PulpCookbookClient::CookbookCookbookRepository
• PulpCookbookClient::CookbookCookbookRepositoryResponse
• PulpCookbookClient::PaginatedRepositoryVersionResponseList
• PulpCookbookClient::PaginatedcookbookCookbookDistributionResponseList
• PulpCookbookClient::PaginatedcookbookCookbookPackageContentResponseList
• PulpCookbookClient::PaginatedcookbookCookbookPublicationResponseList
• PulpCookbookClient::PaginatedcookbookCookbookRemoteResponseList
• PulpCookbookClient::PaginatedcookbookCookbookRepositoryResponseList
• PulpCookbookClient::PatchedcookbookCookbookDistribution
• PulpCookbookClient::PatchedcookbookCookbookRemote
• PulpCookbookClient::PatchedcookbookCookbookRepository
• PulpCookbookClient::PolicyEnum
• PulpCookbookClient::Repair
• PulpCookbookClient::RepositoryAddRemoveContent
• PulpCookbookClient::RepositorySyncURL
• PulpCookbookClient::RepositoryVersionResponse

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication