HS-API
Contents:
Usage Guide
Development Guide
API Reference
HS-API
Index
Index
A
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
A
ACTIVE (app.utils.ProjectStateEnum attribute)
app
module
app.app
module
app.auth
module
app.auth.auth_controller
module
app.auth.fenix
module
app.auth.fenix.fenix_service
module
app.auth.permission_strategies
module
app.auth.scopes
module
app.auth.scopes.system_scopes
module
app.auth.utils
module
app.commands
module
app.config
module
app.decorators
module
app.errors
module
app.extensions
module
app.models
module
app.models.member_model
module
app.models.project_model
module
app.models.project_participation_model
module
app.schemas
module
app.schemas.fenix_callback_schema
module
app.schemas.fenix_user_schema
module
app.schemas.login_schema
module
app.schemas.member_schema
module
app.schemas.project_participation_schema
module
app.schemas.project_schema
module
app.schemas.update_member_schema
module
app.schemas.update_project_participation_schema
module
app.schemas.update_project_schema
module
app.utils
module
args (app.auth.permission_strategies.Ctx attribute)
assert_valid_general_scope_endpoint() (in module app.auth.permission_strategies)
assert_valid_project_scope_endpoint() (in module app.auth.permission_strategies)
AuthController (class in app.auth.auth_controller)
authCtx (app.auth.permission_strategies.Ctx attribute)
C
CLIENT_ID (app.config.Config attribute)
CLIENT_SECRET (app.config.Config attribute)
code (app.schemas.fenix_callback_schema.FenixCallbackSchema attribute)
Config (class in app.config)
course (app.models.member_model.Member attribute)
(app.schemas.member_schema.MemberSchema attribute)
(app.schemas.update_member_schema.UpdateMemberSchema attribute)
create_app() (in module app.app)
Ctx (class in app.auth.permission_strategies)
D
description (app.models.member_model.Member attribute)
(app.models.project_model.Project attribute)
(app.schemas.member_schema.MemberSchema attribute)
(app.schemas.project_schema.ProjectSchema attribute)
(app.schemas.update_member_schema.UpdateMemberSchema attribute)
(app.schemas.update_project_schema.UpdateProjectSchema attribute)
E
email (app.models.member_model.Member attribute)
(app.schemas.fenix_user_schema.FenixUserSchema attribute)
(app.schemas.member_schema.MemberSchema attribute)
(app.schemas.update_member_schema.UpdateMemberSchema attribute)
ENABLED_ACCESS_CONTROL (app.config.Config attribute)
end_date (app.models.project_model.Project attribute)
(app.schemas.project_schema.ProjectSchema attribute)
(app.schemas.update_project_schema.UpdateProjectSchema attribute)
error (app.schemas.fenix_callback_schema.FenixCallbackSchema attribute)
exit_date (app.models.member_model.Member attribute)
(app.schemas.member_schema.MemberSchema attribute)
(app.schemas.update_member_schema.UpdateMemberSchema attribute)
extra (app.models.member_model.Member attribute)
(app.schemas.member_schema.MemberSchema attribute)
(app.schemas.update_member_schema.UpdateMemberSchema attribute)
F
FENIX_REDIRECT_ENDPOINT (app.config.Config attribute)
FenixCallbackSchema (class in app.schemas.fenix_callback_schema)
FenixService (class in app.auth.fenix.fenix_service)
FenixUserSchema (class in app.schemas.fenix_user_schema)
fetch_access_token() (app.auth.fenix.fenix_service.FenixService method)
fetch_user_info() (app.auth.fenix.fenix_service.FenixService method)
from_member() (app.schemas.member_schema.MemberSchema class method)
from_participation() (app.schemas.project_participation_schema.ProjectParticipationSchema class method)
from_project() (app.schemas.project_schema.ProjectSchema class method)
from_schema() (app.models.member_model.Member class method)
(app.models.project_model.Project class method)
(app.models.project_participation_model.ProjectParticipation class method)
from_yaml_config() (app.auth.scopes.system_scopes.SystemScopes class method)
G
general_scope_evaluator() (in module app.auth.permission_strategies)
get_role() (app.auth.scopes.system_scopes.Scope method)
get_scope() (app.auth.scopes.system_scopes.SystemScopes method)
gunicorn_conf
module
H
handle_http_exception() (in module app.errors)
handle_validation_error() (in module app.errors)
has_priority() (app.auth.scopes.system_scopes.SystemScopes method)
I
id (app.models.member_model.Member attribute)
(app.models.project_model.Project attribute)
(app.models.project_participation_model.ProjectParticipation attribute)
IMAGES_PATH (app.config.Config attribute)
INACTIVE (app.utils.ProjectStateEnum attribute)
is_valid_datestring() (in module app.utils)
is_valid_timestring() (in module app.utils)
ist_id (app.models.member_model.Member attribute)
(app.schemas.fenix_user_schema.FenixUserSchema attribute)
(app.schemas.member_schema.MemberSchema attribute)
J
join_date (app.models.member_model.Member attribute)
(app.models.project_participation_model.ProjectParticipation attribute)
(app.schemas.member_schema.MemberSchema attribute)
(app.schemas.project_participation_schema.ProjectParticipationSchema attribute)
(app.schemas.update_member_schema.UpdateMemberSchema attribute)
(app.schemas.update_project_participation_schema.UpdateProjectParticipationSchema attribute)
K
kwargs (app.auth.permission_strategies.Ctx attribute)
L
login_member() (app.auth.auth_controller.AuthController method)
LoginSchema (class in app.schemas.login_schema)
logout_member() (app.auth.auth_controller.AuthController method)
M
matches_password() (app.models.member_model.Member method)
MAX_CONTENT_LENGTH (app.config.Config attribute)
member (app.models.project_participation_model.ProjectParticipation attribute)
Member (class in app.models.member_model)
member_id (app.models.project_participation_model.ProjectParticipation attribute)
member_number (app.models.member_model.Member attribute)
(app.schemas.member_schema.MemberSchema attribute)
(app.schemas.update_member_schema.UpdateMemberSchema attribute)
MemberSchema (class in app.schemas.member_schema)
model_config (app.auth.scopes.system_scopes.Role attribute)
(app.auth.scopes.system_scopes.Scope attribute)
(app.auth.scopes.system_scopes.SystemScopes attribute)
(app.schemas.fenix_callback_schema.FenixCallbackSchema attribute)
(app.schemas.fenix_user_schema.FenixUserSchema attribute)
(app.schemas.login_schema.LoginSchema attribute)
(app.schemas.member_schema.MemberSchema attribute)
(app.schemas.project_participation_schema.ProjectParticipationSchema attribute)
(app.schemas.project_schema.ProjectSchema attribute)
(app.schemas.update_member_schema.UpdateMemberSchema attribute)
(app.schemas.update_project_participation_schema.UpdateProjectParticipationSchema attribute)
(app.schemas.update_project_schema.UpdateProjectSchema attribute)
module
app
app.app
app.auth
app.auth.auth_controller
app.auth.fenix
app.auth.fenix.fenix_service
app.auth.permission_strategies
app.auth.scopes
app.auth.scopes.system_scopes
app.auth.utils
app.commands
app.config
app.decorators
app.errors
app.extensions
app.models
app.models.member_model
app.models.project_model
app.models.project_participation_model
app.schemas
app.schemas.fenix_callback_schema
app.schemas.fenix_user_schema
app.schemas.login_schema
app.schemas.member_schema
app.schemas.project_participation_schema
app.schemas.project_schema
app.schemas.update_member_schema
app.schemas.update_project_participation_schema
app.schemas.update_project_schema
app.utils
gunicorn_conf
N
name (app.auth.scopes.system_scopes.Role attribute)
(app.auth.scopes.system_scopes.Scope attribute)
(app.models.member_model.Member attribute)
(app.models.project_model.Project property)
(app.schemas.fenix_user_schema.FenixUserSchema attribute)
(app.schemas.member_schema.MemberSchema attribute)
(app.schemas.project_schema.ProjectSchema attribute)
(app.schemas.update_member_schema.UpdateMemberSchema attribute)
(app.schemas.update_project_schema.UpdateProjectSchema attribute)
O
ORIGINS_WHITELIST (app.config.Config attribute)
P
password (app.models.member_model.Member property)
(app.schemas.login_schema.LoginSchema attribute)
(app.schemas.member_schema.MemberSchema attribute)
(app.schemas.update_member_schema.UpdateMemberSchema attribute)
PERMANENT_SESSION_LIFETIME (app.config.Config attribute)
permission (app.auth.permission_strategies.Ctx attribute)
permissions (app.auth.scopes.system_scopes.Role attribute)
privilege (app.auth.scopes.system_scopes.Role attribute)
project (app.models.project_participation_model.ProjectParticipation attribute)
Project (class in app.models.project_model)
project_id (app.models.project_participation_model.ProjectParticipation attribute)
project_name (app.schemas.project_participation_schema.ProjectParticipationSchema attribute)
project_participations (app.models.member_model.Member attribute)
(app.models.project_model.Project attribute)
project_scope_evaluator() (in module app.auth.permission_strategies)
ProjectParticipation (class in app.models.project_participation_model)
ProjectParticipationSchema (class in app.schemas.project_participation_schema)
ProjectSchema (class in app.schemas.project_schema)
ProjectStateEnum (class in app.utils)
R
redirect_url() (app.auth.fenix.fenix_service.FenixService method)
register_cli_commands() (in module app.commands)
requires_login() (app.auth.auth_controller.AuthController method)
requires_permission() (app.auth.auth_controller.AuthController method)
Role (class in app.auth.scopes.system_scopes)
roles (app.auth.scopes.system_scopes.Scope attribute)
(app.models.member_model.Member property)
(app.models.project_participation_model.ProjectParticipation property)
(app.schemas.member_schema.MemberSchema attribute)
(app.schemas.project_participation_schema.ProjectParticipationSchema attribute)
(app.schemas.update_member_schema.UpdateMemberSchema attribute)
(app.schemas.update_project_participation_schema.UpdateProjectParticipationSchema attribute)
ROLES_PATH (app.config.Config attribute)
ROOT_URI (app.config.Config attribute)
S
Scope (class in app.auth.scopes.system_scopes)
scopes (app.auth.scopes.system_scopes.SystemScopes attribute)
SECRET_KEY (app.config.Config attribute)
SENTRY_DSN (app.config.Config attribute)
SESSION_CACHELIB (app.config.Config attribute)
SESSION_COOKIE_HTTPONLY (app.config.Config attribute)
SESSION_COOKIE_SAMESITE (app.config.Config attribute)
SESSION_COOKIE_SECURE (app.config.Config attribute)
SESSION_TYPE (app.config.Config attribute)
set_sqlite_pragma() (in module app.extensions)
setup_logger() (in module app.app)
slug (app.models.project_model.Project attribute)
(app.schemas.project_schema.ProjectSchema attribute)
slugify() (in module app.utils)
SQLALCHEMY_DATABASE_URI (app.config.Config attribute)
start_date (app.models.project_model.Project attribute)
(app.schemas.project_schema.ProjectSchema attribute)
(app.schemas.update_project_schema.UpdateProjectSchema attribute)
state (app.models.project_model.Project attribute)
(app.schemas.fenix_callback_schema.FenixCallbackSchema attribute)
(app.schemas.project_schema.ProjectSchema attribute)
(app.schemas.update_project_schema.UpdateProjectSchema attribute)
SystemScopes (class in app.auth.scopes.system_scopes)
T
transactional() (in module app.decorators)
U
UNDEFINED (app.utils.ProjectStateEnum attribute)
UpdateMemberSchema (class in app.schemas.update_member_schema)
UpdateProjectParticipationSchema (class in app.schemas.update_project_participation_schema)
UpdateProjectSchema (class in app.schemas.update_project_schema)
username (app.models.member_model.Member attribute)
(app.schemas.login_schema.LoginSchema attribute)
(app.schemas.member_schema.MemberSchema attribute)
(app.schemas.project_participation_schema.ProjectParticipationSchema attribute)
(app.schemas.update_member_schema.UpdateMemberSchema attribute)
V
validate_course() (app.models.member_model.Member method)
validate_datestring() (app.models.member_model.Member method)
(app.models.project_participation_model.ProjectParticipation method)
(app.schemas.member_schema.MemberSchema class method)
(app.schemas.project_participation_schema.ProjectParticipationSchema class method)
(app.schemas.update_member_schema.UpdateMemberSchema class method)
(app.schemas.update_project_participation_schema.UpdateProjectParticipationSchema class method)
(app.schemas.update_project_schema.UpdateProjectSchema class method)
validate_description() (app.models.member_model.Member method)
(app.models.project_model.Project method)
validate_end_date() (app.models.project_model.Project method)
validate_end_datestring() (app.schemas.project_schema.ProjectSchema class method)
validate_ist_id() (app.models.member_model.Member method)
validate_member_number() (app.models.member_model.Member method)
validate_name() (app.models.member_model.Member method)
(app.models.project_model.Project method)
validate_permissions() (app.auth.scopes.system_scopes.Role class method)
validate_start_date() (app.models.project_model.Project method)
validate_start_datestring() (app.schemas.project_schema.ProjectSchema class method)
validate_state() (app.models.project_model.Project method)
validate_username() (app.models.member_model.Member method)