[GH-ISSUE #264] Api doc generation does not work for WebApi #251

New issue

Closed

opened 2026-02-27 15:55:49 +03:00 by kerem · 1 comment

kerem commented

2026-02-27 15:55:49 +03:00

Owner

Originally created by @ghost on GitHub (Aug 31, 2019).
Original GitHub issue: https://github.com/RD17/ambar/issues/264

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.

Originally created by @ghost on GitHub (Aug 31, 2019). Original GitHub issue: https://github.com/RD17/ambar/issues/264 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.

kerem

2026-02-27 15:55:49 +03:00

closed this issue
added the
wontfix
label

kerem commented

2026-02-27 15:55:50 +03:00

Author

Owner

@stale[bot] commented on GitHub (Sep 15, 2019):

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.

@stale[bot] commented on GitHub (Sep 15, 2019): 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.