All Versions
81
Latest Version
Avg Release Cycle
138 days
Latest Release
-

Changelog History
Page 3

  • v0.19.1 Changes

    December 27, 2019

    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)

  • v0.19.0 Changes

    December 02, 2019

    🛠 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)

  • v0.18.0 Changes

    November 13, 2019

    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

  • v0.17.5 Changes

    January 31, 2017
    • CLI
      • Bugfix for folder problem.

  • v0.17.4 Changes

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

  • v0.17.3 Changes

    January 16, 2017
    • Template
      • Fix missing lodash dependency. #581
      • Fix hidden optional field.
      • Add check for empty header/footer nav points.

  • v0.17.2 Changes

    • Template
      • Fix hidden optional field.

  • v0.17.1 Changes

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

  • v0.17.0 Changes

    January 13, 2017

    💥 Breaking change: node v6 is minimum requirement.

    ➕ 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

  • v0.16.0 Changes

    April 21, 2016

    ✅ 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.