This module allows using a doc_resource/1 macro to generate documentation about a specific action.

The schema_subdir property is optional. It should be used when the JSON schema files are placed in a sub-directory.

E.g.

  doc_resource name: "conversation-new",
               schema_subdir: "action"
               description: """
               Create a new group conversation.
               """,
               example: %{
                 request: """
                   {
                     "name": "My new convo",
                     "participants": {
                       "user-two": "admin",
                       "user-one": "normal"
                     }
                   }
                 """,
                 response: """
                   {
                     "id": "921167d9-9a0d-4b66-935e-9c6efb2a1220"
                   }
                 """
               }