No release in over 3 years
Low commit activity in last 3 years
API for interacting with the CRX Package Manager in AEM.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

~> 2.0
~> 1.3
 Project Readme

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: 6.2.0
  • Package version: 1.3.0
  • Build package: 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-1.3.0.gem

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

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/bstopp/crx-packmgr-api-client-gem, then add the following in the Gemfile:

gem 'crx_packmgr_api_client', :git => 'https://github.com/bstopp/crx-packmgr-api-client-gem.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 = { 
  path: 'path_example' # String | The path to the package to download.
}

begin
  #Download a package
  result = api_instance.download(opts)
  p result
rescue CrxPackageManager::ApiError => e
  puts "Exception when calling DefaultApi->download: #{e}"
end

Documentation for API Endpoints

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

Class Method HTTP request Description
CrxPackageManager::DefaultApi download GET /download.jsp Download a package
CrxPackageManager::DefaultApi groups GET /groups.jsp List package groups
CrxPackageManager::DefaultApi init GET /init.jsp Metadata
CrxPackageManager::DefaultApi installstatus GET /installstatus.jsp Package Installation Status
CrxPackageManager::DefaultApi list GET /list.jsp List packages
CrxPackageManager::DefaultApi screenshot GET /screenshot.jsp Get screenshot
CrxPackageManager::DefaultApi service_exec POST /service/exec.json/etc/packages/{group}/{name}-{version}.zip Generic operation service.
CrxPackageManager::DefaultApi service_get GET /service.jsp Generic operation service.
CrxPackageManager::DefaultApi service_post POST /service.jsp Generic operation service.
CrxPackageManager::DefaultApi thumbnail GET /thumbnail.jsp Get package thumbnail

Documentation for Models

Documentation for Authorization

basic

  • Type: HTTP basic authentication