Demo

a_simple.js

'use strict';

var Joi = require('joi');

module.exports = function (harvester, swagger, mustbeConfig) {

    var category = harvester
        .resource('categories', {
            name: Joi.string().required().description('a name'),
            links: {
                brand: 'brands'
            }
        });
    // all routes are bootstrapped with default swagger spec and validation
    // e.g. categories.get registers a mustbe permission check activity with 'categories.get'
    // the Joi schema attributes are used to evaluate body or query params depending on the verb 
};

b_swagger_override.js

'use strict';

var Joi = require('joi');

module.exports = function (harvester, swagger, mustbeConfig) {

    var category = harvester
        .resource('categories', {
            name: Joi.string().required().description('a name'),
            links: {
                brand: 'brands'
            }
        });

    category.routes.getById()
        .swagger({summary: 'all the lovely categories by id'});
        // only explicit .swagger() declaration needed when an override of standard swagger spec is wanted        
};

c_validation_override.js

'use strict';

var Joi = require('joi');

module.exports = function (harvester, swagger, mustbeConfig) {

    var category = harvester
        .resource('categories', {
            name: Joi.string().required().description('a name'),
            links: {
                brand: 'brands'
            }
        });

    var customJoiSchema = {query: {myAwesomeParam: Joi.string().required().description('My awesome parameter')}};
    category.routes.get()
        .validate(customJoiSchema);
        // only explicit .validate() needed when you want to override/augment defaults
};

d_authorize_override.js

'use strict';

var Joi = require('joi');

module.exports = function (harvester, swagger, mustbeConfig) {
    
    var category = harvester
        .resource('categories', {
            name: Joi.string().required().description('a name'),
            links: {
                brand: 'brands'
            }
        });
    
    mustbeConfig.activities(function (activities) {
        activities.can("category.mutate", function (identity, params, cb) {
            // data lookup and execute business rules
            cb(null, true);
        });
    });

    category.routes.delete()
        .authorize('category.mutate');
        // overrides default mustbe.authorized('category.delete')

};

e_finegrained_validation.js

'use strict';

var Joi = require('joi');

module.exports = function (harvester, swagger, mustbeConfig) {

    var category = harvester
        .resource('categories', {
            name: Joi.string().required().description('a name'),
            links: {
                brand: 'brands'
            }
        });
    
    category.routes.delete()
        .before(beforeDelete)
        // adding validation fn handler
        // however this clause accepts an unbounded amount of fn handlers which get triggered before the actual delete fn handler;

    function beforeDelete(req, res, next) {
        // do some checks with req.
        if ('untouchable'===req.body.categories[0].name) {
            next(new harvester.JSONAPI_Err({status: 400, detail: 'untouchable category'}));
        } else {
            next();
        }
    }


};

e_simple+disabled_endpoint.js

'use strict';

var Joi = require('joi');

module.exports = function (harvester, swagger, mustbeConfig) {

    var category = harvester
        .resource('categories', {
            name: Joi.string().required().description('a name'),
            links: {
                brand: 'brands'
            }
        });
    // all routes are bootstrapped with default swagger spec and validation
    // e.g. categories.get registers a mustbe permission check activity with 'categories.get'
    // the Joi schema attributes are used to evaluate body or query params depending on the verb 
    category.routes.put(false);
    category.routes.post(false);
    category.routes.delete(false);
};

f_fullmonty.js

'use strict';

var Joi = require('joi');

module.exports = function (harvester, swagger, mustbeConfig) {

    var category = harvester
        .resource('categories', {
            name: Joi.string().required().description('a name'),
            links: {
                brand: 'brands'
            }
        });

    var customJoiSchema = {query: {myAwesomeParam: Joi.string().required().description('My awesome parameter')}};
    category.routes.get()
        .validate(customJoiSchema);

    category.routes.getById()
        .swagger({summary: 'all the lovely categories by id'});

    category.routes.getChangeEventsStreaming();
    
    mustbeConfig.activities(function (activities) {
        activities.can("category.mutate", function (identity, params, cb) {
            cb(null, true);
        });
    });

    category.routes.delete()
        .authorize('category.mutate')
        .before(beforeDelete);

    function beforeDelete(req, res, next) {
        if ('untouchable'===req.body.categories[0].name) {
            next(new harvester.JSONAPI_Err({status: 400, detail: 'untouchable category'}));
        } else {
            next();
        }
    }


};