Merge pull request #73 from STRML/nickname
Remove model name from nickname, swagger spec understands op context.
This commit is contained in:
commit
fe434e7ee9
|
@ -149,8 +149,10 @@ var routeHelper = module.exports = {
|
||||||
// is specified in the first response message.
|
// is specified in the first response message.
|
||||||
operations: [{
|
operations: [{
|
||||||
method: routeHelper.convertVerb(route.verb),
|
method: routeHelper.convertVerb(route.verb),
|
||||||
// [rfeng] Swagger UI doesn't escape '.' for jQuery selector
|
// [strml] remove leading model name from op, swagger uses leading
|
||||||
nickname: route.method.replace(/\./g, '_'),
|
// path as class name so it remains unique between models.
|
||||||
|
// route.method is always #{className}.#{methodName}
|
||||||
|
nickname: route.method.replace(/.*?\./, ''),
|
||||||
parameters: accepts,
|
parameters: accepts,
|
||||||
responseMessages: responseMessages,
|
responseMessages: responseMessages,
|
||||||
summary: typeConverter.convertText(route.description),
|
summary: typeConverter.convertText(route.description),
|
||||||
|
|
|
@ -185,11 +185,24 @@ describe('route-helper', function() {
|
||||||
responseModel: 'ValidationError'
|
responseModel: 'ValidationError'
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('route nickname does not include model name.', function() {
|
||||||
|
var doc = createAPIDoc();
|
||||||
|
expect(doc.operations[0].nickname).to.equal('get');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('route nickname with a period is shorted correctly', function() {
|
||||||
|
// Method is built by remoting to always be #{className}.#{methodName}
|
||||||
|
var doc = createAPIDoc({
|
||||||
|
method: 'test.get.me'
|
||||||
|
});
|
||||||
|
expect(doc.operations[0].nickname).to.eql('get.me');
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
// Easy wrapper around createRoute
|
// Easy wrapper around createRoute
|
||||||
function createAPIDoc(def) {
|
function createAPIDoc(def) {
|
||||||
return routeHelper.routeToAPIDoc(_defaults(def, {
|
return routeHelper.routeToAPIDoc(_defaults(def || {}, {
|
||||||
path: '/test',
|
path: '/test',
|
||||||
verb: 'GET',
|
verb: 'GET',
|
||||||
method: 'test.get'
|
method: 'test.get'
|
||||||
|
|
Loading…
Reference in New Issue