Difference between revisions of "Neutron/API/WADL"
< Neutron
| Line 2: | Line 2: | ||
= Quantum API WADL Specification = | = Quantum API WADL Specification = | ||
[https://blueprints.launchpad.net/quantum/+spec/quantum-api-wadl blueprint link] | [https://blueprints.launchpad.net/quantum/+spec/quantum-api-wadl blueprint link] | ||
| + | |||
| + | == Resources == | ||
| + | * http://www.w3.org/Submission/wadl/ | ||
| + | * http://code.w3.org/unicorn/attachment/wiki/how_to_write_new_contract/css-validator.wadl | ||
== Scope == | == Scope == | ||
Revision as of 08:05, 4 December 2012
Quantum API WADL Specification
Resources
- http://www.w3.org/Submission/wadl/
- http://code.w3.org/unicorn/attachment/wiki/how_to_write_new_contract/css-validator.wadl
Scope
Provide WADL documents for the Quantum API.
Use Cases
- [Short overview and high level description of what the blueprint is trying to achieve.]
Implementation Overview
Write a python script in quantum/tools/wadl/generate_wadl.py
- Traverse modules in quantum.api and quantum.extension and reads RESOURCE_ATTRIBUTE_MAP definitions
- Automatically generate WADL documents (core.xml, [extention].xml, etc.) files in quantum/doc/wadl/
Data Model Changes
N/A
Configuration variables
N/A
API's
N/A
Plugin Interface
N/A
Required Plugin support
N/A
Dependencies
xml
- [List of python packages and/or OpenStack components? (If applicable)]
CLI Requirements
N/A
Horizon Requirements
N/A
Usage Example
- [How to run/use/interface with the new feature. (If applicable)]
Test Cases
- [Description of various test cases. (If applicable)]
