Resources in RspecApiDocumentation can have explanations. But they don't show when using json
format with raddocs
html browser.
Example:
user_spec.rb:
resource 'User' do
explanation "a User resource, duh"
...
index.json:
{
"name": "User",
"explanation": "a User resource, duh"
...
}
Turns out I was using raddocs v 1.1. The support for resource explanation is introduced in raddocs v 2.0.