added jsdoc definitions to apis
This commit is contained in:
@@ -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"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
}
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user