fuel api documentation
Bug #1375913 reported by
Roman Rufanov
This bug affects 1 person
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| Fuel for OpenStack |
Confirmed
|
Low
|
Fuel Documentation Team | ||
Bug Description
The Fuel REST API documentation is not detailed enough.
We need to provide usage examples, schema description for each call (please see attachment with examples).
Revision history for this message
| Roman Rufanov (rrufanov) wrote | #1 |
| Changed in fuel: | |
| milestone: | none → 6.0 |
| assignee: | nobody → Fuel Documentation Team (fuel-docs) |
| importance: | Undecided → High |
Revision history for this message
| Alexander Kislitsky (akislitsky) wrote | #2 |
| tags: | added: docs |
| Changed in fuel: | |
| status: | New → Confirmed |
| importance: | High → Medium |
| Changed in fuel: | |
| milestone: | 6.0 → 6.1 |
| Changed in fuel: | |
| milestone: | 6.1 → 7.0 |
| Changed in fuel: | |
| milestone: | 7.0 → 8.0 |
| tags: | added: area-docs |
| Changed in fuel: | |
| importance: | Medium → Low |
To post a comment you must log in.
We have changeset on review for JSON schema validation in Nailgun API: https:/
Schemas added for Node and NodeCollection handlers.
We are planning to use JSON schemas for automatic API documentation generation by Sphinx.