Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
apidoc - npm Package Versions
Changelog
0.8.1
- Bugfix: Python regex doublequote. (https://github.com/apidoc/apidoc/issues/151)
- Bugfix: Issue with multiple apiSuccessExample blocks. (https://github.com/apidoc/apidoc/issues/150)
Changelog
0.8.0
-
Parameter
-
Add as replacement for all (now) deprecated define and structure methods:
@apiDefine@apiUse
-
Deprecated:
@apiDefineErrorStructure@apiDefineHeaderStructure@apiDefinePermission@apiDefineStructure@apiDefineSuccessStructureapiErrorTitleapiErrorStructureapiHeaderStructureapiHeaderTitleapiParamTitleapiStructureapiSuccessTitleapiSuccessStructure
-
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:
@apiParamwith size and allowed values.
-
-
CLI
- Show deprecated message. Show details with
--debugor--verbose. - Improved error output.
- Turn off verbose output by default.
- Add debug output.
- Show deprecated message. Show details with
-
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
jQueryAjaxSetupto apidoc.json for setup ajax requests (http://apidocjs.com/#configuration-template-settings). - Hide the ul for tabs if no content.
Changelog
0.7.2
- Bugfix: Custom parsers not working. (https://github.com/apidoc/apidoc/issues/113)
Changelog
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. (https://github.com/apidoc/apidoc/issues/109)
Changelog
0.7.0
- Add rudimentary support for direct api calls (test requests) from within the doc.
- New configuration var sampleUrl for
apidoc.json. - @apiSampleRequest
- New configuration var sampleUrl for
- Added ability to have forward slash (/) in parameter field names.
- Add parameter
--parsefor parse only the files and return the parsed data. - Allow perl comments between "=pod" and "=cut".
Changelog
0.6.5
- Bugfix: Change RegExp for parameter values to handle all chars. (https://github.com/apidoc/apidoc/issues/97)
Changelog
0.6.3
- Bugfix: Multiple added url to api path after compared to other version. (https://github.com/apidoc/apidoc/issues/87)
Changelog
0.6.2
- Bugfix: Docs do not generate without optional @api [title]. (https://github.com/apidoc/apidoc/issues/82)
- Bugfix: Escape example output in
apiExample,apiErrorExample,apiSuccessExample. (https://github.com/apidoc/apidoc/issues/78)