Hello and welcome to another weekly update! We're still heads down on some big changes to our reference section, which we'll hopefully have some more news about very soon! Unfortunately we had some downtime a few days ago which prevented us from doing our planned release, so we don't have any updates to share this week. Apologies for the delayed communication, folks—but we'll be back next week with more news to share!

If you're looking for ways to help out with the ongoing situation in the Minneapolis area, please check out these resources.

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

—Kanad, Owlbert, and the rest 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 Tuesday, friends! This week, we're coming to you with another somewhat underwhelming update as we work on some bigger redesigns to our reference section. We have two more preview sessions if you want to check out what we've been cooking up! 🧑‍🍳

In the meantime, we did make a couple of small improvements to our current API Reference section. Details below! 🏄‍♂️

• We've done some spring cleaning with our OpenAPI extensions! You can now nest all your ReadMe-specific extensions under a new object with the key x-readme. But don't worry, it's fully compatible with our previous format. Check out the details in our docs! 🧹
• Better handling for allOf in response schemas. 🌈

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! If you're dialed into all things ReadMe, you'll know that we officially launched ReadMe Recipes last week 🎊 we've been subtly teasing it for months here in the Owlet Weekly Update and we couldn't be more excited that it's finally out in the wild! Be sure to check out our latest blog post to see the incredible stuff that our customers are already whipping up with ReadMe Recipes. 🧑‍🍳

As an avid reader of the ReadMe Changelog, you'll also know that we've been cooking up some big redesigns for the API Reference. Happy to report that we've been making great progress and that we've been hosting sneak peek events with some of the masterminds behind this initiative! You can sign up for one of the upcoming sessions here 👀

As for this release, we're still continuing to keep things on the lighter (but nevertheless substantial) side as we continue to work on these bigger initiatives behind the scenes. This week, we're shipping improvements to api and a few tiny fixes in the Enterprise dashboard. More below! 🥗

• Remember api? The Node.js SDK that's custom-tailored to your API? Well we just shipped v3.0, making it easier than ever to peel back the layers and access the sweet fruits of your API response. In other words, API responses are automatically parsed based on content type! For an example of this, check out the Node (simple) code samples in our API reference docs. 🍌
• This release addresses an issue where users were having trouble accessing certain sections of the Enterprise dashboard related to custom login and user management. 🔐

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 Tuesday, folks! As you probably know by now, we're ringing in Aries season (a very special time of the year for the ReadMe Team) with some hard work on bigger redesigns. We'll have some more news to share soon, but in the meantime, we're shipping a smaller release with fixes related to discriminators and search indexing. More below! ♈

• This release addresses a couple edge cases with discriminators. 🧱
• Search indexing improvements for table content. 🔍

Stay tuned for more info on our upcoming redesigns!

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

This hotfix is for yesterday's release and applies to Enterprise customers sending in User Data with their Custom Login.

It ensures that access to the Enterprise Group is not automatically granted if the allowedProjects variable is being used.

👍

Enterprise Customers with Staging

Please deploy this hot fix from the Staging tab in your Enterprise Group. Updates from ReadMe, including hot fixes, will not reach your Production environment until you deploy.

Hello and welcome to another weekly update! As previously mentioned, we're keeping this release on the smaller side as we work on some bigger redesigns. This week, we're increasing character limits, among other things. Details below!

🛠 Fixes & Updates

• If you've ever felt that the character limit on tags in discussion forums was killing your vibe—you're in luck! We've increased the limit from 19 characters to a roomy 25. 📈
• Fixed a bug where custom section names weren't being reflected in the HTML document title. 📄
• Variables can now contain periods. Period. ❗

Short and sweet, as promised. Stay tuned for more info on our upcoming redesigns!

—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 Tuesday, folks! This release is a bit on the lighter side (along with several releases going forward—see the programming note below), but just because it's light doesn't mean that it isn't substantial! (For evidence of this: see salad with chickpeas.) This week, we're shipping custom login setup improvements and navigational fixes. Details below! 🥗

📘Programming Note

As alluded to above, our release cycles (and correspondingly, the Owlet Weekly Updates™) will be a bit lighter for the next 1-2 months (and this timeline may or may not be a direct result of the fact that our CEO is a triple Aries...). We'll be mostly focused on some major upgrades to our API Reference and I couldn't be more excited. We'll still be posting here on a regular basis with any product updates that go out in the meantime—stay tuned! ♈

✨ New & Improved

• This release includes a couple of updates to the custom login setup page in the dashboard. We've converted the sample code into a RunKit embed, so you can run the Node.js code sample and see the output directly within the dashboard. We also moved some things around to eliminate some of the custom login confusion for enterprise groups. 🧹

🛠 Fixes & Updates

• We're bringing back the back button, y'all! For certain Firefox users in the hub, clicking the browser's back button would update the URL but wouldn't actually navigate back to the previous page. A bit disorienting for people that are used to the back button actually working properly (i.e. literally everyone). Happy to report that the functionality is... back! (Confession: in writing this up, the word "back" has lost all meaning to me.) 🔙
• Fixed an issue where the sample starter code wasn't being populated in the Custom OAuth settings. 🔑
• Fixed a bug where custom section names weren't being reflected in the Search modal. 🔍

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

What's this? Two posts in a single week? Well folks, we occasionally do smaller releases outside of our regular release cycle—usually to fix bugs that may have cropped up in the last release. We're going to try and provide better transparency about these smaller hotfix releases in a new segment that's tentatively called The Owlbert Patch! We just shipped a tiny release that includes a couple of glaring issues with the API Explorer that have been plaguing us for a while. Details below!

• A couple weeks ago, we introduced discriminators into the mix! We later discovered issues if these didn't strictly match the OpenAPI specification, which caused errors in the API Explorer. This patch release includes a fix to give folks more flexibility in how they define the discriminators! 🧱
• Certain reference sections weren't properly scrolling down to the right section when hash links (like this one) were included in the URL. We've fixed that in this release! 🖱️

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 March, folks! The arrival of March brings us lots of things—a bleak reckoning with the fact that we (at least those of us in the US) have been dealing with this pandemic for about a year now, but also longer and warmer days (for the most part). And y'all—climate science isn't alone in bringing sunshine and warmth into your lives! This week, we're shipping instant cache invalidation, Google Analytics 4 support, and lots of other little fixes and improvements. Details below! 🌞

✨ New & Improved

• Don't you hate it when you do something and the effects of those changes aren't immediate? In this case, I'm referring to my dying plants and my desperate attempts to bring them back to life, but this can also apply to web pages that are served through a content delivery network (like ours)! While CDNs are great because they make for far faster experiences when using the web, it may take some time for your users to see content changes reflected in their browsers. But what if we could get the best of both worlds? Well this release includes instant cache validation—meaning that whenever you update page content, we purge the cache on Cloudflare, meaning that your users will instantly see your latest and greatest content. 🌱
• Last year, we got deep into our quarantine feelings and enhanced our API errors with a few (and by that I mean over 30) poems. Well it's been a long time coming, but they're finally making their way back around to several places where you create API definitions in the dashboard. This will hopefully lead to less confusion when getting your OpenAPI file set up with ReadMe! 🖋️
• Great news for our Enterprise users (but bad news for people that like to make sneaky updates to the Global Landing Page): whenever someone makes a change to the Global Landing Page, those changes will now be documented in the Audit Logs! 🌐
• As of this release, you can now integrate your developer hub with Google Analytics 4! We also made this easy—to upgrade to GA4, you can simply update the property in the integrations settings in the dashboard. 📊

🛠 Fixes & Updates

• Certain projects were sending out Slack and email notifications for Suggested Edits that contained broken links. Sorry y'all. While we wish we could go back in time and fix all those emails and Slack messages, that'd be both difficult and slightly invasive. Fortunately, this release includes a fix so links should be fixed in future notifications! 🔗
• Several small improvements in the API Explorer, including bundle improvements, more readable JavaScript fetch code samples, and better handling of raw JSON. 🤓
• A couple of user data fixes for users that were unable to see their API logs from within the hub for projects utilizing zero-configuration API metrics. 🎫
• This release fixes an issue where project administrators were unable to select custom pages when configuring links in the Top Navigation bar. 🧭
• Fixed an issue for certain enterprise projects where project administrators were unable to properly preview unpublished API reference pages. 👀
• Minor performance improvements in the API Metrics 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 Pisces season (the best time of the year, according to... nobody), friends! ♓ It's only fair that we ring in the majestic season of the fish with an overly emotional tribute to some code that we deleted this week. We're also shipping support for discriminators (not the kind that you're thinking of, probably) in the API Explorer, as well as several performance and design improvements. Details below! 🐟

✨ New & Improved

• Great news for you polymorphism enthusiasts out there—this week, we're shipping support for discriminators in the form input that constructs request bodies in the API Explorer! You can see a demo of the functionality here. 🧱
• This release includes some tweaks to our strategy for initially serving our JavaScript bundles to your users. This means faster page loads when users stumble across your documentation for the very first time (since their subsequent requests are cached most of the time). A performance gain is a performance gain, folks—no matter how specific! 🏁
• We've given the API log a new paint job (both in the hub and dashboard)! Now it's easier than ever to view the request and response info and to share the log with others. Curious to see the new look? Check out a sample log here! 🎨
• Slight design tweaks to get our Changelog title headers in line with other sections—can you notice the difference? ☝️

🛠 Fixes & Updates

• As alluded to above, we’re parting ways with the old code that originally fueled the flame of our beloved API Explorer. I won't mince words here, y'all: this code walked so our current React component could run. This legacy code has remained a thorn in our sides (and in our hearts ❤️) for several years now while our current React component implementation has been running the show. While this code removal won't provide any material improvements to your reference documentation experience, we hope you keep those 3,980 lines of code in your thoughts during this difficult time. 🕯️
• Some developments in the global conversation surrounding callout culture: this time in the form of tiny padding fixes for lists within Markdown callouts. (Related, but not really: adrienne maree brown recently came out with a book on the topic!) 🗣️
• Minor URL fixes for Suggested Edits 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]!