Bug 1346218 - Include the API HTML documentation
Summary: Include the API HTML documentation
Alias: None
Product: ovirt-engine
Classification: oVirt
Component: RestAPI
Version: 4.0.0
Hardware: Unspecified
OS: Unspecified
Target Milestone: ovirt-4.0.0-rc
: 4.0.0
Assignee: Juan Hernández
QA Contact: Lukas Svaty
Depends On:
TreeView+ depends on / blocked
Reported: 2016-06-14 10:00 UTC by Juan Hernández
Modified: 2016-07-06 05:59 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: Enhancement
Doc Text:
The API HTML documentation is now automatically generated and available from any live Manager from the /ovirt-engine/api/model URL.
Clone Of:
Last Closed: 2016-07-05 08:02:14 UTC
oVirt Team: Infra
rule-engine: ovirt-4.0.0+
rule-engine: exception+
rule-engine: planning_ack+
juan.hernandez: devel_ack+
rule-engine: testing_ack+

Attachments (Terms of Use)

System ID Private Priority Status Summary Last Updated
oVirt gerrit 59129 0 ovirt-engine-4.0 MERGED restapi: Add model HTML 2016-06-14 15:20:44 UTC

Description Juan Hernández 2016-06-14 10:00:11 UTC
Add the API HTML documentation to the server, so that it will be available for users in the /ovirt-engine/api/model.html URL.

Comment 1 Juan Hernández 2016-06-14 10:03:08 UTC
An example of the generated documentation is available here:


Comment 2 Juan Hernández 2016-06-14 10:07:45 UTC
I'm requesting the exception flag, because I think it would be good to have this documentation in 4.0, and the risk of the change is very low.

Comment 3 Juan Hernández 2016-06-20 08:17:49 UTC
Please note that the latest Red Hat downstream build doesn't include this capability. It was reverted because the required Maven plugin (the Asciidoctor plugin) wasn't available in the downstream build environment. So this can only be tested with the latest upstream build.

Comment 4 Lukas Svaty 2016-07-01 11:15:15 UTC
verified in ovirt-engine-restapi-

Comment 5 Sandro Bonazzola 2016-07-05 08:02:14 UTC
oVirt 4.0.0 has been released, closing current release.

Note You need to log in before you can comment on or make changes to this bug.