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 where api-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 and route-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 to light 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 theme dark or light 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 both dark and light theme or dont depend on the default value and provide your own value for theme
• Default render-style is changed to read from view
• 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 under General category. ( You can still auto generate tags like before using generate-missing-tags = true attribute but is not a default anymore)
• In UI MODEL is now replaced with the word SCHEMA 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 OpenAPI 3.0.x and OpenAPI 3.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 and write-only properties, you may selectivly hide them in schema based on request, response or API 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 to webpack-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 and any-of results into generation of many examples that can make browser crash
• #432 - documentation fixes - Thanks @JonasPardon

Release 8.4.8

Bug Fixes

• #416 Fixed a minor rendering issue in focused mode
• #418 Fixed a runtime console error when summary and description both are missing from a path

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

Release 8.4.5

Release 8.4.5

This is a code refactoring release, which also improves the performance for certain cases.

Bug Fixes

#413 Fixed missing placeholder text for tag-inputs
#412 now correctly processes responses that is other than utf-8 charset Thanks @GeorgopoulosIoannis

Release 8.4.4

Release 8.4.4

New Features

#400 - Added support for collapsible navigation bar tags in render-style = focused
#401 - added new vendor extensions x-client-id and x-client-secret to pre fill authentication section
#355 - Added new event after-try
#389 - Now added support for vendor extension x-codeSamples (x-code-sample is still supported)
#407 - Improved quick search user experience Thanks @poadoc
#404 - Show Tag Name on top in render-style = focused

Bug Fixes

#402 - min and max schema-constrained was not showing up in schema-style = table
#405 - fixes a runtime console error when c-code-sample is not correctly formatted
#395 - Selected accept-header from response is used when making API calls
#392 - reset response text when changing from ope operation to another
#391 - removed extra trailing comma from schema tree display
#394 - enter-key unicode symbol with more common one that’s available on various linux distro Thanks @jamesvl
#393 - display pattern constraint in request Thanks @little-inferno
#388 - code-refactoring - rename advance-search to advanced-search in code to be inline with UI Thanks @waldyrious

Documentation

• Added new examples to show usage of vendor extensions
• Added example to perform realtime API request
• #384 - Various grammar fixes in readme Thanks @sneakyvv
• #387 - Various grammar & spelling fixes in readme Thanks @waldyrious

Release 8.4.3

Fixes

#368 - Improve labeling of schema one-of and any-of options thanks @sneakyvv
#371 - Improve Info section styling thanks thanks @sneakyvv
#372 - XXX-OF label at the top of a model table is improved thanks thanks @sneakyvv
#376 - reset response state in focused mode
#369 - Tag click in focused mode was broken thanks @Dharmendra205111014