Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Params Not Being Documented for Express Endpoints #17

Closed
SudoZachCampbell opened this issue Oct 22, 2019 · 3 comments
Closed

Params Not Being Documented for Express Endpoints #17

SudoZachCampbell opened this issue Oct 22, 2019 · 3 comments

Comments

@SudoZachCampbell
Copy link

Having an issue when @params are not showing in the following Express code:

/** Get object by ID endpoint
 * 
 * @name Fields by ID
 * @memberof Field APIs
 * @path {GET} /fields/:objectId
 * @params {String} :objectId is the Field ID to search by
 */
router.get('/:objectId', (req, res, next) => {
  fieldsSvc.getItem(req.params.objectId, 'Fields').then((data) => {
    res.json(data);
  }).catch(next);
});

I tried removing the namespace to see if it was affecting it but no change.

@vmarchaud
Copy link
Owner

Could you share what does it show when exporting it ?

@SudoZachCampbell
Copy link
Author

image

@SudoZachCampbell
Copy link
Author

Resolved the issue, in the plugins section in my jsdoc config I had to put "node_modules/jsdoc-http-plugin". Could possibly be due to the location of the jsdoc config file inside a "config" directory, however in that case I thought the fix would be "../node_modules/jsdoc-http-plugin"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants