Customer StoriesReadMe Blog
Back to All
fixed

Owlet Weekly Update (Week of August 30)

August 31st, 2021

Hello and welcome to another weekly update, friends! While we're not too busy mourning the end of August, we're shipping a new font in the dashboard, making little fixes and improvements in all kinds of obscure places, and writing some docs. Oh, and we're also hosting a virtual event or two. Details below! 🌉

👍

We've been rolling out some new docs designs for a little while now—check out this page for the latest details on what's going on! Changes that are only applicable to the new docs design will be prefixed with a 🆕 emoji.

📆 Upcoming Events

Oh hey, what's this? An events section? Not sure if this will be a permanent addition to the Owlet Weekly Update, but we have a few virtual events coming up that we wanted to make sure our dedicated Owlet Weekly Update readers don't miss out on!

  • In a couple weeks, I'll be hosting a Q&A with Shaun VanWeelden, Head of Field Engineering at Scale AI (and a fellow Midwesterner)! Scale is one of our fastest growing customers (and I gotta say, they have absolutely incredible docs), so I'm excited to chat with Shaun about how Scale leverages ReadMe in supporting success on their platform, thoughtful developer experience, and more. You can submit a question and RSVP (if you can't make it live, we'll send you a recording of the conversation) on the event page! 💬
  • In the hopefully not-too-distant future, I'll be live-streaming as I build a website using a public bus-tracking API. It should be a fun time as I drift into unfamiliar territory with some not-so-great API docs and an even worse Twitch streaming setup. Watch this space for details! 🚍

✨ New & Improved

  • Now this one isn't a product update, but we recently added a wonderful resource to our documentation—a comprehensive OpenAPI Compatibility Chart! This page goes deep on the OpenAPI Specification and which aspects of it that we support in our API Reference documentation. We'll be updating this page as we ship new OpenAPI features, so definitely keep checking back as we continuously invest in our OpenAPI support (and stay tuned for more on this front)! 📚
  • 🆕 This release considerably enhances the way we document various format values for integer and number data types in the API Reference section. We now display the integer maximum and minimum values based on their formats (e.g. an int8 will render minimum and maximum values of -128 and 127, respectively). To see an example of this in action, check out these docs and navigate to the "format data types" page (listed under the Numbers category). 🔢
  • This release includes a small but mighty update to our dashboard design—in the form of a new font! This comes ahead of some big changes coming to the dashboard soon—stay tuned! 🎨

🛠 Fixes & Updates

  • 🆕 Various fixes to authentication in the API Reference section so authentication credentials are better persisted when switching endpoints, along with improvements to zero-config metrics on the whole "knowing you who actually are" front. 🔐
  • 🆕 Fixed an issue where, under an extremely obscure and specific set of circumstances, page body content in the Guides section wasn't properly updating when navigating between pages. 🔄
  • 🆕 Various improvements for api-generated code snippets—including minor padding fixes for multi-schemas (i.e. anyOf, oneOf) and the dramatic return of form-encoded parameters. 📝
  • 🆕 Fixed an issue in the API Reference section where, if a request example was selected, editing parameter values in the form wasn't properly updating the code snippet. ✍️
  • 🆕 Fixes two obscure and unrelated markdown rendering issues in the response schema modal in the API Reference section and in the top navigation bar. 👀
  • 🆕 This release includes updates to our discriminator mapping support—support for schema reuse in mappings and various minor bug fixes. 🗺
  • 🆕 Fixed a quirk in the Changelog where extremely long code samples were causing the page to break. See below for an example! 🤥 
    console.log("Hello there! It's been some time since we've embedded a code block directly in the Changelog. As you can see, the overflow on this obscenely long code sample is properly being handled and isn't breaking the page! Love that.
  • 🆕 Did some minor shuffling around in the navigation bar so child project + version selection makes a little more sense. 🧭
  • 🆕 Stability fixes in the API Reference to better handle duplicate enum values. 👯‍♀️
  • Fixed an issue where certain emojis weren't properly rendering callouts. 👍
  • 🆕 Tiny tweaks to prettify certain JSON response code samples. 💋
  • 🆕 Various layout and design fixes in Suggested Edits. 📐

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