pyeve / eve-swagger

Swagger extension for Eve-powered RESTful APIs
http://python-eve.org
Other
154 stars 43 forks source link

Description of HTTP methods #22

Closed otibsa closed 8 years ago

otibsa commented 8 years ago

I am thinking about a feature that allows the user to add a description to specific HTTP methods of a resource.

people = {
    'method_description': {
        'GET': 'If you send a GET request to the /people endpoint, then foobar',
        'GET_item': 'A request for one person activates a hook that does something',
        'DELETE': '...'
    },
    'schema': {...}
}

The descriptions would show up in the swagger doc under the correct paths (/people: {get: {description: ...}}) additionally to the summary ("Retrieves one or more people") that is already there.

I am happy to implement this feature if you think it is useful.