RapiDoc

New Features

• Added option to sort endpoints by method #119
• Added option to provide response are height #110
• Location hash bar now gets updated when expanding or collapsing endpoints #118. Thanks @Lifeclue for providing code snippet to do this

New Features

• Added support for dynamic form params
• Multiple files can be uploaded using form-data and request body

Fixes

• Fixed #105 (unable to set api-key using java script)
• Fixed #95 (markdown for table cell alignment was not behaving as expected)

Bug Fixes

• Fixed api-server supplied using attribute was not getting selected #94

New Features

• Added support for callbacks #83

Bug Fixes

• Deprecated end-points were not marked as deprecated in read-mode #91
• In read-mode logo must show up when search is hidden https://github.com/mrin9/RapiDoc/pull/87 Thank you for your contribution @karlkilgi
• Tag links on side bar in certain cases were not working, has been fixed #92

New Features

• Added support for Server variables #88

Documentation

• Fixed a typo in API docs https://github.com/mrin9/RapiDoc/pull/86/commits Thank you @karlkilgi
• More examples added
  • Added example to show how to load url from address bar
  • Added example to show how to provide server variables

New Features

• New attribute goto-path to take user to get the focus desired path when the document loads
• New attribute sort-tags to optionally sort the tags alphabetically
• New method scrollTo(path) to programmatically navigate to various section
• Can use markdown to create links to various section of documents
• Now you can Copy examples in you clipboard by clicking

FIxes

• URL-Encoading of path variables #81
• Trailing commas in auto-generated example is removed #78
• fixed field format info getting printed twice #74

Breaking Changes

• Removed support for api-list-style group by path option. The following attributes no longer have any effect
  • api-list-style
  • allow-api-list-style-selection

New Features (Custom Themes)

Custom themes are now possible , instead of just light and dark themes. Checkout some sample schemes in the example https://mrin9.github.io/RapiDoc/examples/themes.html

following are new attributes added to support custom theming

• bg-color
• text-color

Bug Fixes

• Fixed a regression where api-key-value was not working as expected #72
• Properly handle query params which are array with the option of explode=false #69

Bug fix release

• Fixed an regression to relax spec conversion rules #67
• Give preference to user supplied example in request body #68
• main content was shrinking a little when hovered in view-mode

New Features

provided options to customize navigation bar

• nav-bg-color
• nav-text-color
• nav-hover-bg-color
• nav-hover-text-color
• nav-accent-color

New options to control schema and description expansion

• schema-expand-level (to control the depth of schema to be expanded)
• schema-description-expanded (to control initial display of field description)

New Slot added to display content on navigation bar

Bug Fixes

• Fixed a issue where auto selection of api server was not working #65. Thanks to @peterbroadhurst for the PR
• Improved scrolling behavior for navigation bar

Others

API Documentation is updated

Breaking Changes

• allow-api-list-style-selection option is now false by default (it used to be true)

UI Changes

• Only one response status code is visible at a time. Earlier all status codes were laid out one below the other

New features

• A new way to present your spec thats suitable for reading Demo
• Multiple way to display schemas (Object Notation and Tabular Notation)
• Added Support for Dynamic Query parameters #61
• Schema-Tree- all the descriptions (at any level) are now aligned. they are minimized by default

Bug Fixes

• Taken care of a case where example can contain recursive references
• calling loadSpec() will not wipe out certain attributes #62
• User-defined examples (block of xml, text or json ) are rendered as expected

Others

• Added more documentation, examples and test cases

Fixes

• #57 support for array examples
• #58 extra white space in response text taken care of
• #53 Showing default value (if exist) for parameters and schema models

New Features

• New option to group APIs by tag or by path
• New option to disallow api server selection by @FlaxHaxx

Fixes

• Required field indicator is now color coded

Changes

• Added support for nested all-of , one-of and any-of combo

Bug Fixes

• example generation for certain corner cases is taken care of

Others

• Added more examples
• upgraded packages

Ignore this release

New Feature

• Added loadSpec() method to allow programmatically loading json spec objects

Bug Fixes

• Display contact information and Terms from the spec
• Disable TRY button during the API call
• Display appropriate error for incorrect spec location

Bug Fixes

• Incorrectly using query-string delimiter when sending api-key in query-string
• fixed double encoding of query-string params
• incorrectly assuming ceratain fields in the spec to be mandatory

Bug Fixes

• If server or host is not specified in spec , then it is defaulted to location.origin
• In swagger-v2 spec if scheme is not specified then it is defaulted to location.protocol
• API Response description now supports markdown

Bug Fixes

• Fixed few issues while dealing with multiple security scheme