You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
When documenting API endpoints, most will pull from descriptions in the actions they call, eg.
read:searchdodescription"List Artists, optionally filtering by name."
But some endpoints need more specific documentation, eg. get routes, which would usually point at a generic read action. And some endpoints, like related/relationship endpoints, can't be documented at all?
Describe the solution you'd like
A description option added for all routes, that if provided would be used in generated documentation, overriding any action-specific description.
Express the feature either with a change to resource syntax, or with a change to the resource interface
routesdobase_route"/artists",Tunez.Music.Artistdoget:read,description: "Fetch an Artist record by ID."related:albums,:read,primary?: true,description: "Fetch all Albums released by the given Artist."end
The text was updated successfully, but these errors were encountered:
Is your feature request related to a problem? Please describe.
When documenting API endpoints, most will pull from descriptions in the actions they call, eg.
But some endpoints need more specific documentation, eg.
get
routes, which would usually point at a genericread
action. And some endpoints, likerelated
/relationship
endpoints, can't be documented at all?Describe the solution you'd like
A
description
option added for all routes, that if provided would be used in generated documentation, overriding any action-specific description.Express the feature either with a change to resource syntax, or with a change to the resource interface
The text was updated successfully, but these errors were encountered: