node-param-description-missing-from-dynamic-options.md

node-param-description-missing-from-dynamic-options

description in dynamic-options-type node parameter must be present.

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

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

Examples

❌ Example of incorrect code:

const test = {
	displayName: "Field Name or ID",
	name: "field",
	type: "options",
	typeOptions: {
		loadOptionsMethod: "getFields",
	},
	default: "",
};

✅ Example of correct code:

const test = {
	displayName: "Field Name or ID",
	name: "field",
	type: "options",
	description:
		'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
	typeOptions: {
		loadOptionsMethod: "getFields",
	},
	default: "",
};

Links

• Rule source
• Test source