Bug 2046186 - A TODO text block in the API browser
Summary: A TODO text block in the API browser
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat OpenShift Data Foundation
Classification: Red Hat Storage
Component: ocs-operator
Version: 4.10
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ---
: ODF 4.10.0
Assignee: Nitin Goyal
QA Contact: Amrita Mahapatra
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-01-26 10:56 UTC by RY
Modified: 2023-08-09 17:00 UTC (History)
9 users (show)

Fixed In Version: 4.10.0-132
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2022-04-13 18:51:56 UTC
Embargoed:

Attachments (Terms of Use)
A TODO section in the docs block (302.84 KB, image/png)
2022-01-26 10:56 UTC, RY 		no flags Details
View All


Links
System ID Private Priority Status Summary Last Updated
Github red-hat-storage ocs-operator pull 1463 0 None open api: move the TODO line above so it does not show up in the description 2022-01-28 07:10:02 UTC
Github red-hat-storage ocs-operator pull 1464 0 None open Bug 2046186:[release-4.10] api: move the TODO line above so it does not show up in the description 2022-01-28 09:16:15 UTC
Red Hat Product Errata RHSA-2022:1372 0 None None None 2022-04-13 18:52:08 UTC

Description RY 2022-01-26 10:56:49 UTC 
Created attachment 1855493 [details]
A TODO section in the docs block

Description of problem:


Seem like some of the API comments from the code 
are leaked to the API browser. (see attachment)
Comment 1 Jakub Hadvig 2022-01-27 20:48:04 UTC 
So Im debating if this really is an bug, since the TODO is in comments.
@Sam any thoughts?
Comment 2 Samuel Padgett 2022-01-27 21:00:23 UTC 
I would transition this bug to ODF so that they can remove the TODO from the Godoc. Console is working correctly. They've simply included the TODO in their doc comment :)
Comment 3 Jakub Hadvig 2022-01-28 06:52:23 UTC 
Based on the conversation to odf-operator
Comment 5 Nitin Goyal 2022-01-28 06:57:46 UTC 
Moving it to the ocs-operator as it is storageCluster API
Comment 13 errata-xmlrpc 2022-04-13 18:51:56 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 (Important: Red Hat OpenShift Data Foundation 4.10.0 enhancement, security & bug fix 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-2022:1372
Note You need to log in before you can comment on or make changes to this bug.