Customer StoriesReadMe Blog
Back to All
improved

Owlet Weekly Update (Week of January 10)

January 13th, 2022

Hello and welcome to another Owlet Weekly Update! I've been informed by our legal team that Wordle references are no longer cool nor relevant, but that's fine with me because this release is so substantial that there's no way we could possibly summarize it in five letters: OpenAPI validation improvements, a new beta program for Enterprise authentication and team management, 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!

The legacy docs style is now deprecated and is not receiving any bug fixes. All changes below are only applicable to the new docs experience (unless otherwise noted). We'll communicate a sunset timeline to any remaining legacy customers soon.

📘

Programming Note

This post is being backdated to January 13th, 2022 but was actually published on January 26th, 2022. Apologies for the delay folks!

✨ New & Improved

  • We know that a lot of ReadMe Enterprise customers are often dealing with many users at a time, all of whom have different permissioning requirements for different projects. Well it doesn't have to be so complicated! For several months now, we’ve been hard at work re-thinking how Enterprise admins distinguish between user roles and how to simplify the process of managing multiple projects at scale. We’ve made some major improvements and we’re excited to announce that we’ve officially entered our beta period! If you're an Enterprise project administrator and you're curious about what we've been working on, drop us a line at [email protected]! 👥
  • You may have noticed that a previously valid OpenAPI or Swagger file is now failing certain checks in our validator. That’s a good thing! That’s because this release includes a loooot of cool new tricks in our OpenAPI and Swagger validation. Our validator now flags a lot of common OpenAPI mistakes that could cause quirks in your documentation, including duplicated operation IDs, invalid parameters, invalid discriminators, and much more. 🪄
  • In the last couple months, we shipped completely redesigned login pages that are more tailored to your documentation. This release includes further enhancements that allow more granular control over this page’s theme. 🎨
  • Several notable yet barely noticeable performance improvements in the API Reference, particularly for endpoints that contain complex response schemas. 🐎
  • This release includes even more improvements to our soon-to-be-released editor, which you can get a sneak peek of in our discussion forums! ✍️
  • This release adds several little enhancements to the the Metrics dashboard, including better HTTP method information in the API Calls table. 🏓

🛠 Fixes & Updates

  • We’ve enhanced how we persist your credentials between endpoints in the API Reference. We previously only persisted your authentication data, but as of this week, we now include any relevant server URL data as well! 🔗
  • We’ve made our search bar a bit less macOS-centric and no longer render a ⌘ symbol for our non-macOS friends out there. 🍎
  • Fixed an issue where toggling between API logs under the Request History wouldn’t properly show the selected log. 🪵
  • Fixed some navigation quirks for enterprise projects with custom child path names. 🧭
  • Fixed a sidebar scrolling issue affecting certain projects with lots of sidebar items. 📜
  • Minor security fixes. 🔐

Hope you're staying safe and healthy! Thanks for being a part of the ReadMe community, folks.

—Kanad and the ReadMe Team :owlbert:

📘

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]!