New Year, New Owlet Weekly Update! This week's update is on the shorter side because we spent the holidays in one of several categories: 1) sleeping and/or watching the Paddington movies, 2) implementing a lot of behind-the-scenes code improvements on our 2020 resolutions list that we've been putting off, or 3) discovering steam from a hot shower destroyed everything in an apartment. Nevertheless, we did ship some exciting updates to the API Metrics Dashboard and made some improvements to our "toasts" to ring in the New Year 🥂 details below!

✨ New & Improved

• This release includes a bunch of little improvements to the API Metrics Dashboard—initial loading improvements, filtering improvements, and an API Users section that loads approximately one-million percent faster than before. 🚀

🛠 Fixes & Updates

• There was a glaring issue where our toast message container (i.e. the little popup in the bottom-right corner that pops up when making certain changes in the dashboard) was occasionally overlapping with our Intercom widget. Well, it's time to give our toast message container a little more space. If you're reading this, toast message container, just know that it's not you, it's us. 🍞
• Tiny fixes to custom HTML in Landing Pages. 🏠

Thanks for reading and for being a part of the ReadMe community, folks! Let's make 2021 a good (or better, at least) one.

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

Hello and welcome to another weekly update! To wrap up this chaotic year, we bring you Slack integration improvements and some extra coats of polish throughout the product. Oh, and good tidings, I suppose? Details below! 🎄

📘

Programming Note

Due to the upcoming extended holiday, this will be our last release of 2020! On a personal note, thanks so much (to all three? maybe four? of you) for taking the time to read these! In what was an otherwise terrible year for basically all of us, being able to regularly and publicly rave about the amazing things my team builds has been a real joy. We'll be back the week of January 4th with some very exciting news—stay tuned!

✨ New & Improved

• We’ve released some huuuuge improvements to our Slack integration with new ways to access the powerful insights that API Metrics has to offer—in the form of new slash commands and a weekly summary digest! You can access insights about your API usage like Top Users, Top Endpoints, and Recent Logs via a slash command. And if you’re too lazy to type words into Slack, the integration will post weekly summaries of your API usage into a Slack channel of your choice! 📊
• In anticipation of our sedentary lifestyles over the holidays, we’ve further slashed away at the bundles that load the project dashboard and your documentation sites. Faster load times and lighter pages for us, everyone! 🔪

🛠 Fixes & Updates

• Good news for you dashboard power users—we’ve made some UI optimizations so you can now furiously alternate between editing and reordering pages without interruptions! 🦸
• We’ve made subtle alignment tweaks to the HTTP methods throughout the project dashboard and your documentation sites. GETs, POSTs, and PUTs have never looked better! 📏
• This release includes a couple little usability upgrades in the sidebar—design improvements for pages with longer titles, collapsibility tweaks, and some scroll fixes! 🖱️

As always, thanks for reading and for being a part of the ReadMe community. Wishing you and your loved ones a safe and enjoyable 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 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]!

Thanks for tuning into another Owlet Weekly Update! This week we're improving dashboard loading times 🚀, shipping zero-config(!) API Metrics 🌱, paying homage to a (scarily relevant) synth-pop music video from the mid-2000s 🎹, and so much more. Let's dive in!

✨ New & Improved

• In most aspects of life, you reap what you sow. There’s no greater example of that than our API Metrics platform—if you take a little bit of time to plant the seeds (the API Metrics proxy or middleware), they will yield a bountiful harvest (a greater understanding of your API users). Well what if you could reap (in a good way!) without doing any sowing? That’s right folks… we’re officially launching Zero-Configuration API Metrics! We’ll have more to say about this soon, but the long story short is that all interactions with your API reference section will now produce API Metrics usage data, meaning that you now get a preview of the insights that API Metrics has to offer with zero setup or configuration! If you like what you see and you decide that you want these insights for every user that interacts with your API, you’re always welcome to plant a few seeds. 🌱
• Great news folks—we now support 3OH!3! Whoops sorry—what is this, the mid-2000s? What I meant to say is that we now support Version 3.0.3 of the OpenAPI specification! And not only that—going forward, all API definitions that are written in our manual editor are now compiled into 3.0.3! The only downside of all of this is that it’s very unlikely that I’ll be able to drop such a topical reference for future versions of the OpenAPI spec. 🎹
• As we continue to build out our OpenAPI support in the API Explorer, it sometimes takes a bit longer to extend certain things to our dear manual API editor users. Well I've good news for y’all: we just added enum support to our manual editor, meaning that reference sections of all creeds can now have their users select parameters from a dropdown list of values! ✅
• Sometimes when loading up a project in the ReadMe dashboard, you may be like me and occasionally use that generous chunk of time to refill your coffee cup, do some laundry, or walk the dog. Well I’m afraid you’re going to adjust your schedule… because we’ve made some significant improvements to our dashboard loading times! 🚀
• This release lays some of the groundwork for upcoming performance improvements to the API Explorer, particularly for you crazy kids out there with massive API definitions. Stay tuned! 🚄
• A few more small improvements to an extremely exciting upcoming ReadMe feature that we have a lot more to say about soon! 🧑‍🍳

🛠 Fixes & Updates

• Much like most of us during quarantine, there were a few specific cases where documentation sidebar links were having trouble staying active. While we can’t afford to give everybody a Pelaton in this release, it does fix the styling on these sidebar links. 👟
• Huge developments in the society’s conversation around callout culture: we were seeing an issue where certain Markdown callouts were missing their body text. Fortunately (or maybe unfortunately, depending on your feelings about callout culture), we’ve restored the body text of these callouts. 🗣️
• A few content width improvements for folks that like to live dangerously (i.e. people that look at API documentation on their phone). 📱
• We added scrollbars to a couple places that needed them, and hid them in places where you didn’t need to see them. 👀
• A handful of little reliability improvements to our code blocks. 🧱
• Tiny improvements to how we bundle OpenAPI documents. 📦
• A few reliability improvements to our PDF generation. 🖨️

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

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

Hello and happy Tuesday Thursday—hope you had a safe and enjoyable Thanksgiving holiday! To offset the absolutely devastating amount of pumpkin pie I consumed last week, we’ve reduced the size of our site bundles, along with a bunch of other good stuff(ing?). Details below! 🥧

✨ New & Improved

• From the people that brought you dash.readme.io comes its equally entertaining sequel—dash.readme.com! You’ve been able to access the project dashboard via dash.readme.com for a while, but you may have noticed your web browser redirecting to the new URL in the last couple weeks. And rest assured, your requests to the ReadMe API should work as normal for the foreseeable future! 🔗
• Much like preparing a turkey for Thanksgiving dinner, preparing an OpenAPI file can be a grueling process that often requires a helping hand. Fortunately, we’ve made a small update to our API onboarding process that makes it even easier to get in touch with our incredible support team! (EDITOR’S NOTE: Please do not contact our support team with your turkey-related inquiries. But if you have a story about your turkey-making experiences this year,tweet at us!) 🤝
• Hey, have you heard about our latest and greatest enterprise feature—Staging? You should definitely hit us up to try it out! We’ve been getting a lot of great feedback on it and have been making a lot of great improvements behind the scenes. This release includes some of those! 🌱
• As alluded to above, we’ve slashed away at the size of our main bundle that’s loaded in on all documentation sites (with more updates to come in the future!). What does that mean? Faster, lighter pages for your users! ⚡
• A few readability improvements to our Node.js code samples in the API Explorer. 🤓

🛠 Fixes & Updates

• Don’t you hate when Google Maps navigates you to your local post office, only for you to pull up to a fenced off building that’s been fully burned to the ground for months? Well fun (and 100% true) fact: that happened to me a few weeks ago here in Minneapolis! In the spirit of Google Maps (which continues to insist that that post office exists and is open despite the feedback I've submitted), I can happily report that this release includes a fix to an issue where certain URLs in ReadMe would 301 instead of 404. Sorry for the misdirection, folks! 🗺️
• A couple of tiny updates to the API logs to make them a little friendlier to response bodies that don’t exactly conform to the JSON way of life (in other words… response bodies that aren’t JSON). 🧬
• Not everyone on our team can be on Shinae’s level, unfortunately. As with releases of yore, this one includes fixes to a few glaring spelling and grammar issues in some of our product copy. ✏️
• Improvements to some of the number-crunching that takes place in the API Metrics Dashboard. 📈

If you haven't already, please take some time to learn about Indigenous rights and the National Day of Mourning. And if you can, please support theIndigenous-led fight to Stop Line 3. Thanks for tuning in and for being a part of the ReadMe community!

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

Hey folks! We have a shortened week here at ReadMe due to the Thanksgiving holiday, so there isn't a release this week for me to make obscure pop culture references about. Fortunately, we do have a Thanksgiving-themed picture of Owlbert to share! Is he dressed as a turkey or a brown peacock? Most likely the former—but you decide!

Thanks as always for being a part of the ReadMe community. Have a safe and enjoyable Thanksgiving weekend!

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

Another week, another set of release notes dedicated to LeBron James! This week we come to you with search improvements, design tweaks, and response examples for days.

✨ New & Improved

• We’re continuing our homage to LeBron James and the example he sets and bringing response examples in the API Explorer to everyone! Previously, you needed to define examples via the example or examples keywords, but now we’re taking it a step further—for any OpenAPI operation that contains a response schema definition, we use those schemas to generate an example response with placeholder data. This even brought response examples to our docs—check it out!
• We’ve added little color customizer in the Enterprise project appearance theme settings to make it a little easier to set your project theme color (used for accent colors in the Search modal, as well as other minor places). 🧑‍🎨
• A few little performance improvements and coats of polish in the dashboard. 💅

🛠 Fixes & Updates

• Our search indexes have had issues with Changelog posts (like these!) for a bit now—sorry, y’all. This release includes some fixes which should bring Changelog posts into your search results over the next few days. 🔍
• Minor filtering fixes in the API Metrics Dashboard. 📈
• A few padding adjustments on Changelog posts and Custom Pages. 📏
• Small touchups to our footer banners. 👣

And lastly, this release (along with most of the releases for the last few months, honestly) includes some work on a soon-to-be-released feature that will really elevate the experience of learning how to use an API. In fact, if you’ve looked at our docs recently, you may have noticed a new section in the navigation bar! We’ll have much more to say in the coming weeks, but if you’re interested in trying it out in your documentation, get in touch. 👀

As always, stay safe, keep voting constantly regardless of what the law dictates (just kidding, please follow your local election laws), and thanks for being a part of the ReadMe community!

—Kanad and the ReadMe Team

(alsohuge thanks to Naomi for taking over for the last couple weeks!)

📘

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

Happy Tuesday, and welcome back to another Owlet Weekly Update! We’ve got some big news this week in the form of a hot new feature. Don't worry, it’s definitely the most important thing that’s happened in the last seven days. Read on to learn all about it, as well as a few other things we’ve been up to!

✨ New & Improved

• One of the major projects we've been working on for a while now rolled out this week. That right, folks, staging is here! Staging is our coolest new feature for customers on our Enterprise plan who want more control over how and when their content goes live. This way, folks can make all the changes they want within a project, affecting things like content, appearance, or project settings, and they'll be immediately viewable to site admins. Once everything looks good, changes can be deployed and become visible on the actual documentation site. Indeed, customers on our Enterprise plan are now able to delete entire chunks of their site, save, and fix it without any actual impact on their docs. (Ok technically this might be true but don't try this. Really.) Check out this blog post for more info on what to do if you're interested in enabling this feature. 🌟

• Also as a part of the staging release, we've given Enterprise customers more control over when they upgrade to the latest version of ReadMe. For those customers with staging, they can choose when to jump to the latest version. The only constraint is that they won't be able to make updates to their site until they do so, to ensure compatibility going forward! 🐼

🛠 Fixes & Updates

• Folks can now use target=_blank in their Markdown to set a link to open in new tab:

  HTML

  <a href="doc:getting-started" target="_blank">Getting Started</a>

• A small security fix to make hackers’ jobs harder! 🧑‍💻

• Straightening out our margins to make our changelog posts even prettier. ✨

That's all for this week, folks! As always, stay safe, continue to exercise your voting rights in any upcoming runoff races and beyond, and thanks for being a part of the ReadMe community!

📘

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

Hello and happy November, folks! Last week we had a whirlwind of a fall offsite. It couldn't have gotten off to a better start, with a livestream of our Owlbert artist Paul Cox drawing a Halloween Owlbert and an I Voted Owlbert. Read on for what else we did in this release, as well as a reminder for something you have hopefully already done today to start this week off just as well as the last!

✨ New & Improved

• We made some architectural changes to the backend of the API Explorer that reduced its bundle size by 11%. Don't worry if that doesn't mean anything to you. Best case scenario, your super vision notices that some pages load slightly faster! 😎
• There was an issue with the discussion post form where it was getting a bit too squished. We've stretched it out to give your thoughts room to breathe! 💬

🛠 Fixes & Updates

• We updated our syntax highlighter to include support for TOML, now the prettiest printed new language on our block. 🌴
• For our Enterprise customers, we fixed an issue in the audit log where category id was showing up undefined. 🌅
• Our SAML flow was having some issues where new users invited to join Enterprise projects received emails inviting them to create ReadMe accounts, rather than sign in through SAML. We've fixed this so new users should have no problems getting access to their projects! 🔓

In case you haven't heard, today's the last day to vote. Go do that! And finally, thanks for reading and for being a part of the ReadMe community.

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

Happy Tuesday Thursday folks! Apologies for the delay on this week’s release—we’ve been spending the week huddled on Zoom for our fall offsite (check out Greg’s Twitter recap of our summer offsite here)! Fortunately, we’ve still been busy—this release includes some great design and performance updates as well as even more refreshed code samples. Details below!

✨ New & Improved

• We’re keeping the “get our JavaScript code samples with the times” energy going from last week and taking it from the server to the browser! This week, we’re finally saying goodbye to XMLHttpRequest in favor of the more widely used Fetch API. See it in action in our API reference by clicking the JavaScript tab above the code samples. 🚂
• A couple eagle-eyed folks noticed that Markdown list elements were ever so slightly different in color than the rest of the text on a page. While we all love a little pop of color from time to time, this wasn’t the time nor place. This release includes a couple touch-ups on that front. 🖌️
• We've included some performance optimizations in this release that should help with the initial load times on your project dashboard—with more optimizations to come soon. 🚀
• The trusty Save button in the dashboard got a nice little refresh! Check it out and let us know what you think. 🎨

🛠 Fixes & Updates

• We had enterprise customers that were running into issues where an Auth0 SAML connection would apply to one enterprise group of projects, but not any of their other project groups. If you’ve ever seen an ad on TV for a $5 footlong only to walk into a Subway that does not in fact honor that deal, you can understand how painful this can be. While we have no control over your local Subway deals, we’ve included some fixes to apply a single SAML connection across all of your project groups. 🥪
• There was an issue within the API Explorer for the last week or so where certain text input fields would lose focus, meaning you’d have to click back into the field after entering each individual character. Great news if you’re an Architect in the Bad Place in need of inspiration, but bad news for everyone else. Fortunately, this release includes a fix for the rest of us. 🌤️
• A couple of small security fixes to further prevent hackers from hackity-hacking into the mainframe. 🧑‍💻
• Some minor circular reference handling fixes in the API Explorer. 🔄

Thanks again for reading and for being a part of the ReadMe community! Go vote! 🗳️

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

Hello and welcome to another edition of the Owlet Weekly Update! Major thanks to our sponsor this week—teenagers! In honor of the teens, we finally get with the times and add node-fetch support to our API Explorer. Read on for this and all of the other #hip features and improvements that were shipped in this release! 🛹

✨ New & Improved

• As many of you vape-loving, Node.js-using teens out there are aware, the request module is sooooo last year and was officially deprecated this past February. Despite all the time that has passed, the Node.js code samples in the API Explorer still used request… until now! With this major release (version 🎱 of the API Explorer, for those keeping score), we’re finally boarding the node-fetch train. Toot toot! 🚂
• This release also contains some big improvements to our GitHub Integration. Now, the workflow validates your OpenAPI/Swagger file prior to upload, takes advantage of our wonderful new(ish) API error messages (long overdue, sorry folks!), and includes some new debug logging options which should make troubleshooting a breeze. 🍂
• As with everything we do here at ReadMe, we're always striving to make our API Explorer as inclusive as possible. Well as of this release, the API Explorer officially supports HTTP headers of all shapes and sizes—in other words, it now preserves casing! See here for a demo. 🔠
• Have you tried out the api code samples in your reference section yet? Well there’s no better time than the present—this release includes even more improvements on that front. 🚀
• Good news for documentation that contains a subtle shoutout to ReadMe in the footer—we’ve made a few design tweaks to make the shoutout a little bit more elegant and subtle. 🎨

🛠 Fixes & Updates

• Some of you were seeing a completely baffling “duplicate key error” message when trying to update your API specification via a PUT request. Major apologies if this caused you to completely question your sense of reality. While I can only partially assure you that this is real life, I can say with confidence that this release includes a much clearer error message (and in case you’re wondering—yes, the error contains a poem). 🖋️
• As mentioned last week, we made some navigational improvements to our knowledge base! This release includes some housekeeping to make sure that our documentation links are up-to-date. (And if you see any broken links, please let us know!) 🔗
• Minor bug fixes for projects that downgrade (or upgrade, depending on perspective) to ReadMe Free. 📈
• Other general stability improvements to the API Explorer. 🔧

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

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