Code-Referenz

Dieses Kapitel enthält die automatisch aus den Docstrings des Backend-Quellcodes generierte API-Referenz. Alle öffentlichen Module, Klassen und Funktionen sind hier dokumentiert.

Module

• backend.main
  • validate_env()
  • csrf_cookie_guard()
  • global_exception_handler()
  • http_exception_handler()
  • startup_event()
  • periodic_token_cleanup()
  • start_background_tasks()
  • get_todo_list()
  • login()
  • refresh_token()
  • logout()
  • get_csrf_token()
  • get_me()
  • update_user()
  • change_password()
  • get_users_list()
  • get_user_todo()
  • set_user_todo_done()
  • get_version_dict()
  • health_check()
• backend.database
  • get_db()
• backend.auth
  • get_token_from_cookie_or_header()
  • hash_pw()
  • verify_password()
  • authenticate_user()
  • create_access_token()
  • revoke_all_refresh_tokens_for_user()
  • create_refresh_token()
  • rotate_refresh_token()
  • verify_refresh_token()
  • revoke_refresh_token()
  • blacklist_access_token()
  • create_password_reset_token()
  • get_db()
  • get_current_user()
  • get_current_user_dep()
  • check_user_role()
  • verify_password_reset_token()
  • generate_ical_token()
  • verify_ical_token()
• backend.models
  • time_to_str()
  • User
  • UsedPasswordResetToken
  • RefreshToken
  • TokenBlacklist
  • RehTodo
  • RehSong
  • Rehearsal
  • Gig
  • Song
  • SongCandidateFeedback
  • Set
  • SetSong
  • GigSet
  • GigScheduleItem
  • Surveys
  • SurveyFields
  • SurveyFeedback
  • GigChecklistItem
  • Availability
• backend.schemas
  • LoginRequest
  • TokenResponse
  • RefreshRequest
  • LogoutRequest
  • UserGroup
  • UserStatus
  • UserCreate
  • UserOut
  • UserTodo
  • SongForFeedback
  • SurveyForFeedback
  • GigChecklistTodoOut
  • UserTodoList
  • PasswordUpdateRequest
  • PasswordResetRequest
  • SoftConfigOption
  • SoftConfigUpdateIn
  • SoftConfigOut
  • SoftConfigMeta
  • SoftConfigAdminResponse
  • SoftConfigUpdateResponse
  • SongIn
  • SongFeedbackIn
  • SongFeedbackBase
  • SongFeedbackSummary
  • SongCandidateOut
  • SongOut
  • SongScrawlOut
  • GigIn
  • NewGig
  • GigOut
  • GigScheduleItemIn
  • GigScheduleItemOut
  • GigScheduleOut
  • GigScheduleBulkItemIn
  • GigScheduleBulkUpdateIn
  • GigNotesIn
  • SetOut
  • SongInSetOut
  • SetInGigOut
  • GigSetlistTimingOut
  • GigSetlistOut
  • SongInSetLM
  • SongInSetLMUpdate
  • SetInGigLM
  • GigSetListLiveMode
  • GetSetlistIn
  • SongToSetIn
  • TodoInSong
  • SongInReh
  • SongRehearsalHistoryTodo
  • SongRehearsalHistoryEntry
  • GigPlayedEntry
  • CompanionSong
  • SongStatistics
  • GigOverviewEntry
  • TopSongEntry
  • TopSkippedSongEntry
  • GenreTimelinePoint
  • GenrePaletteOut
  • SeasonStatistics
  • GigStatsSongEntry
  • GigStatsSetEntry
  • GigStatistics
  • RehListElem
  • NewRehDict
  • UserListElem
  • SurveyFeedbackOut
  • SurveyFieldsOut
  • SurveyQuestionOut
  • SurveyList
  • SurveyFieldIn
  • SurveyIn
  • SurveyFieldAppendIn
  • SurveyFieldsAppendIn
  • PublicSongHistogram
  • PublicDate
  • GigChecklistItemIn
  • GigChecklistItemOut
  • AvailabilityStatus
  • AvailabilityIn
  • AvailabilityOut
  • EventAvailabilityOut
  • PendingAvailabilityGigOut
• backend.app_config
  • ConfigValidationError
  • load_config()
  • get_config()
  • get_soft_config()
  • get_soft_config_updated_at()
  • update_soft_config()
  • get_frontend_config()
• backend.routers
  • backend.routers.admin
  • backend.routers.cal
  • backend.routers.gigs
  • backend.routers.gigs_livemode
  • backend.routers.password_reset
  • backend.routers.public
  • backend.routers.rehearsals
  • backend.routers.songs
  • backend.routers.surveys
• backend.services
  • backend.services.setlist
• backend.utils
  • backend.utils.check_permissions
  • backend.utils.email
  • backend.utils.mattermost
  • backend.utils.password_validator
  • backend.utils.token_cleanup
• backend.pdf
  • backend.pdf.generator