Customer StoriesReadMe Blog
Back to All
added

Owlet Weekly Update (Week of October 12)

October 13th, 2020

Welcome to another Owlet Weekly Update! I'm going to state the obvious here folks—we all learn best when we learn by example. And there's no better example right now than this week’s Owlet Person of the Week (which is totally a thing, trust me)—American men’s basketball player LeBron James! In honor of Mr. James and the example he sets for all of us, we’ve added response examples to the API Explorer. Read onward for details on this and so much more! 🏀

2720

🐐

✨ New & Improved

  • As alluded to above, we now support defining response examples via the example keyword. What does this mean? You can now create sample API responses that your users can preview before they even hit the “Try It” button! This makes it even easier for your users to know what to expect from your API. See it in action here! 👀
  • If you’ve ever brought your OpenAPI/Swagger file into ReadMe, you’ll know that we have a variety of extensions available so you can customize your reference guides to your liking. These properties used to apply to your entire reference section, but why paint with such a broad brush? With this release, you can now specify options at the operation level. Hooray for smaller brushes! 🖌️
  • We just made some changes to our knowledge base to make it easier to navigate. Let us know what you think! 🧭

🛠 Fixes & Updates

  • What’s a pull request on GitHub without the angry “any update?” comments? Well, ReadMe’s version of pull requests (which most of you know as Suggested Edits) were temporarily unable to load the comments section. Great in theory for preventing abuse, bad in reality for actually conversing with the person that submitted the suggested edit. For better or worse, this release brings the comments section back. 💨
  • Did you know that API Metrics uses your OpenAPI definition to help you understand your usage better? For example, when viewing your most popular API endpoints, we group certain URLs together if they share path parameters! With this release, the dashboard will offer some suggestions so you can make the most of your metrics. 📈
  • All response examples deserve to be treated fairly… including those that are passed via $ref! Now, we properly render response examples regardless of how they’re referenced. 🔄

Thanks for reading and for being a part of the ReadMe community (and congratulations again to LeBron James on winning Owlet Person of the 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]!