apidoc.code-snippets

{
	"apidoc boilerplate": {
		"scope": "javascript, typescript",
		"prefix": "apidoc",
		"body": [
			"/**",
			" * @api {$1} /$2/$3 $4",
			" * @apiVersion 1.0.0",
			" * @apiName $1-$3",
			" * @apiGroup $2",
			" * @apiPermission $5",
			" *",
			" * @apiParam (Body) {String} $0",
			" * ",
			" * @apiSuccessExample Success:",
			" *     HTTP/1.1 200 OK",
			" *     {",
			" *       \"message\": \"message\",",
			" *     }",
			" * ",
			" * @apiErrorExample Error - Validation:",
			" *     HTTP/1.1 400 Bad Request",
			" * ",
			" *     {",
			" *       \"error\": \"message\"",
			" *     }",
			" * ",
			" * @apiSampleRequest off",
			" */"
		],
		"description": "generates apidoc boilerplate"
	}
}