puppy-api-docs/test_comment.js

Genernate material api docs from your comments.

/*
@docstart
{
    "title": "Login",
    "method": "POST",
    "group": "Authentication",
    "description": "Login with email and password for consumers and admins.",
    "path": "/login",
    "response": {
        "status": 200,
        "message": "Help message depending on success",
        "success": false
    },
    "request": {
        "data": {
            "email": "User's email",
            "password": "User's Password"
        }
    },
    "requestHeaders": {
        "Content-Type": "application/json"
    },
    "responseHeaders": {
        "token": "session token"
    }
}
@docend

@docstart
{
    "title": "Login 2nd",
    "group": "Authentication",
    "method": "POST",
    "path": "/loginAlternate",
    "description": "If /login doesn't work. Use this end point."
}
@docend
*/

/*
@docstart
{
    "title": "Get todo list",
    "method": "GET",
    "description": "Login with email and password for consumers and admins.",
    "path": "/todolist",
    "response": {
        "status": 200,
        "message": "Help message depending on success",
        "success": true
    },
    "request": {
        "data": {
            "email": "User's email",
            "password": "User's Password"
        }
    },
    "requestHeaders": {
        "token": "token provided in login response"
    }
}
@docend
*/