Owlet Weekly Update (Week of December 6)
Hope you brought enough Tupperware, folks. This week's internet disasters* only marginally slowed down our ability to ship a feast of improvements to our API Reference including OpenAPI v3.1 support, improved validation messages, and so much more. Details below! π²
We've been rolling out a redesigned docs experience for some time nowβcheck out this page for the details! Changes that are only applicable to the redesigned docs experience will be prefixed with a π emoji. The legacy docs style will be deprecated on December 31, 2021.
β¨ New & Improved
- If you're one of the many avid followers of our blog, you'll know that we've joined the OpenAPI Initiative. And we're celebrating with a complete three-course meal, y'all. For your starter, we're serving upload and validation support for OpenAPI v3.1! For the main course, we're completely rewriting our OpenAPI validation errorsβmaking the error messages far more actionable and readable for humans. And lastly for dessert, we're shipping support for HTTPie (as well as regular ol' HTTP) snippets, since, you know, 3.1 is a vague approximation for Ο and all. Get the details on all of this on our blog! π₯§
- As previously announced, our new Metrics experience has officially starting rolling out! This release contains more polish on the Metrics front before we officially launch it to the masses early next year. If you've gotten a chance to play around and have any feedback for us, please drop us a line! π
- We added a new
validatecommand to therdmecommand line tool, which performs a local validation of your API definition without uploading it to ReadMe and returns the fancy new validation errors mentioned above. Very handy when constructing or editing your API definition! π - π More improvements to our new editor, which you can play around with in our discussion forums! βοΈ
- π This release brings our Markdown support to a few more places in the API Reference section. ποΈ
- Some behind-the-scenes upgrades to make our reCaptcha more effective. π¬
π Fixes & Updates
- π Prior to this release, we would surface response header descriptions in some places in the API Reference but not others. We made some tweaks in this release so we show those descriptions where you'd expect to see them. π§
- π As part of our release of OpenAPI 3.1 (see above!), we inadvertently created a bug where enums weren't displaying properly. Oops! Thankfully, this was fixed in less than 24 hours. π
- π This release addresses a small issue where certain read-only users were seeing the "Save Edits" button when suggesting an edit (don't worry, it didn't work). πΎ
- π Fixed an issue where certain polymorphic objects weren't rendering as expected when viewing response schemas in the API Reference. π
- π Fixed yet another issue in the API Reference where certain nested objects weren't displaying properly in the request code snippet. πͺ
- Fixed an issue with the search modal where certain projects weren't seeing Changelog posts. π
- Child projects now inherit their parent project's favicon if they don't have one specified. π€
- Fixed a permissions issue for users logging in through our new passwordless login flow. π₯
- π Addressed some confusing schema tooltip pop-up behavior in the API Reference. π₯€
- Fixes to an authentication issue affecting a select few Enterprise projects. π
- Small performance and stability improvements with our search modal. π
Thanks for reading and for being a part of the ReadMe community, folks!
βKanad and the ReadMe Team 
*Note from our infra folks: ReadMe's not directly susceptible to the Apache Log4j JNDI vulnerability that was publicized this week; we don't use Log4j directly. Nonetheless we've enabled new Cloudflare Web Application Firewall rules that mitigate attempts to exploit this vulnerability. If you use ReadMe to write documentation that refers to the Java Naming and Directory Interface (JNDI), there's a small chance that the new firewall rules may keep you from editing those pages or using ReadMe's other interactive features. If you run into problems on those pages, please contact our support team so that we can fix this for you!
What is the Owlet Weekly Update?
Thanks for tuning in to another edition of our Owlet Weekly Updateβan owlet-sized update (posted every week to the ReadMe Changelog) on the product updates we're shipping here at ReadMe. We'd love to hear what you think of these updates at [email protected]!