Skip to content

ScreenToApiMapping

reference
1 min readUpdated

Kind: Interface

Source: atloria-monorepo/packages/doc-automation/src/v2/types/cross-language.types.ts

Properties

PropertyType
screenIdstring
screenNamestring
screenPathstring
apiCalls`Array<{
method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
endpoint: string; // "/api/sales/orders"
controllerId?: string; // Entity ID of controller
controllerName?: string; // "SalesOrderController"
purpose: string; // "Create new order"

}>| |userActions|Array<{ trigger: 'button_click' | 'form_submit' | 'page_load' | 'auto'; label: string; // "Submit Order" resultingCall: string; // endpoint reference }>` |

Was this page helpful?

Download as PDF