Skip to content

Latest commit

 

History

History
907 lines (599 loc) · 28.5 KB

CHANGELOG.md

File metadata and controls

907 lines (599 loc) · 28.5 KB
Raw

apiDoc Changelog

1.2.0

  • Allow generation of api-data.json file with an option flag (PR #1427 by Henrik Gemal)

1.1.0

  • Upgrade dependencies

1.0.3

  • Fix warning triggered by code example (fix #1384 via #1391 by Emmanuel Saracco)
  • Fix issue with apiSuccessExample parsiing (fix #1365 via #1366 by Emmanuel Saracco)

1.0.2

  • Fix group name with parenthesis causing scrollspy error

1.0.1

  • fix version number

1.0.0

BREAKING CHANGE

  • Requires Node v16 minimum (end of support for Node 14 is April 30th 2023)

Bugfixes

  • Fix issue with non latin group names (fix #1331)
  • Fix bundle not being generated unless in debug mode (fix #1350)

Contributed changes

  • Allow escaping fields with dot (fix #774, PR by Emmanuel Saracco #1063)
  • Add off-canvas sidenav for mobile (PR #1341 by @SchoppAx)
  • Improve filter performance for huge projects (fix #1337 via PR #1343 by @SchoppAx)
  • Add clipboard button to code snippets (PR #1342 by @SchoppAx)
  • Re-create eventlisteners after compare manipulation (PR #1340 by @SchoppAx)
  • Add prism highlight diff support (PR #1338 by @SchoppAx)

0.54.0

  • Add cache busting system for assets with query parameter (PR #1333 by @Elysiome, fix #1332)
  • Let browser generate content-type for sending form-data (PR #1327 by @thenewvu, fix #1122, fix #1309, fix #1234)
  • Fix exclude filters option description: add note about always excluded files/folder
  • Improve assignment of conditional variable values (#1296 by MichalS)
  • Handle @apiDefine when producing warnings (PR #1305 by Lucas Cimon, fix #1305)
  • Update chinese translations (PR #1304 by Jony Young)

0.53.1

  • Add tsx to default extensions parsed. (fix #1290)
  • Compare methods with lowercase strings (fix #1284)
  • Upgrade some dependencies

0.53.0

  • Fix issue with aloneDisplay and non-ascii characters (#1273 by @KujoMiva)

0.52.0

  • Allow cn, zh_cn or zh for Chinese language option and display meaningful message in console on error. fix #1248
  • Update example files to not display an error (#1210)
  • Update dependencies

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)

0.28.0

  • Use npm lockfile v2
  • Update handlebar to fix vulnerability (#962)
  • Fix runtime error in single page template (#944 via #945 by Ashlanfox)
  • Implement apiBody parsing into multi page template (#953 by Seth Wheeler)

0.27.0

  • Maintain comment order for @apiParam and @apiSuccess (fix #206 via #951 by Matheus Giovani)
  • Add option for JavaScript output mode (#933 by refineddigital)
  • Add new configuration variable useHostUrlAsSampleUrl (#930) by Shivam Kumar Jha
  • Add new favicon (#926 by Francisko Arenas)
  • Implement apiBody parsing into single page template (#916 by Seth Wheeler)

0.26.0

  • Clean up useless CSS rule (#923)
  • Enable GitHub actions (#918 by @tommy87)
  • Send sample url request to url hosting the documentation when no sampleUrl is provided in config (#915 by @thealphadollar)

0.25.0

  • Add programmatic usage to README (#898 by rigwild)
  • Fix page refresh on non ascii characters (#896)

0.24.0

  • Fix output when offline (#894) by @SecretAgentKen
  • Increase require.js timeout (#889) by @NicolasCARPi
  • Use Prism.js instead of deprecated prettify.js (#888) by @NicolasCARPi

0.23.0

  • Send sample request auto json body if body/json is not used but Content-Type application/json header is set (#862)
  • Fix documentation not showing / Show version when withCompare is set to false (#880) Fix #879
  • Add support for javascript config files (#872)
  • Add support for different config files (#874)
  • Fix tests for Windows (#873)
  • Fix pre borders overflowing on print view (#887)

0.22.1

  • Fix initial jump with hashed URL (#871) by @rafaelgssa

0.22.0

  • Fix issue with newer api endpoint showing up on first page load (#869) by @Yopai
  • Update Handlebars to latest version (fix security issue) (#867) by @NicolasCARPi
  • Allow several path parameters (#866) by @rafaelgssa
  • Add param file upload support (#850) by @aqnaruto

0.21.0

  • Add --single option to output in a single HTML file (#840) by @eyasliu

0.20.1

  • Avoid using container-fluid on the body if the screen is larger than 1200px (#846)

0.20.0

  • Add @rigwild/apidoc-markdown converter in README (#839)
  • Add --watch command line option to generate doc if source changes (#835)
  • Handle parsing of array fields (#829)
  • Handle nested fields when sending the request (#828)
  • Revert back the api Group/Name change in template (#821)

0.19.1

  • Bring back apidoc-example as devDependencies for CI
  • Update apidoc-core version in package-lock.json
  • Fix documentation for filter-by option (use = instead of :)
  • Fix HTML after comparison (#827)

0.19.0

The number of open pull requests in now 0! :D In this release you'll find one bugfix and also some new features/improvements.

  • Bugfix:

    • Fix default header being sent instead of user input (#813)

  • New features:

    • Add aloneDisplay config option to filter the page after clicking menu header (#820 by @sxiazb)
    • Add filtering navigation bar based on URL (#820 by @sxiazb)
    • Add dropdown box for the body parameter and modify to allow multiple params (#812 by @sxiazb)
    • Add --filter-by option (#810 by @omaretna)
    • Add possibility to define absolute url in @api (fix #201)

  • Enhancements:

    • Add mjs file extension to the list of parsed files (#815 by @mons54)
    • Improve the example project
    • Don't output anything by default on CLI (fix #799)

0.18.0

This release comes after more than two years without changes to the code. A lot of things were merged and fixed, so it is possible that this changelog is not entirely complete. Refer to the git log if necessary.

  • Common

    • Add Docker image and improve it (#807)
    • Fix apiGroup showing instead of apiName in template
    • Add support for custom markdown parser location (#714)

  • CLI

    • Add kotlin to default file-filters.
    • Escape content of success examples.

  • Template

    • Update style.css to have horizontal scrolling for long URLs.
    • Add Vietnamese translation.
    • Add Turkish translation.
    • Blank optional parameters omitted from sample request.
    • Update template form parameter to be in form group (#669)
    • Improve the sorting of names (#688)
    • Avoid underscores in article titles (#764)
    • Add default value of the headers in the input (#806)
    • Add notes about Elixir (#658)
    • Send JSON body for APIs (#559)

  • Maintenance

    • Update dependencies where possible

0.17.5

  • CLI
    • Bugfix for folder problem.

0.17.4

  • Parser
    • Fix missing chars in root folder.
    • Replace removed fs-extra.walkSync with klaw-sync.

0.17.3

  • Template
    • Fix missing lodash dependency.

0.17.2

  • Template
    • Fix hidden optional field.

0.17.1

  • Template
    • Fix missing type in template.
    • Add check for empty header/footer nav points.

0.17.0

Add new @apiDeprecated annotation. Add new @apiPrivate annotation.

  • CLI

    • Add --private false|true parameter to export @apiPrivate marked methods.
    • Add .cls, .jsx, p, .pl, .vue file extensions.
    • Update dependencies.

  • Parser

    • Add @apiDeprecated support. 52
    • Added support for private APIs @apiPrivate. 530
    • Add support for plugins in scoped modules. 51
    • Remove deprecated lib wrench and replace with fs-extra.
    • Update dependencies.

  • Template

    • Update Bootstrap to 3.3.7.
    • Navigation filter added. 562
    • h2 links in Header / Footer files will now be visible in the main navigation. 525
    • Fix issue of left menu displaying major function in older version. 528
    • Replace lodash with only needed custom build lodash functions.
    • Update italian language file. 507

0.16.0

Greatest improvement: Plugin support

apidoc search now in global node modules dir and local node_modules for modules that start with apidoc-plugin-. (local installed plugins have higher priority)

View / clone: apidoc-plugin-test With a plugin you can add features like new parsers (this was possible before only with CLI param) or filters and workers.

Start adding hooks. Hooks can be used in plugins to extend or transform data.

If you need a hook in apidoc-core please add your hook and provide a pull request. How to add a hook into apidoc-core view source code

  • CLI

    • Update dependencies.
    • Remove not needed js-cookie module.
    • Allow for single source configuration. 458

  • Parser

    • Add Plugin Loader. Extend filter, parser, worker for plugin usage. example plugin
    • Add plugin hooks for found elements. available hooks
    • Add support for other encodings (default ist uf8). apidoc --encoding utf8
    • Add Lua support.
    • Add cpp support.
    • Add Arduino support.

  • Template

    • Do not use monospace for sans-serif fonts, only code fonts.
    • Sort field by grouping. 457
    • Add X-UA-Compatible for Internet Explorer to prevent loading only screen.
    • Reformat JSON example output.
    • Example table column widths set to 100%.
    • Add Italian translation.

0.15.1

  • Parser
    • Bugfix: Inherit error of lodash merge / mergeWidth split.

0.15.0

  • CLI

    • Update dependencies.

  • Parser

    • Upgrade markdown parser to version 0.6.

  • Template

    • Make ajaxRequest simpler. 384
    • Format response json. 396
    • Improve sendSampelRequest. 400
    • Add Catalan translation. 403
    • Bugfix: zh_cn translation string. 415
    • Bugfix: Template break on defined prototype methods.
    • Update json response css.
    • Update webfontloader.
    • Add monospace font fallback.

0.14.0

  • CLI

    • Clarify that -c option must be a directory.

  • Parser

    • Add support for : in @apiParam names.
    • Add Ruby doxygen-style support.
    • Add Groovy support.
    • Add Exlixir support.
    • Add Parameter name array syntax.
    • Add travis-ci tests for node 0.12.

  • Template

    • Add semver for correct sort order. 335
    • Add google webfontloader to fix scrollspy position after webfont loading.
    • Add semver for correct sort order.
    • Add Spanish translation.
    • Add Chinese Simplified (zh-cn) tranlsation.
    • Update to semantic tradition Chinese words.
    • Update Polish translation.
    • Ensure params isn't empty before sending.
    • Set required defaults for sample request.
    • Bugfix: Locale don't work with pt-br. 329
    • Bugfix: Empty Groups for Future Versions showing when old Versions are selected. 349
    • Bugfix: Add path to template variable (_col1).
    • Sample requests with GET parameters need to be added to the query string.
    • Fix handle bar expression to not apply html encode for data type field.
    • Typo in header.md.

0.13.2

  • Parser
    • Remove p-Tags from type-Field.
    • Update dependencies.
    • Update fixtures (type-Fields and line endings).

0.13.1

  • Template
    • Update French and Russian translation files.

0.13.0

  • Important changes:

  • CLI

    • Add path to config file (with -c).
    • Add multiple input locations (with -i).
    • Remove markdown config parameters, for custom configurations view MARKDOWN.md.
    • Disable warning if packageJson.apidoc was defined.
    • Add litcoffee and scala file extension.

  • Template

    • Add template.forceLanguage in apidoc.json to set a fixed language file without auto-detect the browser language.
    • Add word wrap for pure text examples.
    • Add Brazilian, French, Polish and Russian translation files.

  • Parser

    • Remove deprecated annotations (http://apidocjs.com/deprecated.html).
    • Replace markdown parser with markdown-it.
    • Add custom markdown parser support, view MARKDOWN.md for details.
    • Add support for markdown in the type section. Example: @apiParam {(CustomType)[http://...link-to-description.html]}

0.12.2

  • CLI

    • Bugfix: Multiple bin parameters. 244

  • Template

    • Update template vendor lib path-to-regexp.
    • Bugfix: Example overlaps navigation. 240

  • Parser

    • Update dependencies.

0.12.1

  • CLI

    • Add some version information for verbose / debug output.

  • Parser

    • Bugfix: Parse blocks with unknown parameters (before the block was skipped).
    • Bugfix: show correct block index.
    • Update dependencies.

0.12.0

  • Parser
    • Unindent strings in description fields. Mulitlines start with the same leading whitespaces. 173

0.11.0

  • CLI

    • Add parameter --parse-languages for custom language regex.

  • Parser

    • Add Clojure parser for .clj files.
    • Extend parser to transfer own language regex.
    • Update apidoc-core interface (replace arguments with setters).

  • Template

    • Add chinese and dutch translations files.

0.10.1

  • Bugfix: Path to apidoc-core.

0.10.0

  • Split apidoc code

    • apidoc is now only the CLI-Tool with UI-Template and file creation (as you know it). You can use apidoc without change anything.

    • apidoc-core (for developers) is the parser and response the api-data.

    • apidoc-example (for developers) are the test files for the apidoc-spec.

  • CLI

    • Replace optimist (not maintained anymore) with nomnom: true / false parameters can now be used, e.g. enable markdown (default) --markdown or disable --no-markdown.
    • Add parameter --markdown.
    • Replace the custom Logger with winston.

  • Parser

    • Bugfix: Settings to enable / disable markdown (marked-gfm was previously used).

  • Template

    • Add generator.url and generator.name to the footer generator information (for custom ui-generators).
    • Move handlebars_helper.js to utils/

  • Common

    • Remove grunt dependencies (test run with npm run test).
    • Change grunt-apidoc (0.10.0) to use always the latest version of apiDoc.

0.9.1

  • Parser

    • Allow overwrite of packageInfo e.g. from grunt task (#177)

  • Bugfix: Extend parser regexp to allow inline comment-code (#180)

  • Bugfix: Slash only path in api triggered error (#159)

  • Bugfix: Scrollspy offset (#176)

  • Bugfix: Get package infos from package.json or apidoc.json (#169)

0.9.0

  • CLI

    • Allow to include an external file which can set the markdown settings. (#166)

  • Template

    • Add custom order in apidoc.json Append apiName or apiGroup in the order list:

      "order": [
  "MyGroupName",
  "MyParameterName",
  "MyOtherParameterName"
]

    • Speed up rendering of subtemplates (#164)

    • Bugfix: Special char doesn't show in @apiGroup. (#163)

0.8.2

  • Bugfix: apiGroupDescription from apiDefine not working. (#156)
  • Bugfix: remove deprecated message for apiPermission. (#154)
  • Bugfix: Testclient did not send JSON format. (#152)

0.8.1

  • Bugfix: Python regex doublequote. (#151)
  • Bugfix: Issue with multiple apiSuccessExample blocks. (#150)

0.8.0

  • Parameter

    • Add as replacement for all (now) deprecated define and structure methods:

      • @apiDefine
      • @apiUse

    • Deprecated:

      • @apiDefineErrorStructure
      • @apiDefineHeaderStructure
      • @apiDefinePermission
      • @apiDefineStructure
      • @apiDefineSuccessStructure
      • apiErrorTitle
      • apiErrorStructure
      • apiHeaderStructure
      • apiHeaderTitle
      • apiParamTitle
      • apiStructure
      • apiSuccessTitle
      • apiSuccessStructure

    • Remove unneeded methods since success and error response can be grouped:

      • @apiInfo
      • @apiInfoExample
      • @apiInfoTitle

    • Add for consistent usage:

      • @apiHeaderExample
      • @apiParamExample

    • Change:

      • @apiPermission, multiple permission usage in a block is allowed now. Permission names must be defined with @apiDefine.

    • Extend:

      • @apiParam with size and allowed values.

  • CLI

    • Show deprecated message. Show details with --debug or --verbose.
    • Improved error output.
    • Turn off verbose output by default.
    • Add debug output.

  • Parser

    • Ignore other doc-language @-parameters (enables jsdoc, phpdoc, ... again).
    • Add apidoc specification version to project file.
    • Correctly handle Erlang comments.
    • Bugfix: Markdown error on Empty description.
    • Revised worker preProcess / postProcess functions.
    • Change parser export names.

  • Template

    • Show size and allowed values in field description.
    • Change template sample request to handle custom named groups.
    • Update template vendor files (handlebars 2, requirejs)
    • Added support for using path-to-regexp in sample request.
    • Add jQueryAjaxSetup to apidoc.json for setup ajax requests (http://apidocjs.com/#configuration-template-settings).
    • Hide the ul for tabs if no content.

0.7.2

  • Bugfix: Custom parsers not working. (#113)

0.7.1

  • Add type for @apiExample {type} Title, @apiSuccessExample, @apiErrorExample.
  • Add type switch in template.
  • Append filetype to fields at ajax reuqest testform.
  • Bugfix: Same file handling with regexp under win32. (#109)

0.7.0

  • Add rudimentary support for direct api calls (test requests) from within the doc.
  • Added ability to have forward slash (/) in parameter field names.
  • Add parameter --parse for parse only the files and return the parsed data.
  • Allow perl comments between "=pod" and "=cut".

0.6.5

  • Bugfix: Change RegExp for parameter values to handle all chars. (#97)

0.6.4

  • Bugfix: Reserved parameter names. (#96)

0.6.3

  • Bugfix: Multiple added url to api path after compared to other version. (#87)

0.6.2

  • Bugfix: Docs do not generate without optional @api [title]. (#82)
  • Bugfix: Escape example output in apiExample, apiErrorExample, apiSuccessExample. (#78)

0.6.1

  • Changing font include to work on HTTPS.
  • Some refactors and bugfixes.

0.6.0

0.5.2

  • Add css for printing.
  • Bugfix: Template IE8 compatibility. (#69)

0.5.1

  • Update node version to 0.10.x.
  • Add optional custom browser title with apidoc.title in package.json.
  • Add optional url endpoint with apidoc.url in package.json.
  • Bugfix: Template scrollbug. (#64)

0.5.0

0.4.4

  • Preserve other files when copying template files to the destination output dir.

0.4.3

  • Added a short-circuit check. (#41)

0.4.2

  • Bugfix: Fix parsing of multiline string. (#34)

0.4.1

  • Add support for CoffeeScript comment-style.

0.4.0

  • Add support for other comment-style. Now apiDoc supports:

    • Erlang
    • JavaScript (JavaDoc-Style: e.g. also useable in C#, Go, Dart, Java, PHP, TypeScript)
    • Python
    • Ruby

  • Add some programming language test cases.

  • Remove german code comments.

  • Upgrade all used node modules.

0.3.0

  • Replace deprecated node-markdown with marked.
  • Add cli parameter for marked --marked-..., watch all params with--help.
  • Upgrade all used node modules.

0.2.8

  • Bugfix: executable line delimiters. (again).

0.2.7

  • Bugfix: Allow usage of structures and titles in the same block. (#21)

0.2.6

  • Give some indication, in case file listing with fails. (#20)

0.2.5

  • Allow multiple structure includes.
  • Split and extend test-files.

0.2.4

  • Bugfix: Fix parsing for empty lines and removing stars on data that spans over multiple lines. (#11)
  • Remove http:// link to make https compliant. (#10)

0.2.3

  • Extend Template with url-param "compare=1" to show the compare version on page view.
  • Bugfix: Minor fix with double structure examples.

0.2.2

  • Bugfix: Template not show @apiSuccessExample @apiErrorExample.

0.2.1

  • Bugfix: executable line delimiters.

0.2.0

0.1.11

  • Allow whitespace in apiName and apiGroup.
  • Bugfix: Filter for directories.
  • Update Node Modules to newer versions.

0.1.10

  • Add -e exclude option for Files / Directories, example apidoc -e node_modules/.

0.1.10

  • Bugfix: Check for a valid title in Template. (#7)

0.1.9

  • Bugfix: Whitespace before comment block. (#2)

0.1.8

  • Change templates, enable navigation scroll.

0.1.7

0.1.6

  • Bugfix: OSX executable.

0.1.5

  • Official release.