Giters

RD17 / ambar

:mag: Ambar: Document Search Engine

Home Page:https://ambar.cloud/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Api doc generation does not work for WebApi

opened this issue · comments

commented

Hi,

When running npm run docs in the WebApi project the command fails with the following message

{"File":"src/api/search.js","Block":1,"Element":"@apiSuccessExample","Source":"@apiSuccessExample HTTP/1.1 200 OK\n","level":"error","message":"Empty parser result."}

The problem is that in the file search.js every route is missing a second part when using the @apiSuccessExample.

     * @apiSuccessExample HTTP/1.1 200 OK
     *
     * @apiErrorExample {json} HTTP/1.1 400 BadRequest
     * HTTP/1.1 400 BadRequest

should be

     * @apiSuccessExample HTTP/1.1 200 OK
     * OK (or something else)
     * 
     * @apiErrorExample {json} HTTP/1.1 400 BadRequest
     * HTTP/1.1 400 BadRequest

I have not fully installed Ambar yet and can't fill the Sucess message.
If you're not available to fix it, I will probably open a PR in the following weeks.

Thanks for your work.

commented

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.