Add more schema descriptions

[alexandrudanpop]

Part of OPS-2337, OPS-2442

[linear]

OPS-2337 Add update step tool & update trigger tool

[alexandrudanpop]

needed for OPS-2442

[MarceloRGonc]

I think this should be in a different file and not sure if in this repo. It will only be used on the new routes right?

[linear]

OPS-2442 Remove Id generation from Add step

[Copilot]

Pull Request Overview

This PR adds descriptive schema documentation to improve clarity and usability of flow-related types and schemas. The changes focus on providing detailed descriptions for trigger properties, sample data handling, and action configurations to help developers better understand the expected structure and usage patterns.

• Enhanced trigger schema descriptions with clear usage guidelines and examples
• Added comprehensive documentation for input objects and sample data properties
• Improved action naming conventions and input property documentation

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File	Description
packages/shared/src/lib/flows/triggers/trigger.ts	Added descriptions for trigger properties including naming conventions and input structure examples
packages/shared/src/lib/flows/sample-data.ts	Enhanced sample data schema with usage guidelines and added missing default property
packages/shared/src/lib/flows/flow-operations.ts	Improved parent step description with concrete examples and added new composite type
packages/shared/src/lib/flows/actions/action.ts	Updated action naming conventions and input object documentation with step reference syntax

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[rita-gorokhod]

@alexandrudanpop do we need this? step_{autoincrement} ? it can absolutely be {{step_stepId}}. Can also be {{my_step}}

[alexandrudanpop]

This was how they were added from the UI. Shouldn't we keep it consistent for the user (because they will see it when it's referenced)?
We could add this logic in the tool instead of relying on the LLM.

openops/packages/react-ui/src/app/features/builder/blocks-selector/block-selector-utils.ts

Lines 36 to 47 in 6ef1582

	const getStepName = (block: StepMetadata, flowVersion: FlowVersion) => {
	if (block.type === TriggerType.BLOCK) {
	return 'trigger';
	}
	const baseName = 'step_';
	let number = 1;
	const steps = flowHelper.getAllSteps(flowVersion.trigger);
	while (steps.some((step) => step.name === `${baseName}${number}`)) {
	number++;
	}
	return `${baseName}${number}`;
	};

[alexandrudanpop]

fixed, the tool will do it.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud