Bug 1831949

Summary:	RESTAPI javadoc contains missing information about assigning IP address to NIC
Product:	Red Hat Enterprise Virtualization Manager	Reporter:	Rolfe Dlugy-Hegwer <rdlugyhe>
Component:	ovirt-engine	Assignee:	Ori Liel <oliel>
Status:	CLOSED ERRATA	QA Contact:	Lucie Leistnerova <lleistne>
Severity:	low	Docs Contact:
Priority:	low
Version:	4.3.9	CC:	emarcus, lleistne, mperina, oliel, pelauter
Target Milestone:	ovirt-4.4.2	Keywords:	CodeChange, ZStream
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	No Doc Update
Doc Text:		Story Points:	---
Clone Of:
Clones:	1831952 1831954 (view as bug list)		Environment:
Last Closed:	2020-09-23 16:11:04 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:	1831952, 1831954, 1831956, 1833327

Description Rolfe Dlugy-Hegwer 2020-05-06 01:57:29 UTC

Description of problem:

Javadoc contains a malformed link:

```
=== BootProtocol [small]#enum#

Defines the options of the IP address assignment method to a NIC.

.Values summary
[cols="20,80"]
|===
|Name |Summary

|`autoconf`
|Stateless address auto-configuration.

|`dhcp`
|Dynamic host configuration protocol.

|`none`
|No address configuration.

|`poly_dhcp_autoconf`
|DHCP alongside Stateless address auto-configuration (SLAAC)

The SLAAC mechanism is defined by http://tools. <<<<<<<<<<HERE
```

The link should be: http://tools.ietf.org/html/rfc4862[RFC 4862].


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

How reproducible:
100%

Steps to Reproduce:
1.Open https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.3/html-single/rest_api_guide/index#types-boot_protocol


Actual results:

Link says "http://tools."

Expected results:

The link should say "RFC 4862", and link to http://tools.ietf.org/html/rfc4862 

Additional info:

I am putting a temporary fix in the doc that will be erased next time we regenerate the API doc from the code. You must fix this in the source code.
Don't be fooled if you look at the current doc and it seems to be fixed.

Comment 1 Ori Liel 2020-05-21 07:14:51 UTC

The contents in the provided link in reproduction steps actually seems ok. I don't see the bug

see: https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.3/html-single/rest_api_guide/index#types-boot_protocol

perhaps the bug should be on an earlier version?

Comment 2 Rolfe Dlugy-Hegwer 2020-05-26 12:55:28 UTC

Hi Ori. I anticipated this might happen. I put a temporary fix in the doc and made a note in the description, which says: "I am putting a temporary fix in the doc that will be erased next time we regenerate the API doc from the code. You must fix this in the source code.
Don't be fooled if you look at the current doc and it seems to be fixed."

If you want to see the "bad" version, ctrl+f search for "by http://tools." the 4.2 doc here: https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/html-single/rest_api_guide/index#types-boot_protocol

I'm not sure how to format/fix this in the JavaDoc comments so the URL renders correctly. 
This SE topic seems address that question: https://stackoverflow.com/questions/1082050/linking-to-an-external-url-in-javadoc

Comment 3 Rolfe Dlugy-Hegwer 2020-05-26 13:58:22 UTC

Please enclose the URL in <a> tags.
For details, see https://stackoverflow.com/questions/1082050/linking-to-an-external-url-in-javadoc

Comment 12 errata-xmlrpc 2020-09-23 16:11:04 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: Red Hat Virtualization security, bug fix, and enhancement 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-2020:3807