Skip to content

Releases: rapi-doc/RapiDoc

Release 7.1.1

26 Jan 21:54
Compare
Choose a tag to compare

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

Release 7.1.0

12 Jan 10:12
Compare
Choose a tag to compare

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)

Release 7.0.4

26 Nov 17:41
Compare
Choose a tag to compare

Bug Fixes

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

Release 7.0.3

25 Nov 06:10
Compare
Choose a tag to compare

New Features

  • Added support for callbacks #83

Release 7.0.2

23 Nov 19:16
Compare
Choose a tag to compare

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 #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

Release 7.0.1

08 Nov 08:50
Compare
Choose a tag to compare

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

Release 7.0.0

03 Nov 19:33
Compare
Choose a tag to compare

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

Release 6.0.2

24 Oct 16:47
Compare
Choose a tag to compare

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

Release 6.0.1

24 Oct 07:03
Compare
Choose a tag to compare

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

Release 6.0.0

22 Oct 00:17
Compare
Choose a tag to compare

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