Customer StoriesReadMe Blog
Changelog
Back to All
improved

Owlet Weekly Update (Week of February 1)

February 3rd, 2021

Hi there! Thanks for tuning into another weekly update. This week we're feeding our Tamagotchis and blasting Semisonic's Secret Smile (their best song according to one person at ReadMe that clearly did not grow up in the United States) in honor of our 90s themed offsite that's happening all week! We're also shipping parameter examples in the API Explorer and making sure everything checks out with our health checks. Details below! 🎸

✨ New & Improved

  • This week, we're shipping some major behind-the-scenes improvements to our forms in the API Explorer. This fixes a bunch of little quirks in our OpenAPI/JSON Schema handling, but more importantly, it adds support for the example and examples keywords in parameters and request bodies (we've supported examples in response bodies for a bit now, for the record!). In other words, you can now specify example parameters for your users to grab when constructing API requests. They'll be able to preview your examples via an input placeholder and select one of them from a dropdown list. Still confused? Check out a demo here! 📚
  • The API Explorer gifts just keep on giving—so much so that they're spilling into a second bullet point! We're also shipping some big performance improvements to the API Explorer, namely in how we handle dereferencing for large OpenAPI files. What does this mean? Substantially improved loading times, particularly for those of you with literally thousands (... thousands...) of endpoints. 🚀
  • Various bundling improvements and caching improvements for static assets so your users have a faster experience loading your docs. 📦
  • Design and readability improvements to the user agents in the API Metrics Dashboard. 💅

🛠 Fixes & Updates

  • Health checks weren't doing a great job at the whole "checking" thing (in other words, they weren't properly loading in the Hubs), which is basically their only job. Thankfully, this release brings 'em back. ✔️

Thanks for reading and 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 Tuesday to the ReadMe Changelog) where we provide an overview of the product updates that went out as part of our new Tuesday release cycle. As we refine our format and process for providing these updates, we'd love to hear what you think at [email protected]!