Class: RailsOnboarding::ApiController
- Inherits:
-
ActionController::API
- Object
- ActionController::API
- RailsOnboarding::ApiController
- Includes:
- ApiMode
- Defined in:
- lib/rails_onboarding/api_mode.rb
Overview
API Controller for dedicated API endpoints
Instance Method Summary collapse
-
#complete ⇒ Object
POST /api/onboarding/complete.
-
#complete_step ⇒ Object
POST /api/onboarding/steps/:step_name/complete.
-
#dismiss_tooltip ⇒ Object
POST /api/onboarding/tooltips/:tooltip_id/dismiss.
-
#restart ⇒ Object
POST /api/onboarding/restart.
-
#skip_step ⇒ Object
POST /api/onboarding/steps/:step_name/skip.
-
#status ⇒ Object
GET /api/onboarding/status.
-
#tooltips ⇒ Object
GET /api/onboarding/tooltips.
Methods included from ApiMode
#api_complete_onboarding, #api_complete_step, #api_dismiss_tooltip, #api_onboarding_status, #api_request?, #api_restart_onboarding, #api_skip_step, #api_tooltips_list, #authenticate_api_request!, #current_user, #render_api_error, #render_api_success
Instance Method Details
#complete ⇒ Object
POST /api/onboarding/complete
348 349 350 |
# File 'lib/rails_onboarding/api_mode.rb', line 348 def complete api_complete_onboarding end |
#complete_step ⇒ Object
POST /api/onboarding/steps/:step_name/complete
338 339 340 |
# File 'lib/rails_onboarding/api_mode.rb', line 338 def complete_step api_complete_step end |
#dismiss_tooltip ⇒ Object
POST /api/onboarding/tooltips/:tooltip_id/dismiss
363 364 365 |
# File 'lib/rails_onboarding/api_mode.rb', line 363 def dismiss_tooltip api_dismiss_tooltip end |
#restart ⇒ Object
POST /api/onboarding/restart
353 354 355 |
# File 'lib/rails_onboarding/api_mode.rb', line 353 def restart api_restart_onboarding end |
#skip_step ⇒ Object
POST /api/onboarding/steps/:step_name/skip
343 344 345 |
# File 'lib/rails_onboarding/api_mode.rb', line 343 def skip_step api_skip_step end |
#status ⇒ Object
GET /api/onboarding/status
333 334 335 |
# File 'lib/rails_onboarding/api_mode.rb', line 333 def status api_onboarding_status end |
#tooltips ⇒ Object
GET /api/onboarding/tooltips
358 359 360 |
# File 'lib/rails_onboarding/api_mode.rb', line 358 def tooltips api_tooltips_list end |