Error when providing old apidoc apiExample syntax

[quorak]

hey there,
thx for the plugin.

when i mix old and new syntax in different blocks, I get error:
error: Cannot read property 'path' of null

Code:

/**
 * @api {get} /user/:id
 * @apiExample {curl} Example usage:
 *     curl -i http://localhost/user/4711
 */
[...]
/**
 * @api {get} /api GetAPI
 * @apiExample {json=./ex/api.req.json} apiParamExample Request
 */

[willfarrell]

I'm not familiar with this old syntax you're referring too. Possible you have more than one apiExample plugin connected? If so they will conflict.

[quorak]

with old syntax, I mean the standard syntax, without the plugin. see http://apidocjs.com/#param-api-example

[Arxcis]

Bump. This plugin does not allow to mix @apiExample {curl} and @apiExample {json}.
My use-case:

/**
 * @api {get} /user/:id User
 * @apiGroup Users
 * @apiSchema {jsonschema=./schema.json} apiSuccess
 * @apiExample {curl}  Example usage:
 *     curl -i http://localhost/user/4711 example Request
 * @apiExample {jsonschema=./schema.json} apiSuccessExample Response JSON
 */

[Arxcis]

The bug is because parse() in parser/api_example.js fails, and the caller parserExampleElements() in index.js does not check for null

function parse(content) {
  // ...
  if ( ! matches)
    return null;
  // ...
}

Recommended solution is to check if values is null

function parserExampleElements(elements, element, block, filename) {
  // ...
  const values = elementParser.parse(element.content, element.source);
  if (!values) {   // < -----------------  Should check if values null --------
      return elements
  }
  // ....
}

[Arxcis]

Should probably also make the regex more specific, since only json, jsonschema and xml is supported

I suggest changing

  var parseRegExp = /^\{(.+?)=(.+?)\}\s*(?:\s+(.+?))?\s(.+?)$/g;

...to

  var parseRegExp = /^\{\s*(json|jsonschema|xml)\s*=(.+?)\}\s*(?:\s+(.+?))?\s(.+?)$/g;

[willfarrell]

@Arxcis nice catch, would you like to put a PR together for that?

[Arxcis]

@willfarrell Alright, will do. I am not sure if just returning elements is correct thing to do, or if I have to do .push() or .pop() also? Do you know?

[canonex]

Hi, is this merged with the npm version?
I get the same error.

Thank you,
Riccardo