Hello and welcome to another Owlet Weekly Update, y'all! Unlike Aaron Rodgers, we had wins on multiple fronts this week. Details below! 🤡

👍

We've been rolling out a redesigned docs experience for some time now—check out this page for the details!

The legacy docs style is now deprecated and is not receiving any bug fixes. All changes below are only applicable to the new docs experience (unless otherwise noted). We'll communicate a sunset timeline to any remaining legacy customers soon.

✨ New & Improved

• As mentioned last week, we’ve been hard at work re-thinking how Enterprise admins distinguish between user roles and how to simplify the process of managing multiple projects at scale. We’ve made some major improvements and our beta is now underway! This release includes even more improvements to this beta. If you're an Enterprise project administrator and you're curious about what we've been working on, we’d love for you to try it out! Drop us a line at [email protected]. 👥
• This release includes little performance bumps for initial page loads in the dashboard and the hub, as well as client-side bundle size reductions. 🚀
• 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! ✍️

🛠 Fixes & Updates

• Fixed a couple issues surrounding the Landing Page: one is a small styling issue for recently-upgraded projects, and the other is a URL issue where attempting to navigate to the landing page on single-project enterprise projects would instead lead you into a mysterious abyss. 🌀
• Good news for you power search users: this release fixes a longstanding issue where the search bar would periodically drop certain characters as you were furiously typing. 🔍
• Fixed a gnarly issue with allOf schemas in OpenAPI files where merging certain objects would yield unexpected results due to missing types. ❓
• This release includes improved handling of response header descriptions that don’t include response object descriptions in the API Reference. 📝
• Fixed an issue in the API Reference where certain nested integer fields were rendering as strings. 🔢
• Fixed a little typo in the dashboard where the word “discussions” had one too many s’s. 🐍
• Restored a few tooltips in the Metrics dashboard that had temporarily disappeared. 🎩
• Fixed some issues surrounding zero-config metrics for Enterprise projects. 📊
• A few minor styling fixes in the dashboard. 💅

Hope you're staying safe and healthy! Thanks for being a part of the ReadMe community, folks.

—Kanad and the ReadMe Team

📘

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

Hello and welcome to another Owlet Weekly Update! I've been informed by our legal team that Wordle references are no longer cool nor relevant, but that's fine with me because this release is so substantial that there's no way we could possibly summarize it in five letters: OpenAPI validation improvements, a new beta program for Enterprise authentication and team management, and so much more. Details below! 🖐️

👍

We've been rolling out a redesigned docs experience for some time now—check out this page for the details!

The legacy docs style is now deprecated and is not receiving any bug fixes. All changes below are only applicable to the new docs experience (unless otherwise noted). We'll communicate a sunset timeline to any remaining legacy customers soon.

📘

Programming Note

This post is being backdated to January 13th, 2022 but was actually published on January 26th, 2022. Apologies for the delay folks!

✨ New & Improved

• We know that a lot of ReadMe Enterprise customers are often dealing with many users at a time, all of whom have different permissioning requirements for different projects. Well it doesn't have to be so complicated! For several months now, we’ve been hard at work re-thinking how Enterprise admins distinguish between user roles and how to simplify the process of managing multiple projects at scale. We’ve made some major improvements and we’re excited to announce that we’ve officially entered our beta period! If you're an Enterprise project administrator and you're curious about what we've been working on, drop us a line at [email protected]! 👥
• You may have noticed that a previously valid OpenAPI or Swagger file is now failing certain checks in our validator. That’s a good thing! That’s because this release includes a loooot of cool new tricks in our OpenAPI and Swagger validation. Our validator now flags a lot of common OpenAPI mistakes that could cause quirks in your documentation, including duplicated operation IDs, invalid parameters, invalid discriminators, and much more. 🪄
• In the last couple months, we shipped completely redesigned login pages that are more tailored to your documentation. This release includes further enhancements that allow more granular control over this page’s theme. 🎨
• Several notable yet barely noticeable performance improvements in the API Reference, particularly for endpoints that contain complex response schemas. 🐎
• 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 several little enhancements to the the Metrics dashboard, including better HTTP method information in the API Calls table. 🏓

🛠 Fixes & Updates

• We’ve enhanced how we persist your credentials between endpoints in the API Reference. We previously only persisted your authentication data, but as of this week, we now include any relevant server URL data as well! 🔗
• We’ve made our search bar a bit less macOS-centric and no longer render a ⌘ symbol for our non-macOS friends out there. 🍎
• Fixed an issue where toggling between API logs under the Request History wouldn’t properly show the selected log. 🪵
• Fixed some navigation quirks for enterprise projects with custom child path names. 🧭
• Fixed a sidebar scrolling issue affecting certain projects with lots of sidebar items. 📜
• Minor security fixes. 🔐

Hope you're staying safe and healthy! Thanks for being a part of the ReadMe community, folks.

—Kanad and the ReadMe Team

📘

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

Hello and happy 2022, friends! Hope your holidays were safe and enjoyable. We're still getting back into the swing of things, but we're kicking things off with a few UI improvements and updates on the Metrics and API Reference fronts. Details below! 🍾

👍

We've been rolling out a redesigned docs experience for some time now—check out this page for the details!

The legacy docs style is now deprecated and is not receiving any bug fixes. All changes below are only applicable to the new docs experience (unless otherwise noted). We'll communicate a sunset timeline to any remaining legacy customers soon.

✨ New & Improved

• This release includes a few UI improvements for when you’re slicing and dicing insights in the Metrics dashboard, as well as for when you're viewing your Request History in the Hub. 🔪
• 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! ✍️
• Improved support for schema name discriminator mappings in the API Reference. 🗺️

🛠 Fixes & Updates

• Fixed an issue where the ReadMe API wasn’t capturing certain API Request History. 🕰️

Hope you're staying safe and healthy! Thanks for being a part of the ReadMe community, folks.

—Kanad and the ReadMe Team

📘

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

We've been working on migrating all customers to the new version of ReadMe for the last several months and the legacy design was deprecated as of December 31, 2021. We'll work with any customers still using this design to transition as soon as possible.

The majority of customers have already migrated, but you'll know if you still need to upgrade your project if you see this banner in your dashboard. Just preview your hub on the new design, and if you need to make any content or CSS adjustments, here's our handy migration guide to help!

Hello and welcome to another Owlet Weekly Update, friends! A lot of the ReadMe team is out for the holidays this week so this release is quite light. More 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.

📘

Programming Note

This post is being backdated to December 22nd, 2021 but was actually published on January 4th, 2022. We did not issue a release during the week of December 27th due to a company holiday.

✨ New & Improved

• Updated OpenGraph metadata for password-protected projects to be more of the password-protected nature. 🔒
• Added support for the summary field for Callback objects in the API Reference section. 📘

🛠 Fixes & Updates

• Minor UI touch-ups in the API Reference section. 💅

Thanks for reading and for being a part of the ReadMe community, folks! Happy holidays!

—Kanad and the ReadMe Team

📘

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

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

📘

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

Hope you brought enough Tupperware, folks. This week's internet disasters* only marginally slowed down our ability to ship a feast of improvements to our API Reference including OpenAPI v3.1 support, improved validation messages, and so much more. 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

• If you're one of the many avid followers of our blog, you'll know that we've joined the OpenAPI Initiative. And we're celebrating with a complete three-course meal, y'all. For your starter, we're serving upload and validation support for OpenAPI v3.1! For the main course, we're completely rewriting our OpenAPI validation errors—making the error messages far more actionable and readable for humans. And lastly for dessert, we're shipping support for HTTPie (as well as regular ol' HTTP) snippets, since, you know, 3.1 is a vague approximation for π and all. Get the details on all of this on our blog! 🥧
• As previously announced, our new Metrics experience has officially starting rolling out! This release contains more polish on the Metrics front before we officially launch it to the masses early next year. If you've gotten a chance to play around and have any feedback for us, please drop us a line! 📊
• We added a new validate command to the rdme command line tool, which performs a local validation of your API definition without uploading it to ReadMe and returns the fancy new validation errors mentioned above. Very handy when constructing or editing your API definition! 📝
• 🆕 More improvements to our new editor, which you can play around with in our discussion forums! ✍️
• 🆕 This release brings our Markdown support to a few more places in the API Reference section. 🖋️
• Some behind-the-scenes upgrades to make our reCaptcha more effective. 📬

🛠 Fixes & Updates

• 🆕 Prior to this release, we would surface response header descriptions in some places in the API Reference but not others. We made some tweaks in this release so we show those descriptions where you'd expect to see them. 🧄
• 🆕 As part of our release of OpenAPI 3.1 (see above!), we inadvertently created a bug where enums weren't displaying properly. Oops! Thankfully, this was fixed in less than 24 hours. 🕛
• 🆕 This release addresses a small issue where certain read-only users were seeing the "Save Edits" button when suggesting an edit (don't worry, it didn't work). 💾
• 🆕 Fixed an issue where certain polymorphic objects weren't rendering as expected when viewing response schemas in the API Reference. 🔀
• 🆕 Fixed yet another issue in the API Reference where certain nested objects weren't displaying properly in the request code snippet. 🪆
• Fixed an issue with the search modal where certain projects weren't seeing Changelog posts. 🔍
• Child projects now inherit their parent project's favicon if they don't have one specified. 🤝
• Fixed a permissions issue for users logging in through our new passwordless login flow. 👥
• 🆕 Addressed some confusing schema tooltip pop-up behavior in the API Reference. 🥤
• Fixes to an authentication issue affecting a select few Enterprise projects. 🔐
• Small performance and stability improvements with our search modal. 🔎

Thanks for reading and for being a part of the ReadMe community, folks!

—Kanad and the ReadMe Team

*Note from our infra folks: ReadMe's not directly susceptible to the Apache Log4j JNDI vulnerability that was publicized this week; we don't use Log4j directly. Nonetheless we've enabled new Cloudflare Web Application Firewall rules that mitigate attempts to exploit this vulnerability. If you use ReadMe to write documentation that refers to the Java Naming and Directory Interface (JNDI), there's a small chance that the new firewall rules may keep you from editing those pages or using ReadMe's other interactive features. If you run into problems on those pages, please contact our support team so that we can fix this for you!

📘

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

Hello and welcome to another Owlet Weekly Update! This week we're shipping lots of fixes to the API Reference section, continuing to polish up our new Metrics experience, and more. 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

• As previously announced, our new Metrics experience has officially starting rolling out! This release contains more polish on the Metrics front before we officially launch it to the masses early next year. If you've gotten a chance to play around and have any feedback for us, please drop us a line! 📊
• 🆕 Various stability improvements related to the sharing and displaying of Request History in the API Reference section. 🪵

🛠 Fixes & Updates

• 🆕 There was a periodic issue in the API Reference section where we would sometimes show a "Log Out" button even when you were already logged out, causing widespread panic and confusion. Happy to report that this release brings some semblance of relief. 😌
• Fixes a bug where if a manual API definition property had an enum, it wouldn't be reflected as such in the API Reference. 🪞
• 🆕 This release includes a fix related to page views to ensure that we're not double-counting page views. 🧬
• Fixed an issue related to how our api package loads OpenAPI files using our custom extensions. 🧩
• Fixed a permissions issue for users logging in through our new passwordless login flow. 👥
• Some stability improvements for a small subset of API Reference pages. 💥
• 🆕 Fixed some styling breakages with our schema tooltips. 💅

Thanks for reading and for being a part of the ReadMe community, folks!

—Kanad and the ReadMe Team

📘

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

Hello and happy Thanksgiving week folks! It's a short work week for most of us due to the holiday, but that didn't stop us from cooking up some exciting things—details below! 🦃

📘

Release Scheduling Update

We're now ramping up our release frequency to be nearly daily, so these Changelog posts will be published on the Monday following the previous week of releases, with the post covering everything that went out during that week. The publishing date is backdated to the time of the last release of the week. We appreciate your patience as we workshop this process!

👍

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

• As part of some major ongoing authentication improvements underway, we've enhanced the recently-redesigned login pages to now support passwordless logins! Now your users can simply opt to receive a login link in their inbox rather than typing "password123"* into yet another field. 📥
• As previously announced, our new Metrics experience has officially starting rolling out! This release contains more polish on the Metrics front before we officially launch it to the masses early next year. If you've gotten a chance to play around and have any feedback for us, please drop us a line! 📊
• 🆕 This release includes a nice little addition for response examples in the API Reference section: headers! If you've documented example response headers, they now show up the same way they would if someone hit the "Try It!" button. ⚽
• All you favicon fiends out there may have noticed that we finally refreshed the color of our logo for dashboard pages. 💙

🛠 Fixes & Updates

• 🆕 Fixed an issue where navigating to a different version of the docs would occasionally take you to the wrong place. 🧭
• 🆕 Tweaking some hover states to make some things more obviously clickable in the API Reference section. 🪤
• More improvements to our new editor, which you can play around with in our discussion forums! ✍️
• 🆕 Fixed an issue where TypeScript code samples weren't properly being categorized as such. 🗃
• 🆕 A few copy edits and fixes for the callback support we shipped last week. 🍌
• 🆕 Some minor keyboard navigation fixes in the discussion forums. ⌨️

*DISCLAIMER: This is a joke, please use a secure password instead!

Thanks for reading and for being a part of the ReadMe community, folks!

—Kanad and the ReadMe Team

📘

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

Hello and welcome to another weekly update, folks! We're officially unveiling our new Metrics experience into the universe and shipping sh*t that's B-A-N-A-N-A-S. 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

• 🆕 Good news if you enjoy stomping your feet with the girls, have been around the track a few times, and refuse to let it happen like that: with this release, we have officially shipped call-a-back girl supp—wait... uh oh. (sigh) y'all... I read this completely wrong. Let's try again: with this release, we have officially shipped callback support in the API Reference section. Brownie points if you implement this endpoint for events related to Gwen Stefani (and NOT Blake Shelton). See here for an example of the new functionality. 🗣
• So you might notice something a little (or a lot, rather) different when you log in to your project dashboard... we've officially rolled out our new Metrics improvements to everyone! When you load up your project, you'll step into a completely revamped dashboard with various top-level insights on your API usage, users, and docs. It's been completely redesigned to make it easy (and fast!) to explore all of this valuable information. Check out our docs to learn more and drop us a line if you have any feedback! 📊
• You can now set variables at the enterprise parent project level. This will make it much easier to have a unified variables experience across all of your child projects—a Hallie and Annie situation, if you will. 👯

🛠 Fixes & Updates

• The docs for our GET /api-specification endpoint have long claimed that we do not require the x-readme-version header and that we'd default to your project's main version if you don't include that header, but turns out that was... completely false. We made some behind-the-scenes updates to actually live up to this claim. 🤥
• 🆕 This release addresses several quirks for endpoints with multiple authentication schemes so the docs can better handle the credentials that you select. 🔑
• Fixed an issue where hovering your cursor over the lefthand column of items in the dashboard wasn't properly revealing their titles. 🎩
• This release fixes an issue where several users were unable to log into their documentation via SAML. 🔐
• Resolved some workflow issues regarding suggested edits for projects with a staging environment. 🔀
• 🆕 This release addresses a handful of issues with client-side navigation on enterprise projects. 🧭
• 🆕 Polished up some styling on the server variable menus in the the API Reference. 💅

Thanks for reading and for being a part of the ReadMe community, folks!

—Kanad and the ReadMe Team

📘

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