Bug 1849045 - Differences between apidoc and REST API documentation about exporting VMs and templates to OVA
Summary: Differences between apidoc and REST API documentation about exporting VMs and...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: ovirt-engine
Version: 4.3.9
Hardware: Unspecified
OS: Linux
unspecified
low
Target Milestone: ovirt-4.5.1
: 4.5.1
Assignee: Arik
QA Contact: Tamir
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-06-19 14:09 UTC by Juan Orti
Modified: 2023-10-06 20:43 UTC (History)
4 users (show)

Fixed In Version: ovirt-engine-4.5.1.2
Doc Type: No Doc Update
Doc Text:
Clone Of:
Environment:
Last Closed: 2022-07-14 12:54:30 UTC
oVirt Team: Virt
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github oVirt ovirt-engine-api-model pull 46 0 None Merged Document export template to ova 2022-04-26 14:05:32 UTC
Github oVirt ovirt-engine-api-model pull 46/ 0 None None None 2022-04-20 16:06:40 UTC
Red Hat Issue Tracker RHV-36692 0 None None None 2022-04-19 19:03:51 UTC
Red Hat Knowledge Base (Solution) 5170741 0 None None None 2020-06-19 14:09:58 UTC
Red Hat Product Errata RHSA-2022:5555 0 None None None 2022-07-14 12:55:15 UTC

Description Juan Orti 2020-06-19 14:09:59 UTC
In RHV Manager you can browse the apidoc reference:

https://rhvm.example.com/ovirt-engine/apidoc/#/requests

To export VMs or templates to OVA, in the apidoc site there's the reference to the 'topathonhost' method, but in the official documentation that method is not listed. Instead the official documentation lists the 'export' method, so both references appear to not be synced.

https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.3/html/rest_api_guide/services#services-template-methods-export

https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.3/html/rest_api_guide/services#services-vm-methods-export

Also, Comparing the 'export' method for VMs and templates, it's not clear if the templates can be exported to OVA files indicating a host, directory and filename (it's possible).

Comment 1 Marina Kalinin 2022-04-19 18:58:49 UTC
Hi Arik,
Can you please take a look and see if RHV 4.4 documentation is correct or anything needs to be adjusted.
Thank you!

Comment 2 Arik 2022-04-20 15:59:13 UTC
(In reply to Juan Orti from comment #0)
> In RHV Manager you can browse the apidoc reference:
> 
> https://rhvm.example.com/ovirt-engine/apidoc/#/requests
> 
> To export VMs or templates to OVA, in the apidoc site there's the reference
> to the 'topathonhost' method, but in the official documentation that method
> is not listed. Instead the official documentation lists the 'export' method,
> so both references appear to not be synced.

This part seems to be fixed already, I don't see methods like 'topathonhost' in <engine-url>/ovirt-engine/apidoc/#/requests with the latest version of the engine anymore
 
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.3/
> html/rest_api_guide/services#services-template-methods-export
> 
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.3/
> html/rest_api_guide/services#services-vm-methods-export
> 
> Also, Comparing the 'export' method for VMs and templates, it's not clear if
> the templates can be exported to OVA files indicating a host, directory and
> filename (it's possible).

Yes, need to have a similar documentation for templates as well

Comment 7 Tamir 2022-06-19 10:40:58 UTC
The newly added documentation for templates are available in the link: https://{OVIRT-ENGINE-HOST}/ovirt-engine/apidoc/#services/template/methods/export
It looks good to me.

Verified on RHV 4.5.1-3.

Env:
    - Engine instance with RHV 4.5.1-3 (ovirt-engine-4.5.1.2-0.11.el8ev) and RHEL 8.6 installed.
    - 2 hosts with RHV 4.5.1-3 and RHEL 8.6 and with vdsm-4.50.1.3-1.el8ev.

Comment 11 errata-xmlrpc 2022-07-14 12:54:30 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Moderate: RHV Manager (ovirt-engine) [ovirt-4.5.1] security, bug fix and update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2022:5555

Comment 12 meital avital 2022-07-18 16:49:33 UTC
Due to QE capacity we are not going to cover this issue in our automation


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