search

outmoded / lout

API documentation generator
Other
276 stars 49 forks source link

custom text ? #170

Closed walshe closed 7 years ago

walshe commented 7 years ago

Hi

is there anyway one can add any custom text desc for a particular endpoint

AdriVanHoudt commented 7 years ago

If you add a description property to the route setting it should pull that in https://github.com/hapijs/lout/blob/master/lib/index.js#L207

walshe commented 7 years ago

not understanding..

can you be more specific ?

server.route({ path: '/email', method: 'POST', handler: EmailHandler.action, config: EmailHandler.config, settings:{ description: 'test desc', notes : 'test notes' } });

walshe commented 7 years ago

figured it out:

    config: {
        validate: {
            headers: headerSchema,
            payload: emailPayloadSchema
        },
        description: 'test desc',
        notes : 'test notes'

    }