Releases: rapi-doc/RapiDoc
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
Release 8.4.2
Bug Fix release
- Fixes an issue with expand/collapse functionality in JSON examples
Release 8.4.0
New Features
#347 - adds functionality to fill and clear request parameters with example
#307 - allow hiding side navigation bar
#268 - allow arranging path by summary
Changes
#344 - display tags Navigation Bar and View Mode in primary color
#338 - do not allow to set cookies in security scheme
Fixes
#257 - array of array in schema is now represented properly
#334 - curly braces in links should be replaced with hyphen(-) to avoid url-encoding
#333 - remove duplicate accept header params from curl syntax
#343 - removes trailing from curl syntax if there is not query-string value provided
#342 - add support for more media types in api-request other than just application/octet-stream
#306 - do not reset form after try - remove 2-way live binding
#320 - do not send redirect_uri
in OAuth to fetch access-token for client-credential
flow
#353 - remove cache-control header from request
#349, #350, #351 - Various improvements and fixes was added by @sneakyvv for displaying complex schema structures and generating examples. Thank you @sneakyvv !!!
Release 8.3.0
New Features
- Added Advance Search functionality. One of the top requested feature. Thanks to @poadoc for the PR
- when
show-components=true
the NavBar will display only the components that’s referenced in the spec. Thanks to @d-mo for the PR - In
render-style=focused
andshow-component=true
components are shown only when there are selected on the nav-bar. Thanks to @d-mo for providing this feature - oAuth selected scopes are now included as a part API calls. Thanks to @JakobTeske for the PR
- Improved rendering of
one-of
options #331 - #289
allow-try
andallow-server-selection
are now decoupled
Fixes
- Fixed #329 and #328 which was ignoring
api-key
security scheme. Thanks to @aravindanve and @dagnelies for pointing and taking care of this - Fixed a bug where example defined directly on array was ignored. Thanks @trebler for taking care of this
- Fixed #330 -
arrays
inone-of
options were not tagged as array - Fixed #311
- Fixed #309
- #292 fixed an issue with Request and Response Body Examples
- #290
$$ref
shown in responses when using external refs
Documentation Fixes
- allow-try documentation is updated thanks @waldyrious for the PR
Release 8.2.0
New Features
New attribute use-path-in-nav-bar = (true/false)
allows you to display api-path or summary on the nav bar in read mode. Thanks @poadoc for the PR
#269 : Support for multiple examples for path and query-string parameters
Bug Fixes
#277 - Only the Security schemes applicable to the operations are shown. Thanks @ShaneBoyer for the PR
#276 - In focused mode examples were not getting refresh upon switching from one operation to another
#281 - default-schema-tab
attribute should be honored in request-body
#282 - in certain cases examples are not getting generated when it contains an array
#283 - Passwords should be obscured in parameter input boxes
#263 and #267 - Security annotations were incorrect and was overlapping
Release 8.1.2
If you look inside the minified code, you will find it is tagged with
v8.1.1
However the actual source is from8.1.2
this is happening due to a glitch in our build pipeline. we are working on it to fix the issue. For now please ignore this issue
Bug Fixes
- #234, #266 form-data fields should show schema info
- #236 Indicate proper API key near the TRY button
- #238 for missing type in schema, do not overwrite the description
- #249 Remove charset utf8 (thanks @Uzlopak for the PR)
- #259 Request body Examples JSON should be stringified
Improvements
- Components on the left bar is clickable (Thanks @dahu33 for PR #265 )
- #233 Improved Markdown style for response header description
- #240 Various style enhancements
- Add support for enums in server variable object (Thanks @siavashs for the PR #250)
- API responding with images can be viewed (Thanks @meztez for the PR #252)
Release 8.1.1
Release 8.1.0
New Features
- A new
render-style
focused
is added to show one operation at a time - Now all colors can include transparency
- Navigation bar can include background images
Bug Fixes
#198 - Schema Example of object/array should be shown using json-tree
#201 - do not change server-url to lowercase
#204 - markdown Heading renderer should generate correct internal html id's
#208 - restore original example after changes are made to an example and switched to another one,
#206 - Rendering of examples with date object
#200 - include apiKeyId in oAuth display for user to relate them when multiple security scheme exist
#219 - Change expand/collapse text to single-line/multiline which controls how model field descriptions are shown
#220 - ensure that user defined parameters in authorized URL are included in authorize request
Others
- Added examples on how to use with various frameworks (React/Vue)
- Added many new examples
- Added examples to show various branding ideas’
- Performance tips
Release 7.5.1
New Features
- Added Support for
Client Credentials
andImplicit
OAuth flows
Others
- Added OAuth Instructions on how to set it up with RapiDoc
- Provided OAuth examples for various flows