RETIRED, API documentation generator and builder for OpenStack
Go to file
Andreas Jaeger 42ea9b9bc2 Fix gitreview file
The file should point to the correct repo name which is openstack and
not anymore stackforge.

Change-Id: I9bca1ddbc1ef74dcbc21d9a12a896678b0bc4d83
2016-01-11 18:26:42 +00:00
doc/source Fills out outline for how-to and concept articles in API Guides 2015-12-02 10:40:27 -06:00
fairy_slipper Fix pep8 violations 2016-01-09 18:35:23 +00:00
public Fix for issue #43, processing of 2015-12-02 16:06:37 -05:00
tools Filling out usage docs further 2015-12-01 17:04:17 -06:00
.bowerrc Implemented Initial Prototype 2015-07-24 08:29:52 +10:00
.coveragerc Removed unrecognised section from coveragerc 2015-09-27 09:50:47 +10:00
.gitignore Updates for generating valid swagger. 2016-01-06 16:48:18 -05:00
.gitreview Fix gitreview file 2016-01-11 18:26:42 +00:00
.mailmap Implemented Initial Prototype 2015-07-24 08:29:52 +10:00
.testr.conf Implemented Initial Prototype 2015-07-24 08:29:52 +10:00
.travis.yml Moved back with explicit path for executable 2015-09-10 08:43:45 +10:00
CONTRIBUTING.rst Implemented Initial Prototype 2015-07-24 08:29:52 +10:00
Gruntfile.js Implemented Initial Prototype 2015-07-24 08:29:52 +10:00
HACKING.rst Implemented Initial Prototype 2015-07-24 08:29:52 +10:00
LICENSE Implemented Initial Prototype 2015-07-24 08:29:52 +10:00
MANIFEST.in Implemented Initial Prototype 2015-07-24 08:29:52 +10:00
README.rst Add run_server.sh script 2015-08-13 07:32:39 +10:00
babel.cfg Implemented Initial Prototype 2015-07-24 08:29:52 +10:00
bower.json Removed dependency on angular-swagger-ui 2015-09-20 14:50:15 +10:00
config.py PEP8 Fixes 2015-09-02 18:20:59 +10:00
fairy_slipper.wsgi Implemented Initial Prototype 2015-07-24 08:29:52 +10:00
karma.conf.js Increase the karma timeout 2015-09-27 12:41:03 +10:00
migrate.sh Updates for generating valid swagger. 2016-01-06 16:48:18 -05:00
openstack-common.conf Implemented Initial Prototype 2015-07-24 08:29:52 +10:00
package.json Initial implementation of schema rendering 2015-09-09 21:37:38 +10:00
requirements.txt Updates requirements.txt for PBR error and adds xsd:base64binary 2015-08-17 21:57:12 -05:00
run_server.sh Add bower to run_server.sh script 2015-08-20 21:46:40 +10:00
run_tests.sh Added run_tests.sh script 2015-09-10 09:05:26 +10:00
setup.cfg Updates for generating valid swagger. 2016-01-06 16:48:18 -05:00
setup.py Implemented Initial Prototype 2015-07-24 08:29:52 +10:00
test-requirements.txt Test without pytest 2015-08-14 08:25:23 +10:00
tox.ini Moved back with explicit path for executable 2015-09-10 08:43:45 +10:00

README.rst

fairy-slipper

A project to make OpenStack API's self documententing.

Features

  • TODO

Development

First run the migrate script to initially migrate the content from wadl:

./migrate.sh

This script will checkout the current version of the documentation.

To run the webserver use:

./run_server.sh

A Pecan based webserver will then listen on http://127.0.0.1:8080

AngularJS

To develop the AngularJS component, it's easiest if you use the grunt webserver:

grunt

You will still need to run the Fairy-Slipper webserver, but this will enable auto reloading if you visit the port http://127.0.0.1:9000

Directory Structure (Future)

Current documentation layout:

api-doc/ -- the root of the documentation
api-doc/index.json  -- the index file that lists all the files that are included in the API doc.
api-doc/<service>/<version>.rst
api-doc/<service>/<version>/<request_schema>.json
api-doc/<service>/<version>/<response_schema>_<status_code>.json
api-doc/<service>/<version>/examples/<request>_req.json
api-doc/<service>/<version>/examples/<response>_resp_<status_code>.json

Other Swagger UIs

Taken from https://github.com/swagger-api/swagger-spec/wiki/Sites-and-Services

Other API documentation Tools

Alternative Clients

Other Useful Tools