New Features

• #963 - added support for 'show-curl-before-try' in rapi-doc-mini
• #907 - provide css part for tab-panel, tab-btn-row, tab-btn, and tab-content
• #920 - Improved security-scheme handling to work with incorrectly defined or empty list

Bug Fixes

• fixed #920 - filter valid securitySchemes before rendering
• fixed #997 - value in JSON example were not suffixed with comma if it it is not the last field
• fixed #942 - Do not show header if user has opted to not show during when spec not found error
• fixes #1039 - default content-disposition response header to blank if missing

Other Chores

• Documentation and Example updates
• Bumped packages
• fixed path alias in jsconfig.json

New Features

• Introduced a new badge type to the existing x-badge vendor extension.
• Added ability to select or exclude endpoints based on audience focus, e.g., hide internal endpoints for customers but show all to developers.
• Enhanced responsive layouts when RapiDoc is embedded inside other HTML elements.
• Shifted to modern CSS @container queries, replacing @media queries.
• Upgraded the OpenAPI parser for better compliance and performance.

Bug Fixes

• Resolved #846 and #829: deprecation marks now appear for array type fields in schema views.
• Fixed #894: request headers can now be sent when defined in an object format.
• Addressed #897: example generation now works properly for schemas using primitive types.
• Fixed #903: improved text-selection color contrast.
• Resolved #930: advanced search now considers both summary and description.
• Fixed #996: removed trailing slashes from curl syntax in "copy to clipboard."
• Added support for encoded Content-Disposition headers (fix #1001).
• Fixed #1026: removed redundant dropdown for server selection.
• Fixed #1034: allow spec to have empty server array
• Updated documentation for #847 and #720.
• Ensured orphan tags are detected, preventing unclosed tags in web components.

Chores

• Performed code cleanup.
• Updated documentation.
• Added new test cases and examples.

Fixed a minor regression #1025

• Performance Improvement
• Major upgrades to core packages
• Several minor bug fixes and new features

Release 9.3.4

--

Enhancements

• Added new css parts from api-response area to allow more style customization
• #773 - allow changing navbar search section styles
• Graceful handling of application/x-ndjson content type.
• Improved Request Parameter example description and summary rendering
• #769 - XML formatting performance improvement

Fixes

• #757 - ReadOnly and WriteOnly schema attributes are better aligned with the spec and considers Webhook and Callbacks
• #771 - Clear previous response text before fetching (helps with slow responses)
• #768 - honor response-area-height attribute
• #762 #776 - x-fill-example vendor extension for array was not working as expected
• #726 #763 - Example in focused mode should reset to original on navigating from one endpoint to another
• #775 gotoPath in focused mode was broken

Enhancements

• #682 - Color coded method names on navigation bar Example
• Schema and JSON trees now highlights matching braces on hover
• #686 - vendor extension to allow stopping of auto-filling parameter values
• #681 - Improve readability and discoverability of description and constraints in schema
• #700 new vendor extension to pre-set receiving oauth token location to header or request-body
• #710 - show schema title in schema even when description is not provided
• Allow resizing API response div - helps to read large responses
• #708 #685 allow examples to be listed using the description/summary
• #755 #742 Exported new css parts
• #752 - Use title instead of the text 'Overview' in navbar

Fixes

• #687 - deprecated parameter indicator for query and path params.
• fixed method class name that was conflicting with prism css class
• #724 remove double quotes from filename when downloading binary/file responses
• #714 - render optional auth as 'none'
• #738 - Button element for clear-filter on navbar
• fix request parameter table rendering (missing borders in certain cases)
• #727 readonly and writeonly schema for webhooks and callbacks are inverted

New Features

• Upgrade to lit 2.0 our core framework for rendering
• #602 Added ability to style deeply nested components like TRY button Example
• #637 - Allow aborting TRY (fetch request)
• New Event request-aborted added (fires when fetch request is aborted)
• #662 Added new vendor extension x-default-scopes that supports pre-selecting oAuth Scopes - **Thanks @micheletriaca **
• #622 - added support for rendering application/jose content type

Bug Fixes

#592 - Array Min and Max constraints were being ignored
#626 - Titles in schema were not being rendered
#591 - Query Parameters were not rendered if the values are 0 or false - **Thanks @micheletriaca **
#670 - Improved parameter rendering alignment

Other Changes that might effect UI rendering

• Default tab of schema now displays EXAMPLE (instead of SCHEMA). Use default-schema-tab = "schema" to retain previous behavior

Fixes

• #658 fixed broken integration with vue-js 2

New Features

• #639 provision non-minified build along with minified and generate sourcemap

Bug Fixes

• #641 - honor route-prefix when manually providing routes on location bar
• #648 - ref resolving for certain corner cases were not working as expected due to an issue with swagger-client is now handled

Others

• Improve docker documentation
• released latest docker Image
• Updated ESLint to version 8+
• Updated other packages

release 9.1.5 and 9.1.6 are deprecated and should not be used

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

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

Patch Release

• Fixed a minor issue with undefined

Patch Release

• Fixed a bug introduced in 9.1.0 where api-key is provided was not added to the request header

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

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

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

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

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

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