Bug 1346218
| Summary: | Include the API HTML documentation | ||
|---|---|---|---|
| Product: | [oVirt] ovirt-engine | Reporter: | Juan Hernández <juan.hernandez> |
| Component: | RestAPI | Assignee: | Juan Hernández <juan.hernandez> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Lukas Svaty <lsvaty> |
| Severity: | unspecified | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 4.0.0 | CC: | bugs, juwu, lsvaty, mperina |
| Target Milestone: | ovirt-4.0.0-rc | Flags: | rule-engine:
ovirt-4.0.0+
rule-engine: exception+ rule-engine: planning_ack+ juan.hernandez: devel_ack+ rule-engine: testing_ack+ |
| Target Release: | 4.0.0 | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| 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.
|
Story Points: | --- |
| Clone Of: | Environment: | ||
| Last Closed: | 2016-07-05 08:02:14 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | Infra | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
|
Description
Juan Hernández
2016-06-14 10:00:11 UTC
An example of the generated documentation is available here: https://jhernand.fedorapeople.org/ovirt-engine-api-model/model.html 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. 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. verified in ovirt-engine-restapi-4.0.0.6-0.1.el7ev.noarch oVirt 4.0.0 has been released, closing current release. |