This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

A project to make OpenStack API's self documententing.

Project Description

A project to make OpenStack API’s self documententing.

Features

  • Migrates WADL source to Swagger files
  • Provides display of RST plus Swagger JSON files in a web browser

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 output 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
conversion_files_valid/<service-version>.json -- valid Swagger files

Other API documentation Tools

Other Useful Tools

Release History

Release History

This version
History Node

0.2.0

History Node

0.1.0

History Node

0.0.1.dev136

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
fairy_slipper-0.2.0-py2-none-any.whl (73.1 kB) Copy SHA256 Checksum SHA256 py2 Wheel Mar 11, 2016
fairy-slipper-0.2.0.tar.gz (88.2 kB) Copy SHA256 Checksum SHA256 Source Mar 11, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting