cred-class-field-display-name-missing-oauth2.md

cred-class-field-display-name-missing-oauth2

displayName field in credential class must mention OAuth2 if the credential is OAuth2.

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

Examples

❌ Example of incorrect code:

class MyTestOAuth2Api implements ICredentialType {
    name = 'myTestOAuth2Api';
    displayName = 'My Test API';
    documentationUrl = 'myTest';
    extends = [
        'oAuth2Api',
    ];
}

✅ Example of correct code:

class MyTestOAuth2Api implements ICredentialType {
    name = 'myTestOAuth2Api';
    displayName = 'My Test OAuth2 API';
    documentationUrl = 'myTest';
    extends = [
        'oAuth2Api',
    ];
}

Links

• Rule source
• Test source