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

Bug 1434056

Summary: Placeholders for product name is not rendered in API documentation
Product: Red Hat Enterprise Virtualization Manager Reporter: Lukas Bednar <lbednar>
Component: DocumentationAssignee: Juan Hernández <juan.hernandez>
Status: CLOSED CURRENTRELEASE QA Contact: Lukas Svaty <lsvaty>
Severity: low Docs Contact:
Priority: unspecified    
Version: 4.1.0CC: juan.hernandez, lbednar, lbopf, lsurette, mgoldboi, mperina, pstehlik, rbalakri, srevivo, ykaul
Target Milestone: ovirt-4.2.0Keywords: Triaged, ZStream
Target Release: 4.2.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: No Doc Update
Doc Text:
undefined
Story Points: ---
Clone Of:
: 1445943 (view as bug list) Environment:
Last Closed: 2018-05-17 01:04:34 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:
Bug Depends On:    
Bug Blocks: 1445943    

Description Lukas Bednar 2017-03-20 15:59:19 UTC
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:

Comment 3 Juan Hernández 2017-03-21 15:31:35 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.

Comment 5 Lucy Bopf 2017-03-24 01:01:16 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.

Comment 8 Lukas Svaty 2017-12-08 19:26:52 UTC
verified in rhvm-doc-4.2.0-0.1.master.201708301538.el7ev.noarch
ovirt-engine-4.2.0-0.5.master.el7.noarch