Bug 1434056 - Placeholders for product name is not rendered in API documentation
Summary: Placeholders for product name is not rendered in API documentation
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 4.1.0
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ovirt-4.2.0
: 4.2.0
Assignee: Juan Hernández
QA Contact: Lukas Svaty
URL:
Whiteboard:
Depends On:
Blocks: 1445943
TreeView+ depends on / blocked
 
Reported: 2017-03-20 15:59 UTC by Lukas Bednar
Modified: 2019-05-07 12:49 UTC (History)
10 users (show)

Fixed In Version:
Doc Type: No Doc Update
Doc Text:
undefined
Clone Of:
: 1445943 (view as bug list)
Environment:
Last Closed: 2018-05-17 01:04:34 UTC
oVirt Team: Infra
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
oVirt gerrit 74422 0 master MERGED restapi: Avoid place holders that aren't replaced 2017-03-22 15:28:20 UTC
oVirt gerrit 74519 0 ovirt-engine-4.1 MERGED restapi: Avoid place holders that aren't replaced 2017-03-23 08:45:42 UTC

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


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