Skip to content

0.8.0 Simplification

Compare
Choose a tag to compare
@rottmann rottmann released this 17 Nov 17:37
· 671 commits to master since this release
  • 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.