added jsdoc definitions to apis

This commit is contained in:
2023-03-10 12:21:10 +00:00
parent d8f0972170
commit 6dc71b894a
59 changed files with 2288 additions and 64 deletions
+24
View File
@@ -3,7 +3,31 @@
"rules": {
"@next/next/no-img-element": "off",
"react/no-unknown-property": "error"
},
//...your configuration
"overrides": [
//...your overrides
{
// Force the setting of a swagger description on each api endpoint
"files": ["pages/api/**/*.js"],
"plugins": ["jsdoc"],
"rules": {
"jsdoc/no-missing-syntax": [
"error",
{
"contexts": [
{
"comment": "JsdocBlock:has(JsdocTag[tag=swagger])",
"context": "any",
"message": "@swagger documentation is required on each API. Check this out for syntax info: https://github.com/jellydn/next-swagger-doc"
}
]
}
]
}
}
]
}