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! ❄️
{/-
Note: the readme-deploy tag wasn't properly updated and still says 4.82.0, even though this
-/}
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.
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! 🧈
🆕 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 deprecatedreadOnly 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 internetdisasters* 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! 🍲
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. 🪆
🆕 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! 💅🏽
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. 🧬
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!
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. 🗃
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! 🍌
🆕 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! 📊
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. 🔐
🆕 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]!
I'm not gonna stop, that's who I am (Who I am)
I'll give it all I got, that is my plan (That's my plan)
—Troy Bolton (circa 2007), and all of us as we ship redesigned login pages and even more metrics and bug fixes despite attending our company offsite. More below! ⛳
📘
Delayed Update
Most of the team was at our quarterly offsite this week! This post goes over everything that was shipped the week of November 8th, but due to the offsite and a company holiday, we didn't have a chance to publish the changelog until the following week (around November 18th). Appreciate your patience, folks!
Ahead of lots of authentication improvements coming your way (stay tuned! 👀), this release includes a completely redesigned login page for your users when they log in into your docs. In addition to a much sleeker design with 100% fancier loading states, the login page is much more tailored to the look and feel of your docs and features your logo prominently at the top! Perhaps most importantly, your users will no longer feel catfished when seeing the ReadMe logo on the login page. 100% Nev approved. 🐟
As we continually allude to, we're working on some exciting updates to the metrics experience! This release includes even more tire-kicking to make sure it's ready for game day. If you're interested in seeing what the hype (mostly generated by that single event and these extremely popular Changelog posts) is all about, you can sign up for the beta program now! 📊
🛠 Fixes & Updates
Fixed an issue where certain API specifications that were constructed using the manual editor weren't playing nicely with the SDKs generated by the api package. 🎲
🆕 This release addresses an issue where certain users were having issues redirecting back to the docs after suggesting an edit. 📝
Fixed a minor styling issue where the Recipes modal didn't play nicely with tall screens. 🖥
Addressed a security vulnerability related to URL redirects. 🔐
Minor copy updates in the dashboard. ✍️
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 Christmas season folks! (I said what I said.) We're kicking off our November with flair, bug fixes galore, and a beta release of a feature we've been working on since this time last year! Read on for all the juicy details. 🎄
As we continually allude to, we're working on some exciting updates to the metrics experience! This release includes even more of behind-the-scenes work so it's ready for primetime. We officially kicked off our beta program with a sneak peek event earlier this week—if you're interested in seeing what the hype (mostly generated by that single event and these extremely popular Changelog posts) is all about, you can sign up for the beta program now! 📊
🛠 Fixes & Updates
So... um... you know how we mentioned some big improvements with the weekly Slack metrics update a few weeks ago? And how we specifically said "it should actually hit your Slack inbox as expected", which implied that it wasn't hitting your Slack inboxes before and it should have done so after that release? Well... turns out we needed some additional configuration to make that happen. Now, it should (hopefully) actually hit your Slack inboxes as expected this coming Monday! 📬
Thanks for reading and for being a part of the ReadMe community, folks!
—Mostly Kanad, a tiny bit Naomi, and the (emotional) support of 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 Halloween Double Eve(?), folks! In honor of this momentous day that I absolutely did not just make up, we're getting closer to our newly improved metrics experience rollout while squashing several bugs that have been absolutely terrifying to deal with. Details below! 🕷️
As we continually allude to, we're working on some exciting updates to the metrics experience! This release includes even more of behind-the-scenes work so it's ready for primetime. We have a sneak peek event on this coming Tuesday, November 2nd—you canRSVP here! 📆
🆕 Infinitesimally small styling improvements in various dropdowns. 🖌️
🛠 Fixes & Updates
🆕 As part of the routing architecture in the refreshed documentation, one benefit is wickedly-fast page navigation. But sometimes, there was an issue where the web browser was simply too fast to know what to do with itself, and would occasionally fail to update page content as you clicked between different pages. This release should quell the browser's ego while still keeping things zippy. 🚄
🆕 This release includes a fix for apples that were falling a bit too far from the tree. In other words, certain enterprise projects were experiencing an issue where parent project properties (e.g. glossary terms, custom JS or CSS, etc.) weren't properly being applied to children. 🍎
Fixed an issue where the "Add to Slack" button ate too much candy corn and temporarily couldn't hang. 🥴
🆕 Small fixes to our tooltips and deprecated parameter fields as a follow-up to last week's release.
🆕 Fixed an issue where certain discussion forums would 404 when clicking on their tags. 🏷
Fixed an issue where certain deleted pages were showing up in search results. 🚮
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]!
