Changelog #001

October 19th, 2023 - Scalar OSS Launch

New updates and improvements to Scalar. Follow us on twitter for realtime updates

Last week we open-sourced our OpenAPI/Swagger Documentation & Editor product, feel free to check it out here Swagger Editor & GitHub

We got tons of amazing feedback & usage from our users, and were able to ship lots of features & fixes this week; let’s dive in!

OpenAPI/Swagger Model Rendering

Now we showcase any models or schemas from your spec inline, a great improvement if you need to dive deep into a schema

Autoscroll Sidebar

The sidebar scrolls with you as you’re reading the API Documentation for your OpenAPI/Swagger spec. A small detail but it really augments the experience.

Syntax Highlighting to the Markdown Renderer

We added proper highlighting to the markdown renderer, and it takes in the theme variables so it can be fully tailored to your brand with our custom theme-ing.

Interactive Rest API Client parameters, headers, queries

Before we only rendered the parameters, headers & queries based on your API spec, now we allow any additional values to be added

Fixes & Improvements

fix: search modal not scrolling to proper endpoints
ensure endpoint parent tag is open before trying to scroll
fix missing property description
Mobile improvements and layout fixes + consitency improvements
polish up the models
feat: add example request body to example request generator
refactor: move generateRequest helpers to @scalar/api-reference
fix: add missing null check to jsonRequest requestBody
feat: show models ("schemas") in the reference
feat: add support for oneOf, anyOf, allOf, not schema rules
fix: add null check to tag operations in sidebar
fix: default show endpoint when tags have one endpoint
fix: better deal with empty descriptions
feat: use default value in schemas for example responses
refactor: new section components, new sidebar
Fix overflow and scrolling issues for API client
chore: update README
feat: add requestbody to api client if json schema available
Fix references not respecting height on mobile Safari
feat: show headings with a higher depth in the sidebar
fix: externalize markdown plugins to not break SSG
feat: add markdown headings to the sidebar
feat: fix import URL, use proxy to fetch files
style: update the search modal style
Add mobile menu and breadcrumbs

We are incredibly grateful for the Scalar community, all the feedback has been truly inspiring and we are looking forward to releasing more features and fixes for the next changelog ✨

Join us:

Marc

CEO & Co-Founder, Scalar