Skip to main content

UserOnboardingController

Guided-tour progress is per-user personalization, not a privileged resource: every endpoint is scoped to the caller's own userId, so authentication alone is sufficient (same reasoning as UserNavPreferenceController).

Base path/api/onboarding/tours
ModulePlatform Misc
Endpoints3
OpenAPI tagOnboarding
Sourcebackend/src/main/java/com/motorph/payroll/controller/UserOnboardingController.java

Endpoints​

MethodPathRequiresHandler
GET/api/onboarding/toursAny authenticated userlist()
PUT/api/onboarding/tours/{tourKey}Any authenticated usersave()
DELETE/api/onboarding/tours/{tourKey}Any authenticated userforget()

Call chain​

Dependencies​

Constructor-injected by Lombok's @RequiredArgsConstructor: UserOnboardingService.

Tables reached​

EntityTableTenant-scoped
UserOnboardingProgressuser_onboarding_progressYes

Generated page

This page is rebuilt from the source on every docs build by docs-site/scripts/gen-code-wiki.mjs. Editing it has no effect — change the code, or, if what you want to say is prose, write it in docs/.