Bug 1831956
| Summary: | RESTAPI javadoc contains malformed link around time zone representation | ||
|---|---|---|---|
| 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, lsvaty, mperina, oliel, omachace, pelauter |
| Target Milestone: | ovirt-4.4.2 | Keywords: | CodeChange, Reopened, ZStream |
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | No Doc Update | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | 1831954 | Environment: | |
| Last Closed: | 2020-09-23 16:11:10 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: | 1831949, 1831954, 1833327 | ||
| Bug Blocks: | 1831952 | ||
|
Description
Rolfe Dlugy-Hegwer
2020-05-06 02:20:58 UTC
*** This bug has been marked as a duplicate of bug 1831952 *** OK, reopening, this has nothing to do with ovirt-engine-api-explorer, the javadoc is generated from ovirt-engine-api-model Following the link provided in the bug description, it actually looks lie the reference to UTC is fine, not broken Can you please check again? Perhaps this pertains to an earlier version? Is the link formatted correctly? In other words, is it correctly enclosed in tags? See https://stackoverflow.com/questions/1082050/linking-to-an-external-url-in-javadoc The formatting is consistent with that of other links in ovirt-engine-api-model project. See the contents of the javadoc comment here:
https://github.com/oVirt/ovirt-engine-api-model/blob/2a844bdf96a4c225e16e4963794f588d1a61fc50/src/main/java/types/TimeZone.java#L41
Also, unless I'm missing something, it works in the document that you have mentioned:
https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.3/html-single/rest_api_guide/
Hi Ori. I put a temporary fix in the doc. I should have also added a note in the bug description saying: "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." To see the unfixed version, see: https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/html-single/rest_api_guide/index#types-time_zone This SE topic explains how to format URLs in JavaDoc: https://stackoverflow.com/questions/1082050/linking-to-an-external-url-in-javadoc It looks like we should enclose every URL in our Javadoc comments in an <a> element. For example: `<a href="https://en.wikipedia.org/wiki/Coordinated_Universal_Time">UTC</a>` The current practice of using naked URLs, shown here, fails. `Offset from https://en.wikipedia.org/wiki/Coordinated_Universal_Time[UTC].` Would you: 1) Search for and fix naked URLs throughout the JavaDoc accordingly? 2) Add a note to any guides or standards that recommends enclosing URLs in <a> tags? 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 The needinfo request[s] on this closed bug have been removed as they have been unresolved for 365 days |