cred-class-field-documentation-url-not-http-url.md

cred-class-field-documentation-url-not-http-url

documentationUrl field in credential class must be an HTTP URL. Only applicable to community credentials.

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

Examples

❌ Example of incorrect code:

class TestApi implements ICredentialType {
	name = "myTestApi";
	displayName = "My Test API";
	documentationUrl = "lowercase";
}

class TestApi implements ICredentialType {
	name = "myTestApi";
	displayName = "My Test API";
	documentationUrl = "camelCase";
}

class TestApi implements ICredentialType {
	name = "myTestApi";
	displayName = "My Test API";
	documentationUrl = "PascalCase";
}

class TestApi implements ICredentialType {
	name = "myTestApi";
	displayName = "My Test API";
	documentationUrl = "Sentence case";
}

✅ Example of correct code:

class MyTestApi implements ICredentialType {
	name = "myTestApi";
	displayName = "My Test API";
	documentationUrl = "http://example.com/docs/auth";
}

class MyTestApi implements ICredentialType {
	name = "myTestApi";
	displayName = "My Test API";
	documentationUrl = "https://example.com/docs/auth";
}

Links

• Rule source
• Test source