Bugzilla will be upgraded to version 5.0. The upgrade date is tentatively scheduled for 2 December 2018, pending final testing and feedback.
First Last Prev Next    This bug is not in your last search results.
Bug 1346218 - Include the API HTML documentation
Include the API HTML documentation
Status: CLOSED CURRENTRELEASE
Product: ovirt-engine
Classification: oVirt
Component: RestAPI (Show other bugs)
4.0.0
Unspecified Unspecified
unspecified Severity unspecified (vote)
: ovirt-4.0.0-rc
: 4.0.0
Assigned To: Juan Hernández
Lukas Svaty
:
Depends On:
Blocks:
  Show dependency tree / graph
 
Reported: 2016-06-14 06:00 EDT by Juan Hernández
Modified: 2016-07-06 01:59 EDT (History)
4 users (show)

See Also:
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 04:02:14 EDT
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Category: ---
oVirt Team: Infra
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---
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)
Add an attachment (proposed patch, testcase, etc.)


External Trackers
Tracker ID Priority Status Summary Last Updated
oVirt gerrit 59129 ovirt-engine-4.0 MERGED restapi: Add model HTML 2016-06-14 11:20 EDT

  None (edit)
Description Juan Hernández 2016-06-14 06:00:11 EDT 
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 06:03:08 EDT 
An example of the generated documentation is available here:

  https://jhernand.fedorapeople.org/ovirt-engine-api-model/model.html
Comment 2 Juan Hernández 2016-06-14 06:07:45 EDT 
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 04:17:49 EDT 
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 07:15:15 EDT 
verified in ovirt-engine-restapi-4.0.0.6-0.1.el7ev.noarch
Comment 5 Sandro Bonazzola 2016-07-05 04:02:14 EDT 
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.
First Last Prev Next    This bug is not in your last search results.