Giter VIP home page Giter VIP logo

crx-packmgr-api-client-gem's Introduction

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

crx-packmgr-api-client-gem's People

Contributors

bstopp avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

dodevops vrtdev

crx-packmgr-api-client-gem's Issues

Spec Tests

Complete the generated specs that have no test cases.

JSON dependency clashes with Puppet 5

The JSON library dependency (1.8) clashes with Puppet's Ruby bundling, which only supports the JSON library in version 2.0.

We tried the package with an updated dependency on our site and it works.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.