2ab480d970
- Moves detailed info to the Compute API v2 WADL itself - Alleviates the following issues: * Params are not documented in this output due to tooling * When a WADL was broken, this deliverable breaks also * WADL contributions are low * It's difficult to train contributors how to embed WADL references Change-Id: Id56da05c0409ed432dfdd0f5de799f5ed5e2e47c
Compute API
This repository contains the RESTful API information for the OpenStack Compute project, also known as Nova. The Nova project provides open source cloud management and orchestration services.
Prerequisites
Apache Maven must be installed to build the documentation.
To install Maven 3 for Ubuntu 12.04 and later,and Debian wheezy and later:
apt-get install mavenOn Fedora 15 and later:
yum install maven3Building
The manuals are in the incubation,
openstack-compute-api-1.0 and
openstack-compute-api-2 directories.
To build a specific guide, look for a pom.xml file
within a subdirectory, then run the mvn command in that
directory. For example:
cd openstack-compute-api-2
mvn clean generate-sourcesTesting of changes and building of the manual
Install the python tox package and run tox from the
top-level directory to use the same tests that are done as part of our
Jenkins gating jobs.
If you like to run individual tests, run:
tox -e checkniceness- to run the niceness teststox -e checksyntax- to run syntax checkstox -e checkdeletions- to check that no deleted files are referencedtox -e checkbuild- to actually build the manual
tox will use the openstack-doc-tools package for execution of these tests. openstack-doc-tools has a requirement on maven for the build check.
Contributing
Our community welcomes all people interested in open source cloud computing, and there are no formal membership requirements. The best way to join the community is to talk with others online or at a meetup and offer contributions through Launchpad, the OpenStack wiki, or blogs. We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.
Installing
Refer to http://docs.openstack.org to learn more about installing an OpenStack Compute server that can respond to these API commands.