api icon indicating copy to clipboard operation
api copied to clipboard

Doc.: Many contradictory "Description: REQUIRED. ..." / "Required: No" rows

Open dsbos opened this issue 3 years ago • 2 comments

On the current Global Mesh Options page, there are many rows whose Description column value says "REQUIRED. ..." but whose Required column value says "No"--which certainly seems to be contradictory.

So ... are those rows' documented members (fields) required or not?

(If those two forms refer to two different levels of being required, that page should make that fact clear.)

dsbos avatar Jun 23 '21 18:06 dsbos

Since this page is generated in the istio/api repo, I'll move the PR there.

ericvn avatar Jun 23 '21 18:06 ericvn

fwiw the column comes from proto annotations vs docs comments. Agree this needs cleanup

howardjohn avatar May 14 '24 22:05 howardjohn