Kind: Interface
Source: atloria-monorepo/packages/doc-automation/src/v2/types/cross-language.types.ts
Full Screen-to-API map for a component
The final output connecting UI to backend for documentation.
Properties
| Property | Type |
|---|---|
componentName | string |
componentPath | string |
route | string |
apiCalls | `Array<{ |
userAction: string; // "Click Save button" serviceMethod: string; // "newJobService.createJob()" httpMethod: string; // "POST" endpoint: string; // "/api/sales/jobs" purpose: string; // "Create new sales job" triggerElement?: string; // "dx-button[text='Save']"
}>| |stateBasedCalls|Array<{
state: string; // "OrderStageEnum.Pending"
availableActions: string[]; // ["approve", "reject", "cancel"]
disabledActions: string[]; // ["createNew"]
}>` |
Was this page helpful?