Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1445943

Summary: [downstream clone - 4.1.2] Placeholders for product name is not rendered in API documentation
Product: Red Hat Enterprise Virtualization Manager Reporter: rhev-integ
Component: ovirt-engineAssignee: Juan Hernández <juan.hernandez>
Status: CLOSED ERRATA QA Contact: Lukas Svaty <lsvaty>
Severity: low Docs Contact:
Priority: unspecified    
Version: 4.1.0CC: juan.hernandez, lbednar, lbopf, lsurette, mgoldboi, mperina, pstehlik, rbalakri, Rhev-m-bugs, srevivo, ykaul
Target Milestone: ovirt-4.1.2Keywords: ZStream
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: 1434056 Environment:
Last Closed: 2017-05-24 11:23:26 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: Infra RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On: 1434056    
Bug Blocks:    

Description rhev-integ 2017-04-26 21:01:18 UTC
+++ This bug is a downstream clone. The original bug is: +++
+++   bug 1434056 +++
======================================================================

Description of problem:

In documentation of RHV API, the placeholders are not rendered.
I could find at least these two:

{product-name}
{engine-name}

Version-Release number of selected component (if applicable):

rhv-release-4.1.1-6-001.noarch.rpm

How reproducible:

Install engine and access API documentation from browser.


Steps to Reproduce:
1. Install engine
2. Access API doc from browser https://{YOUR_ENGINE}/ovirt-engine/api/model.html#_basic_authentication
3. Read doc and note that you can read {product-name} in the text instead of RHV

Actual results:

I can read following text in the doc:

Basic authentication is supported only for backwards compatibility; it is deprecated since version 4.0 of {product-name}, and will be removed in the future. 

Expected results:

I would like to read RHV instead of {product-name}

Basic authentication is supported only for backwards compatibility; it is deprecated since version 4.0 of RHV, and will be removed in the future. 

Additional info:

(Originally by Lukas Bednar)

Comment 4 rhev-integ 2017-04-26 21:01:36 UTC
The proposed patch should fix this issue.

Note that /ovirt-engine/api/model is deprecated in 4.1, use /ovirt-engine/apidoc instead, it doesn't require authentication and provides the same information, without this issue.

I suggest to fix this for 4.1.2.

(Originally by juan.hernandez)

Comment 6 rhev-integ 2017-04-26 21:01:43 UTC
I can confirm that I don't see this issue in the document we published to the Customer Portal, so I don't think there is anything to do on the documentation team's side.

(Originally by Lucy Bopf)

Comment 7 Martin Perina 2017-05-11 12:57:29 UTC
Moving to ovirt-engine component as the fix is contained in engine, this way we can attach it to engine errata

Comment 9 Lukas Svaty 2017-05-15 16:02:46 UTC
verified in ovirt-engine-4.1.2.2-0.1.el7.noarch

Comment 11 errata-xmlrpc 2017-05-24 11:23:26 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, 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/RHEA-2017:1280