Description of problem: Hi, we need some option to link the follow parameter to ansible module documentation. Currently, the users don't know which arguments can be used in the follow. Version-Release number of selected component (if applicable): How reproducible: Steps to Reproduce: 1. 2. 3. Actual results: Expected results: Have documentation which we can link each object from ansible docs. Additional info:
$ git remote -v origin https://github.com/oVirt/ovirt-engine-api-metamodel.git (fetch) origin https://github.com/oVirt/ovirt-engine-api-metamodel.git (push) $ git tag --contains 8d8b529b13dc83af6d88ceeb2181905fd4f63a23 1.3.5 1.3.6 1.3.7
ovirt-engine-api-metamodel rpm is not available. It's currently bundled within ovirt-engine: git tag --contains a216da9fe7983d468e9686cc0c6058cdefca6080 ovirt-engine-4.5.0 ovirt-engine-4.5.0_alpha1 commit a216da9fe7983d468e9686cc0c6058cdefca6080 Author: Ori Liel <oliel> Date: Tue Nov 16 15:00:03 2021 +0200 bump model (4.5.1) and metamodel (1.3.7) Model changes since current version (4.5.0): * Bump metamodel version to 1.3.7 * Bumpy puppycrawl version to 8.29 * Document default network filter (https://bugzilla.redhat.com/1810032) Metamodel changes since current version (1.3.4) * Anchor Links-Summary table in adoc (https://bugzilla.redhat.com/1978582) Signed-off-by: Ori Liel <oliel> Change-Id: I8c58e28c2001704e7923dd88117383b6f1527f35
Some elaboration (for QE) The restapi user guide contains for each 'type' (vm, cluser, host...) a section named 'Links Summary'. For documentation purposes - more specifically, in order to better document the link-following feature - these sections had to be made anchors in the document. In other words it was requested that the user be able to land directly at them using elaborated URL addresses. The patch for this bugzilla did that, and the user-guide has been generated since then. So for example, it's now possible to see the links-summary table of a VM using this link: http://ovirt.github.io/ovirt-engine-api-model/4.5/#types/vm/links_summary I think sampling a few such instances and seeing that the guide is opened straight at the sought location would be verification enough.
We tried it with https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html/rest_api_guide/types_2#types-vm-links_summary and it works. This documentation is linked from RHV engine welcome page (Version 4.5.1-0.62.el8ev).
This bugzilla is included in oVirt 4.5.1 release, published on June 22nd 2022. Since the problem described in this bug report should be resolved in oVirt 4.5.1 release, it has been closed with a resolution of CURRENT RELEASE. If the solution does not work for you, please open a new bug report.