API objects to generate sample data for the auto-documentation
Bug #1260337 reported by
Lucas Alvares Gomes
This bug affects 1 person
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Ironic |
Fix Released
|
Wishlist
|
Matt Wagner |
Bug Description
API-Objects should define sample() methods to provide sample data for generating the JSON and XML examples in the output of the auto-documentation.
e.g:
class Test(base.APIBase):
foo = wtypes.text
bar = wtypes.text
@classmethod
def sample(cls):
return cls(foo='fooo', bar='barz' )
Ceilometer already does it[1]
[1] https:/
Extra info:
To build the documentation do:
(venv)$ python setup.py build_sphinx
The output is at:
ironic/
Changed in ironic: | |
importance: | Undecided → Wishlist |
assignee: | nobody → Lucas Alvares Gomes (lucasagomes) |
description: | updated |
Changed in ironic: | |
assignee: | Lucas Alvares Gomes (lucasagomes) → Matt Wagner (matt-wagner) |
Changed in ironic: | |
assignee: | Matt Wagner (matt-wagner) → Devananda van der Veen (devananda) |
Changed in ironic: | |
assignee: | Devananda van der Veen (devananda) → nobody |
Changed in ironic: | |
assignee: | nobody → Matt Wagner (matt-wagner) |
Changed in ironic: | |
milestone: | none → icehouse-rc1 |
status: | Fix Committed → Fix Released |
Changed in ironic: | |
milestone: | icehouse-rc1 → 2014.1 |
To post a comment you must log in.
Fix proposed to branch: master /review. openstack. org/61752
Review: https:/