Company
Date Published
Author
Adam Altman
Word count
475
Language
-
Hacker News points
None

Summary

The text discusses the option of hiding the download button for the OpenAPI definition in Redocly's API documentation. Redocly provides a feature to hide this button, which some users may want to utilize to alter the appearance or location of the link, despite the fact that hiding it does not protect the API definition from being accessed through other means, such as inspecting network traffic. The decision to hide the button should be carefully considered, as it may inconvenience API consumers who use the OpenAPI format for code generation or validation. Redocly has supported hiding the download button for over four years, but its practical use case remains limited primarily to aesthetic changes. The configuration to hide the button can be applied through various methods, including the Redocly configuration file, Redocly portal legacy page format, and Redocly HTML element, each requiring specific syntax to toggle the feature.