Skip to content
New issue

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

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

Already on GitHub? # to your account

Harvester 2.0 should generate api documentation automatically. #89

Open
ssebro opened this issue May 28, 2015 · 0 comments
Open

Harvester 2.0 should generate api documentation automatically. #89

ssebro opened this issue May 28, 2015 · 0 comments

Comments

@ssebro
Copy link

ssebro commented May 28, 2015

This ticket is to implement automatic swagger doc generation for harvester routes.

module.exports = function (harvester) {

    var category = harvester
        .resource('categories', {
            name: Joi.string().required().description('a name'),
            links: {
                brand: 'brands'
            }
        });
    // Explicit .doc() declaration needed when an override of standard swagger spec is wanted        
    category.getById().doc({summary: 'all the lovely categories by id'})
    .register();
};
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant