apidoc - npm Package Versions

0.51.1

• Fix incorrect warnings in some conditions (PR #1206 by @BrokenSourceCode, fix #1194)

0.51.0

• Emit warnings if there are inconsistencies in the apidoc params (PR #1189 by Lucas Cimon)
• Dependencies update

0.50.5

• Use root package.json values if not in apidoc key by Nick Mitchell (#1164)
• Fix search requiring lower-case input (#1173 by Alexander Weiss)
• Add yarn berry compatibility (#1144 by 이호영)
• Fix template path resolve (#1175 by Kevin Bull)
• Update chinese locale (#1184 by Jun Ding)
• Dependencies update

0.50.4

FIXED

• Fix bug with loading the CSS file for single page mode (--single) (fix #1142)

0.50.3

FIXED

• Fix bug where header/footer files could not be found in some conditions (fix #1107)

ENHANCEMENTS

• Add showRequiredLabels option (default: false) (fix #1095)

0.50.2

FIXED

• fix checkbox styling (fix #1077 via #1079 by @esaracco)
• make sure success block appears after body/query params (fix #1100)
• fix content-type value (fix #1084 via #1085 by @esaracco)
• fix display of types for apiHeader and apiParam (#1083 by @esaracco)
• fix tests on windows (#1070 by @donmahallem)

ENHANCEMENTS

• improve build speed (by @rottmann)
• make the message about no config files found a warning
• look for package.json in current working directory for apidoc config (fix #1086)
• update chinese translation
• add json response highlighting (#1082 by @esaracco)

0.50.1

• fix issue with sampleUrl set to "true" (fix #1058 via #1062 by @esaracco)
• fix not seeing all versions below (fix #1049 via #1061 by @esaracco)
• fix apiParams input elements (#1059) by Benjamin Knorr
• Remove the jQueryAjaxSetup configuration option (was not working anyway) (fix #1040 via #1041 by @esaracco)
• Add more files/folders to .npmignore
• Improve/fix group sorting (fix #1042 via #1044 by @esaracco)

0.50.0

BREAKING CHANGES

• --silent renamed to --quiet or -q for short
• --color renamed to --no-color to disable color in log output
• --parse was deleted because it is the same as --simulate
• --simulate renamed to --dry-run / -n
• Default output is not json, use "--log-format json" to get json
• --config / -c must be a path to a file, not a directory

FIXED

• Fix sampleUrl config option behavior:

  • if it is absent or false, no sample block will be generated
  • if it is true, the current page location will be used
  • if it is an url, that will be used Note that the option useHostUrlAsSampleUrl has no longer any effect and can be safely removed. Use a value of true for sampleUrl to get the same behavior.

• Fix non working sortFields function (fix #968)

• Fix syntax highlighting for markdown parsed text

• Fix color in logs was not showing since upgrade to winston 3

• Fix newlines being removed in pre tags (fix #809 by @JayBerlin)

• Fix header/footer in aloneDisplay mode (fix #905 via #1027 by @esaracco)

• Fix duplicated content in aloneDisplay mode (fix #938 via #1025 by @esaracco)

• Fix apiSampleRequest not working (fix #984 via #1023 by @esaracco)

• Fix error with parenthesis in apiGroup (fix #994 via #1022 by @esaracco)

• Fix absent diff on different api route (fix #963 via #1030 by @esaracco)

ADDED

• Add request method to compare template (#986 by @klickagent)
• Add some shorthand options, see apidoc -h
• Add --log-format option for json output (default is not json)
• Add ascii art in verbose mode
• Add --warn-error to treat warnings as error (fix #703)

ENHANCEMENTS

• HUGE CLEANUP OF THE CODEBASE
• Merge apidoc-core back into the apidoc repository. The apidoc-core repository is now read-only.
• Add .eslintrc.js and enforce coding style everywhere
• Update many dependencies to their latest version
• Make sidenav wider and template more responsive (fix #851)
• Big CSS code overhaul and change
• Ignore node_modules by default (fix #936)
• Add ASCII art in verbose mode
• Allow setting input and output in apidoc.json (fix #630)
• Take standard parameters of URL query string into account (#1014 by @esaracco)
• Allow colon character in apiDefine (fix #877 via #1021 by @esaracco)

0.29.0

• Fix broken handlebar
• [DEV] add a npm run serve command
• Remove space that was added for optional params
• Make the 'optional' label unselectable (#970 by Thomas Bruun)

0.28.1

• Fix issue with handlebar (#967)