Skip to content

Latest commit

 

History

History
919 lines (464 loc) · 16.7 KB

CHANGELOG.md

File metadata and controls

919 lines (464 loc) · 16.7 KB

Changelog

6.1.0 (01.02.2024)

Added an option to sort method groups by name.

6.0.0 (06.06.2023)

Dropped support for Node.js 12.

Also removed one-letter definitions of some CLI flags.

Check the migration guide for details.

5.4.2 (27.05.2023)

Restored lost trim in stringify function.

5.4.1 (25.05.2023)

Fixed an error after options selection in OneOf in a Message structure.

5.4.0 (19.05.2023)

Added an option to provide a custom favicon.

5.3.2 (11.05.2023)

Simplified caching of data structures.

5.3.1 (27.02.2023)

Added a workflow to build and push Docker image.

5.3.0 (09.01.2023)

Implemented i18n support. Now you can pick a locale using --locale flag.

ru and en are available for now. Default is en.

5.2.1 (05.09.2022)

Fixed simultaneous highlighting of menu items of the same level.

5.2.0 (24.08.2022)

Improved styles used when user prints the documentation.

5.1.1 (22.08.2022)

Updated @svgr/webpack to fix potential vulnerability.

Also, replace react-highlight with react-lowlight to fix another one potential vulnerability.

Potentially the overall potential of the package is less potentially vulnerable than ever before.

5.1.0 (27.07.2022)

Added an ability to use Markdown in attributes descriptions.

5.0.1 (14.07.2022)

Switched to [email protected] instead of 0.14.0, because 0.14.0 is buggy.

5.0.0 (14.07.2022)

Published the package on Github and added LICENSE file.

4.17.0 (13.04.2022)

  • Improve parsing of actions.

4.16.2 (18.02.2022)

  • Delete private link to the tutorial.

4.16.1 (18.02.2022)

  • Set uniqueName for global variables in webpack build.

4.16.0 (26.01.2022)

  • Update domain to be set in a dark-theme cookie.

4.15.0 (30.12.2021)

  • Replace a fork of react-aria-modal with the original package.

4.14.0 (28.12.2021)

  • Replace a fork of commonmark.js with the original package.

4.13.0 (11.12.2021)

  • Run Lawyer.

4.12.0 (10.12.2021)

  • Update border color of checkbox according to design.

4.11.1 (03.11.2021)

  • Fix page reload after documentation is changed.

4.11.0 (21.10.2021)

  • Update dependencies to support Node 14.18.0.

4.10.0 (20.10.2021)

  • Use node:14.18.0-stretch-slim as a base Docker image.

4.9.0 (07.10.2021)

  • Reduce size of the resulting bundle.

4.8.3 (07.10.2021)

  • Fix manual search page.

4.8.2 (28.09.2021)

  • Replace JENKINS_URL env variable with CI variable.

4.8.1 (28.09.2021)

  • Fix memory overflow error when parsing a large documentation.

4.8.0 (08.09.2021)

  • Update text in the help dialog according to design.

4.7.0 (06.09.2021)

  • Update text in the help dialog according to design.

4.6.0 (06.09.2021)

  • Delete irrelevant information about Jenkins from the readme file.

4.5.0 (06.09.2021)

  • Fix paddings in the help dialog.

4.4.0 (01.09.2021)

  • Add a tutorial link to the help dialog.

4.3.2 (01.09.2021)

  • Repair favicon of a generated HTML file.

4.3.1 (20.08.2021)

  • Update key by which data structures are cached.

4.3.0 (20.08.2021)

  • Setup notification about new releases.

4.2.1 (13.08.2021)

  • Fix page reload after files update if a doc.apib file is in a subdirectory.

4.2.0 (22.07.2021)

  • Use kaniko to build a Docker image.

4.1.2 (19.07.2021)

  • Fix parsing of URI parameters that contain symbols "~", ".", "-".

4.1.1 (28.06.2021)

  • Fix setting of backgroundLocation after page first loading.

4.1.0 (28.06.2021)

  • Fix elements behaviour in case of small viewport width.

4.0.0 (24.06.2021)

  • Use Crafter v3.

3.53.0 (04.06.2021)

  • Add a popup with information about Blueprinter-frontend features.

3.52.0 (20.05.2021)

  • Add the ability to include a custom css file.

3.51.0 (18.05.2021)

  • Create a new release after merging to master.

3.50.0 (18.05.2021)

  • Use CheckboxField component to render options in OneOf.

3.49.0 (17.05.2021)

  • Generate body examples from templates that contain all One Of options.

3.48.0 (15.04.2021)

  • Add dark theme.

3.47.2 (14.04.2021)

  • Fix rendering of nullable enums.

3.47.1 (02.04.2021)

  • Fix rendering of falsy default values.

3.47.0 (02.04.2021)

  • Update gitlab-ci configuration.

3.46.2 (29.03.2021)

  • Update repository links.

3.46.1 (29.03.2021)

  • Delete no_proxy variable.

3.46.0 (25.03.2021)

  • Separate test and build jobs.

3.45.3 (24.03.2021)

  • Package auto publishing.

3.45.2 (22.03.2021)

  • Setup node_modules caching.

3.45.1 (22.03.2021)

  • Disable pipeline for tags.

3.45.0 (19.03.2021)

  • Delete fibers.

3.44.0 (12.03.2021)

  • Update test documentation.

3.43.0 (05.03.2021)

  • Update elements style after moving to Figma.

3.42.0 (05.03.2021)

  • Display formatted description of requests and responses.

3.41.1 (05.03.2021)

  • Fix hot reload error in dev mode.

3.41.0 (04.03.2021)

  • Implement sidebar folding/unfolding.

3.40.1 (04.03.2021)

  • Correctly search messages without any content (without attributes).

3.40.0 (04.03.2021)

Update caniuse-lite version.

3.39.0 (26.02.2021)

  • Show a description of a One Of element.

3.38.0 (25.02.2021)

  • Add unit tests.

3.37.1 (18.02.2021)

  • Fix overflow of side navigation.

3.37.0 (16.02.2021)

  • Run dependencies audit.

3.36.3 (15.02.2021)

  • Add babel-plugin-transform-react-remove-prop-types plugin.

3.36.2 (08.02.2021)

  • Fix including refract tree in a HTML file.

3.36.1 (05.02.2021)

  • Fix rendering of attributes in Messages section.

3.36.0 (26.01.2021)

  • Add adapted version of HTML document to print it as a PDF file.

3.35.3 (20.01.2021)

  • Fix redirect to URL without groups or resources.

3.35.2 (20.01.2021)

  • Fix interaction with value attributes.

3.35.1 (20.01.2021)

  • Fix attribute unfolding after double click.

3.35.0 (31.12.2020)

  • Update to crafter v2.

3.34.0 (25.12.2020)

  • Use monospace font in code blocks.

3.33.0 (30.11.2020)

  • Update markup of error page.

3.32.0 (24.11.2020)

  • Optimize functions "fillAdditionalAttributes" and "resolveSourceElementInheritance".

3.31.0 (18.11.2020)

  • Display attributes of Attributes section.

3.30.0 (13.11.2020)

  • Display "fixed" attribute in the attributes list of nested members.

3.29.0 (26.10.2020)

  • Optimize fonts and target browsers.

3.28.1 (26.10.2020)

  • Fix an error caused by adding anchors to description headings.

3.28.0 (12.10.2020)

  • Use a separate logger to output warnings during refract generation.

3.27.0 (21.09.2020)

  • Display extended error information.

3.26.0 (16.09.2020)

  • Fix warnings and errors in the project and in the sandbox.

3.25.6 (15.09.2020)

  • Fix nested types of a named type extracted during inheritance processing.

3.25.5 (04.08.2020)

  • Fix watching of apib files.

3.25.4 (24.07.2020)

  • Fix sidebar navigation behaviour when a resource with a custom anchor is opened.

3.25.3 (24.07.2020)

  • Fix rendering of an action with a repeating parameter.

3.25.2 (23.07.2020)

  • Fill in array attributes.

3.25.1 (21.07.2020)

  • Improve displaying of a Crafter error.

3.25.0 (17.07.2020)

  • Improve check of a MemberTypeGroup section in a named type.

3.24.0 (16.07.2020)

  • Improve displaying of recursive attributes.

3.23.0 (09.07.2020)

  • Improve README.md.

3.22.0 (08.07.2020)

  • Update Crafter to 1.57.0.

3.21.1 (08.07.2020)

  • Generate routes without curly braces.

3.21.0 (07.07.2020)

  • Add headers to a response description.

3.20.3 (22.06.2020)

  • Fix processing imports inside of an imported file.

3.20.2 (22.06.2020)

  • Fix parsing of a Resource section that comes after a Resource Prototypes section.

3.20.1 (22.06.2020)

  • Fix rendering of a Crafter error without a source map.

3.20.0 (22.06.2020)

  • Detect first node of an imported file.

3.19.0 (17.06.2020)

  • Use Node.js 12.16.3 as the base Docker image.

3.18.1 (11.06.2020)

  • Account presence of recursive data structures.

3.18.0 (29.05.2020)

  • Rework routes generation.

3.17.0 (20.05.2020)

  • Fix rendering of URI parameters that have star symbol.

3.16.0 (15.05.2020)

  • Add support of recursive objects.

3.15.0 (24.04.2020)

  • Add the page for manual search.

3.14.2 (21.04.2020)

  • Fix restart of a local dev server.

3.14.1 (15.04.2020)

  • Add data type to Attributes section.

3.14.0 (15.04.2020)

  • Improve rendering of attributes in data structures.

3.13.2 (14.04.2020)

  • Delete definitions of inherited types.

3.13.1 (09.04.2020)

  • Fix displaying "0" in enum types.

3.13.0 (08.04.2020)

  • Display samples of attributes with nested content.

3.12.3 (07.04.2020)

  • Fix rendering of elements of the side navigation.

3.12.2 (07.04.2020)

  • Fix error caused by incorrect mime-type in dev mode.

3.12.1 (31.03.2020)

  • Fix navigation between search results using a keyboard.

3.12.0 (30.03.2020)

  • Focus on the search field when «slash» key is pressed.

3.11.0 (30.03.2020)

  • Improve displaying of search results.

3.10.0 (27.03.2020)

  • Implement new algorithm of search.

3.9.3 (23.03.2020)

  • Add a check for member fields precedence.

3.9.2 (23.03.2020)

  • Fix displaying samples of an attribute.

3.9.1 (20.03.2020)

  • Fix lists rendering.

3.9.0 (20.03.2020)

  • Collapse sections with a schema.

3.8.0 (20.03.2020)

  • Highlight URL parameters in a sample of a response.

3.7.0 (27.02.2020)

  • Update dependencies.

3.6.1 (25.02.2020)

  • Update react-hot-loader.

3.6.0 (18.02.2020)

  • Use local webpack configs.

3.5.2 (18.02.2020)

  • Add a check for unique response.

3.5.1 (18.02.2020)

  • Refactor side navigation.

3.5.0 (12.02.2020)

  • Use Roboto font and fix styles of the sidebar.

3.4.1 (12.02.2020)

  • Fix parsing of URI parameters that have star symbol.

3.4.0 (10.02.2020)

  • Improve highlight of code punctuation.

3.3.1 (03.02.2020)

  • Delete constraints of search query minimum length.

3.3.0 (28.01.2020)

  • Add the ability to open resulting HTML file without any web server.

3.2.1 (24.01.2020)

  • Fix eslint dependencies installation.

3.2.0 (23.01.2020)

  • Add strict build mode.

3.1.0 (09.01.2020)

  • Display HTTP methods names in uppercase.

3.0.0 (27.12.2019)

  • Implement new design.

2.26.0 (24.12.2019)

  • Fix webpack errors during building.

2.25.2 (20.12.2019)

  • Fix hashes of untitled resources.

2.25.1 (20.12.2019)

  • Fix scroll to anchor in Firefox.

2.25.0 (08.11.2019)

  • Show first line of a request description in tabs header.

2.24.1 (06.11.2019)

  • Fix resulting status of a build containing a Crafter error.

2.24.0 (17.10.2019)

  • Cancel collapsing of a resource and its only action in the navigation in the left column.

2.23.0 (08.10.2019)

  • Update dependencies.

2.22.0 (08.10.2019)

  • Keep generated refract in memory instead of an external file.

2.21.1 (07.10.2019)

  • Fix display of a resource without a title in the left column.

2.21.0 (03.10.2019)

  • Update vulnerable dependencies.

2.20.1 (03.10.2019)

  • Fix display of "0" or "false" used as an example.

2.20.0 (02.10.2019)

  • Add Dockerfile to build an image.

2.19.0 (30.09.2019)

  • Use HTML comments to override anchors.

2.18.0 (19.09.2019)

  • Add parsing of Schema types.

2.17.2 (11.09.2019)

  • Fix server_name for https.

2.17.1 (03.09.2019)

  • Fix NGINX config.

2.17.0 (03.09.2019)

  • Use source apib file to generate refract stub.

2.16.0 (30.08.2019)

  • Improve watching of files being used to build the doc.

2.15.7 (23.08.2019)

  • Fix parsing of imported docs with the Headers section.

2.15.6 (20.08.2019)

  • Improve error message when expected block is not found.

2.15.5 (15.08.2019)

  • Fix rendering of enum elements in Attributes section.

2.15.4 (07.08.2019)

  • Fix null values rendering when "minimum" parameter is used.

2.15.3 (30.07.2019)

  • Fix generation of URI parameters description.

2.15.2 (29.07.2019)

  • Correctly require @funbox/free-port-finder lib.

2.15.1 (29.07.2019)

  • Update version of @funbox/free-port-finder.

2.15.0 (23.07.2019)

  • Create a directory for the output file.

2.14.1 (08.07.2019)

  • Render URI parameters with star modifier in the resulting url.

2.14.0 (17.06.2019)

  • Add attributes non-nullable and optional to object fields.

2.13.0 (14.06.2019)

  • Display JSON schema of Message sections.

2.12.0 (11.06.2019)

  • Display errors and warnings from Crafter.

2.11.2 (08.06.2019)

  • Generate correct body for a primitive type that lacks sample.

2.11.1 (06.06.2019)

  • Fix rendering of menu with resources which contain only a description.

2.11.0 (04.06.2019)

  • Display SubGroup and Message sections.

2.10.3 (04.06.2019)

  • Fix parsing of an empty response body in Crafter.

2.10.2 (29.05.2019)

  • Fix parsing of attributes of named types.

2.10.1 (25.05.2019)

  • Fix missing indentation of code block.

2.10.0 (23.05.2019)

  • Add installation and usage info to readme.

2.9.2 (20.05.2019)

  • Fix parsing of a URI parameter with star (*) operator.

2.9.1 (14.05.2019)

  • Fix negative margins applied to Action and Transition cards.

2.9.0 (13.05.2019)

  • Convert values of untyped elements of an array.
  • Fix JSON schema generated for fixed and fixed-type elements.
  • Fix parsing of code block in a block description.

2.8.0 (07.05.2019)

  • Display :::note and :::warning sections in documentation.

2.7.1 (02.05.2019)

  • Fix rendering of long URLs.

2.7.0 (02.05.2019)

  • Update sandbox.

2.6.0 (29.04.2019)

  • Improve ResourcePrototype section processing.
  • Improve check for identical attributes during inheritance resolving.
  • Improve attributes check during attributes comparison.
  • Improve passing fixed-type attribute to nested elements.
  • Display blocks in description.
  • Convert nested elements of an enum.

2.5.0 (17.04.2019)

  • Optimize page first render.

2.4.0 (16.04.2019)

  • Improve parameter name display.

2.3.2 (11.04.2019)

  • Fix generation of a set of enumerable values of an array.

2.3.1 (11.04.2019)

  • Fix inheritance from enumerables.
  • Fix inheritance from named types.

2.3.0 (08.04.2019)

  • Delete fixed-type keyword from array definition.

2.2.0 (06.04.2019)

  • Display parameterized attributes in the right column.

2.1.7 (18.03.2019)

  • Render request schema.

2.1.6 (13.03.2019)

  • Use default values in body and JSON schema.

2.1.5 (07.03.2019)

  • Improve Default section and allow to include Default and Sample into primitives.
  • Fix attributes parsing.
  • Show a warning if action has no responses.
  • Fix processing of named primitive types.

2.1.4 (01.03.2019)

  • Fix rendering a documentation without any resource group.

2.1.3 (01.03.2019)

  • Fix rendering of an empty action.

2.1.2 (01.03.2019)

  • Fix parsing of named endpoints.

2.1.1 (27.02.2019)

  • Process an enumerable URI parameter with missing + Members keyword.

2.1.0 (27.02.2019)

  • Improve rendering parameters with enum values.

2.0.3 (27.02.2019)

  • Extract value of a URI parameter in case of a complex type.

2.0.2 (26.02.2019)

  • Fix import processing.

2.0.1 (26.02.2019)

  • Process nested elements of a href parameter as a description.

2.0.0 (22.02.2019)

  • Replace drafter with crafter.

1.6.0 (21.02.2019)

  • Highlight required attributes.

1.5.1 (16.02.2019)

  • Fix error of a missing script.

1.5.0 (09.01.2019)

  • Add node.js 10 support.

1.4.1 (28.12.2018)

  • Process markdown markup in description of URI parameters.

1.4.0 (27.12.2018)

  • Use commonmarkjs instead of showdown to render HTML.

1.3.5 (06.12.2018)

  • Change the way hash links are built.

1.3.4 (26.11.2018)

  • Fix linter warnings.

1.3.3 (15.11.2018)

  • Fix rendering of a url parameter with curly braces.

1.3.2 (13.11.2018)

  • Fix line break within href parameters.
  • Fix href parameters containing enum elements.
  • Increase spacing of a menu element containing a method label.
  • Pass a title of a resource to the nested unnamed transaction.
  • Merge menu elements containing a resource and its only transaction.
  • Fix inheritance resolving of a member node with some content.
  • Set correct type of a structure during inheritance resolving.
  • Fix processing of an enum attribute content.

1.3.1 (10.10.2018)

  • Update @funbox/sass-lint to version 1.10.2-fb-2.0.1.
  • Update @funbox/protagonist to version 1.6.8-fb-2.0.0.

1.3.0 (17.09.2018)

  • Optimize sections repaint during manipulations with menu

1.2.2 (17.09.2018)

  • Exclude redundant files from the published package

1.2.1 (11.09.2018)

  • Fix render errors in React components

1.2.0 (10.09.2018)

  • Update build process of static HTML
  • Exclude React from mandatory dependencies to build documentation

1.1.0 (09.09.2018)

  • Use headers from description as elements of navigation

1.0.0 (04.09.2018)

  • Initial version