Customer StoriesReadMe Blog
Back to All
improved

Owlet Weekly Update (Week of December 13)

December 16th, 2021

Hello and welcome to another weekly update, friends! As we get closer to the holidays here in the US, we're still churning out lots of exciting performance and feature improvements, as well as the usual round of bug fixes. Details below! 🧈

👍

We've been rolling out a redesigned docs experience for some time now—check out this page for the details! Changes that are only applicable to the redesigned docs experience will be prefixed with a 🆕 emoji. The legacy docs style will be deprecated on December 31, 2021.

✨ New & Improved

  • 🆕 Building on the OpenAPI v3.1 support that we announced last week, we're shipping enhanced JSON Schema support for our fancy schema tooltips in the API Reference. For OpenAPI v3.1 documents, we now default to JSON Schema v2020-12 and support JSON Schema overrides via the $schema and jsonSchemaDialect fields. You can read more about our JSON Schema support in our docs. 💁‍♀️
  • 🆕 In the small but noteworthy category of announcements, we’ve started to make a few improvements to our static asset compression. We’ll have more announcements on this front... but for now, enjoy the ever-so-slight performance improvements! 🚀
  • 🆕 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 syntax highlighting support for two programming languages (that I hadn’t heard of until this release): Lua and Solidity. 🎨
  • 🆕 For those of y’all with sidebars that are chock-full of content, the sidebar now auto-scrolls to the currently selected page. 📜

🛠 Fixes & Updates

  • This release includes a few small fixes to the Version endpoints in the ReadMe API. The versionId path parameter now does a better job of accepting your version inputs, and we also made some small documentation touch-ups for these endpoints. 💅
  • 🆕 This release addresses a few edge cases with the API Reference where certain pages would crash due to the presence of translated page content, a certain regular expression configuration, or an explode flag (ironic, I know). 💣
  • 🆕 This release addresses a styling issue where endpoints with deprecated readOnly parameters were looking a little funky in select areas. 🕺
  • Fixed an issue where certain code snippets containing multipart/form-data body content weren’t properly generating. 🌱
  • Fixed an issue where a small percentage of search results were either 404ing or not scrolling to the correct section on the page. 🔍
  • This release adds some sensible API key defaults for reference sections written with our Manual API Editor. 🔑
  • 🆕 Fixed an issue where the child project picker wasn’t rendering for certain Enterprise projects. ⛏️
  • 🆕 Several little styling and UI touchups related to API request history in the reference section. 🖌️
  • 🆕 Fixed an issue where certain legacy URLs that should have been redirecting were not. 🔗
  • Fixed an issue where certain empty code blocks were causing page rendering issues. 🥴
  • Fixed an issue where certain SSO flows were not redirecting properly. 🔐

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