crx_packmgr_api_client

CrxPackageManager - the Ruby gem for the CRX Package Manager API

API for interacting with the CRX Package Manager in AEM.

This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.0
Package version: 0.1.0
Build date: 2016-11-23T23:44:11.263-06:00
Build package: class io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build crx_packmgr_api_client.gemspec

Then either install the gem locally:

gem install ./crx_packmgr_api_client-0.1.0.gem

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

Install from Git

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

gem 'crx_packmgr_api_client', :git => 'https://github.com/bstopp/crx_packmgr_api_client.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 'crx_packmgr_api_client'

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

api_instance = CrxPackageManager::DefaultApi.new

opts = { 
  q: "q_example", # String | Term to search within package names.
  include_versions: true, # BOOLEAN | Include versions of package in results.
  path: "path_example" # String | The path to a specific package definition.
}

begin
  #List all available packages.
  result = api_instance.list(opts)
  p result
rescue CrxPackageManager::ApiError => e
  puts "Exception when calling DefaultApi->list: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost:4502/crx/packmgr

Class	Method	HTTP request	Description
CrxPackageManager::DefaultApi	list	GET /list.jsp	List all available packages.

Documentation for Models

Documentation for Authorization

basic

Type: HTTP basic authentication