Customer StoriesReadMe Blog
Changelog
Back to All
fixed

Owlet Weekly Update (Week of August 24)

August 25th, 2020

Happy Tuesday folks! With the arrival of Virgo season comes lots of exciting improvements, including the ability to upload files in the API Explorer! ♍

You're probably wondering—how do file uploads relate to Virgo season? Not sure... everyone uploads files to the internet regardless of their chart, but I suppose Virgos triple-check that they have the correct file before uploading? 🤷🏽‍♂️

Read onward for details on this week's release (and rest assured, you won't find any more attempts at astrological references)! :owlbert-books:

✨ New & Improved

A cat uploading a hamburger to the internet—so as to visualize file uploading for the sake of this feature announcement.

  • As mentioned above, our API Explorer now has full support for file uploads! What does this mean? Now, for API endpoints that accept raw file data (e.g. endpoints with format: binary, like this one!), the API explorer will allow you to select a local file and send it to the API! 📡

    This sounds like a simple task but a lot is going on behind the scenes, and this was by no means a small undertaking. Shoutout to our API engineer, Jon, for making it happen! (Psst: we're also hiring another API engineer and also lots of other roles!) 👀

  • Saving pages is a foundational part of writing docs—and this release includes some yuuuge performance improvements when saving Guides pages in the dashboard. 🚀

  • Great news, Pythonistas! Our Python code snippets in the API Explorer are a little cleaner. 🧹

  • Minor error handling improvements in the API Explorer. ⚠️

🛠 Fixes & Updates

  • About a month ago, we made some Search improvements to render the keyboard shortcut based on what platform you were on. In a certain cases, it would display a flash of raw Angular code before rendering the proper keyboard shortcut. Sorry for the indecent exposure, folks. Happy to report that this release includes a cloak (of the ng variety—if you know, you know) and we've covered up. 🧥
  • If you've ever interacted with an API in ReadMe docs, you've most likely come across our good friend the red asterisk (*), which designates certain parameters as required. Turns out, our friend was getting stage fright and wouldn't show up for certain API parameters in our manual editor. Well, we've given the red asterisk a pep talk and it should show up properly now. 🎭
  • When you're on your 14-day trial of ReadMe, you should be able to test-drive all of the features available in our Business plan. As it turns out, for a brief period of time this was not the case—certain features were disabled when looking at your docs when they shouldn't be! Happy to report that we've tore down the (pay)wall. 🧱
  • Bad news, Pythonistas. In case you missed the announcement last week, we added a Python SDK for API Metrics! But in doing so, we also had some typos in our code samples. We deeply regret this error and extend our sincere apologies to our Pythonista community. 🐍
  • Stability fixes for Custom Login in projects that have API Metrics set up (which you should set up too!) 🧰
  • Small fixes to how the API Explorer handles security definitions and node-simple code snippets. 🔐
  • Minor versioned URL fixes. 🔗

Thanks again for reading and for being a part of the ReadMe community! And thanks to Jon (again) for taking over for me last week.

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