verdnatura-mirror
/
loopback-component-explorer
mirror of https://github.com/strongloop/loopback-component-explorer.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

route-helper: include `notes` and `deprecated`

This commit is contained in:
Miroslav Bajtoš 2014-10-13 16:32:12 +02:00
parent 37179f3e61
commit 4d0e711087
2 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lib/route-helper.js
View File

@ -137,8 +137,9 @@ var routeHelper = module.exports = {
parameters: accepts,
// TODO(schoon) - We don't have descriptions for this yet.
responseMessages: [],
summary: route.description, // TODO(schoon) - Excerpt?
notes: '' // TODO(schoon) - `description` metadata?
summary: route.description,
notes: route.notes,
deprecated: route.deprecated
})]
};

13
test/route-helper.test.js
View File

@ -75,6 +75,19 @@ describe('route-helper', function() {
expect(opDoc.format).to.equal('byte');
});
it('includes `notes` metadata', function() {
var doc = createAPIDoc({
notes: 'some notes'
});
expect(doc.operations[0].notes).to.equal('some notes');
});
it('includes `deprecated` metadata', function() {
var doc = createAPIDoc({
deprecated: 'true'
});
expect(doc.operations[0].deprecated).to.equal('true');
});
});
// Easy wrapper around createRoute