Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 852 Bytes

cred-class-field-documentation-url-missing.md

File metadata and controls

35 lines (24 loc) · 852 Bytes

cred-class-field-documentation-url-missing

documentationUrl field in credential class must be present.

📋 This rule is part of the plugin:n8n-nodes-base/credentials config.

🔧 Run ESLint with --fix option to autofix the issue flagged by this rule.

Examples

❌ Example of incorrect code:

class TestApi implements ICredentialType {
    name = 'myTestApi';
    displayName = 'My Test API';
}

✅ Example of correct code:

class MyTestApi implements ICredentialType {
    name = 'myTestApi';
    displayName = 'My Test API';
    documentationUrl = 'myTest';
}

Links