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.
I am thinking about a feature that allows the user to add a description to specific HTTP methods of a resource.
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.