Releases: rapi-doc/RapiDoc
Releases · rapi-doc/RapiDoc
Release 9.1.4
Bug Fixes
- Fixes #631 - support for sending reserved chars in the API request as is
- Fixed Dockerfile generation
- Fixed copy/pasting strings into array fields to combine new and old values
- Fixed #606 - handle nulls
- Fixed #584 - markdown list font size fix
- Fixed #575 fixes #581 - annotate readonly object and array fields
- Fixed #577 - search and advance-search consistent show/hide behavior in read and view mode
- Fixed #578 - hide view spec file button if the spec-file is not in json format
- Fixed #576 - spacing for nav-logo slot was leaking to other slots too
- Fixed #570 - api-key with non-bearer scheme contains a leading space
New Features
- Support for storing and recovering API-Keys in local-storage
Release 9.1.3
Patch Release
- Documentation Fixes #557 - Thanks @cooljeffro
- #556 - allow user to hide/show API Spec download links
- #540 - required and deprecated fields should be annotated for form-data
- #563 - fixes callback rendering of certain edge cases - thanks @Wachiwi
- #565 - fixes certain edge cases of
curl
syntax - thanks @fornwall - #566 - fixes certain edge cases of example generation - thanks @jekkel
- #482 - allow scope to be rendered when provided for non-oauth security schemes too (new in OpenAPI 3.1)
- #245 - JSON examples should have quoted keys
Release 9.1.2
Patch Release
- Fixed a minor issue with
undefined
Release 9.1.1
Patch Release
- Fixed a bug introduced in
9.1.0
whereapi-key
is provided was not added to the request header
Release 9.1.0
New Features
- ✨ Introducing new web-component
<rapi-doc-mini>
- an awesome tool to document your APIs in a blog style write-ups - read all about it here - Add badges to your APIs - Example
- Added
update-route
androute-prefix
attributes that provides more control on routing and helps in integration with other frameworks like react, vue, angular, etc. - New methods to Programmatically Update
- API Security Keys
- API Servers
- Example
- Added New slots
<slot="operations-top">
- Added New Events
api-server-change
before-try
after-try
- Added the ability to download OpenAPI-Spec
Fixes and Enhancements
- Loads of enhancements and bug fixes
Release 9.0.0
Breaking Changes
- Default theme has been changed from
light
tolight or dark
based on OS theme settings, it will effect you if you are depending on the default value. It is important to note that OS can have dynamic themedark
orlight
based on factors like time-of-day in such cases RapiDoc's theme will change too, so if you customized other colors or logo then ensure that it has a good contrast in bothdark
andlight
theme or dont depend on the default value and provide your own value fortheme
- Default render-style is changed to
read
fromview
- removed following attributes in favor of
css ::parts
nav-bg-image
nav-bg-image-size
nav-bg-image-repeat
you can read about css parts supported by RapiDoc https://mrin9.github.io/RapiDoc/css-parts.html
- Open Sans Font will be loaded by default from Google Font CDN. (you still have the option to not download it and supply your own font instead)
- default font fallback sequence have been changed to
"Open Sans", Avenir, "Segoe UI", Arial, sans-serif
- RapiDoc auto-generate Tags from the path for operations that do not have any tags associated. Tags in RapiDoc is used for segregating operations into groups. From
v9.0.0
by default tags wont be auto-generated instead all those operations will be grouped underGeneral
category. ( You can still auto generate tags like before usinggenerate-missing-tags = true
attribute but is not a default anymore) - In UI
MODEL
is now replaced with the wordSCHEMA
to better align with industry standard
New Features
- OAUTH flows now includes Proof Key for Code Exchange (PKCE)
- Improved ui-responsiveness, now supports mobile form factor
- Provided
css ::parts
support - #450 provided
before-render
to intercept spec and change it dynamically
Fixes and Improvements
#454 Improved input size distribution
#448 - enum click on parameters section was broken in previous release
Other Changes
- many minor style improvements
- Added and Updated various examples and documentation
Release 8.4.9
Support for Open API 3.1.0 has landed
- Support for Webhook has been added - Example
- OpenAPI 3.1.0 supports Standard JSON Schema, which allows to have multiple data-types for each field - RapiDoc is now fully compliant with this - Example
- Works with swagger
2.0
OpenAPI3.0.x
and OpenAPI3.1.0
New Features
- New
SOLTS
have been added for HTML injection. This allows you to plugin custom functionalities or features from other libraries - Example - Markdown headings for Tag Descriptions can now also appear on the Navbar - Example
- Prettify
xml
responses - #383 added option to deal with
read-only
andwrite-only
properties, you may selectivly hide them in schema based onrequest
,response
orAPI method
- Thanks @sneakyvv for adding in this feature - OAuth authentication can now use relative URLs: Thanks @WouterSioen for adding in this feature
Performance
- Bundle size in this release got a massive reduction of about ~28%. Resulting in faster download and parsing of our JavaScript
- The size reduction is achieved by removing our dependency on
swagger2openapi
and instead using@apitools/openapi-parser
which also helps in a faster conversion - DOM nodes creation have been reduced
- Upgraded our bundler from
webpack-4
towebpack-5
and updated its config, this too reduces bundle size and uses a mordern syntax that do not need any transpilation
Fixes
- #421 Schema Expansion restriction was not respected in certain edge cases
- #425 Nav bar search input in safari was having an height issue
- #433 Character descenders are cut off for schema table heading
- #434, #438 better handling of empty responses- Thanks @sneakyvv for the PR
- #430 too many combinations of
one-of
andany-of
results into generation of many examples that can make browser crash - #432 - documentation fixes - Thanks @JonasPardon
Release 8.4.8
Release 8.4.6
Bug Fixes
- Fixed a bug where clicking on left-nav authentication section wont respond
- #409 Summary and Description is treated differently now
- Improved Array input control to provide multiple values