Skip to content

ManageIQ/manageiq-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
Aug 30, 2018
Oct 31, 2017
Sep 15, 2017
Aug 30, 2018
Aug 7, 2017
Aug 29, 2018
Aug 30, 2018
Aug 7, 2017
Nov 2, 2017
Aug 7, 2017
Aug 7, 2017
Aug 7, 2017
Aug 7, 2017
Jan 9, 2018
May 17, 2018
Nov 20, 2017
Aug 29, 2018
Nov 1, 2017
Sep 15, 2017
Aug 7, 2017
Jan 8, 2018
Aug 7, 2017
Oct 12, 2017

Repository files navigation

ManageIQ::Api

ManageIQ::Api is a plugin to be used in the ManageIQ project. It forms the public REST API for ManageIQ.

Gem Version Build Status Code Climate Test Coverage Dependency Status Security

Chat

Contributing

Prerequisites

It is assumed you have met all prerequisites for installing the ManageIQ app, as described here

Setup

First, fork/clone the project, ideally in the same directory where you store the main ManageIQ app:

git clone [email protected]:username/manageiq-api.git

Next, run the setup script:

bin/setup

This should be sufficient to meet all development dependencies, and is to be run only once the first time you setup the plugin. During development, if you need to update the dependencies you can do so by running:

bin/update

For more details on the development setup for the ManageIQ ecosystem, please refer to the general guide.

Running the tests

To run the entire suite:

bundle exec rake

Or, to run an individual test:

bundle exec rspec spec/path/to/spec.rb:<line number>

Development

Generally development is done by pointing your local clone of the ManageIQ app to your local branch of the plugin, as described in this section of the general developer setup guide.

Submitting a pull request

Please read CONTRIBUTING.md for more details on creating and submitting a pull request to ManageIQ::Api.

License

See LICENSE.txt.