mirror of
https://github.com/langgenius/dify.git
synced 2026-09-02 06:03:18 +08:00
d25e2b51fc
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: hjlarry <hjlarry@163.com>
80 lines
3.6 KiB
Python
80 lines
3.6 KiB
Python
"""Console onboarding APIs.
|
|
|
|
This module keeps Step-by-step Tour persistence account-scoped. Workspace IDs
|
|
are accepted only as presentation overrides; UI-only state such as minimized
|
|
panels or the currently active task stays on the frontend. PATCH requests are
|
|
action-based so callers do not replace server-side arrays with stale snapshots.
|
|
"""
|
|
|
|
from datetime import datetime
|
|
|
|
from flask_restx import Resource
|
|
from pydantic import BaseModel, ConfigDict, Field, model_validator
|
|
|
|
from controllers.common.schema import register_response_schema_models, register_schema_models
|
|
from controllers.console.flask_admission import console_account_admission
|
|
from controllers.console.wraps import model_validate
|
|
from extensions.ext_application_services import application_services
|
|
from fields.base import ResponseModel
|
|
from libs.helper import dump_response
|
|
from machinery.context import RequestContext
|
|
from services.entities.onboarding_entities import StepByStepTourAction, StepByStepTourPatch, StepByStepTourTaskId
|
|
|
|
from . import console_ns
|
|
|
|
|
|
class StepByStepTourStatePatchPayload(BaseModel):
|
|
action: StepByStepTourAction = Field(description="State update action")
|
|
task_id: StepByStepTourTaskId | None = Field(default=None, description="Task ID for task actions")
|
|
|
|
model_config = ConfigDict(extra="forbid")
|
|
|
|
@model_validator(mode="after")
|
|
def validate_patch_shape(self) -> "StepByStepTourStatePatchPayload":
|
|
task_actions = {"complete_task", "uncomplete_task"}
|
|
if self.action in task_actions and self.task_id is None:
|
|
raise ValueError("task_id is required for task actions")
|
|
if self.action not in task_actions and self.task_id is not None:
|
|
raise ValueError("task_id is only supported for task actions")
|
|
|
|
return self
|
|
|
|
|
|
class StepByStepTourStateResponse(ResponseModel):
|
|
first_workspace_id: str | None = None
|
|
skipped: bool = False
|
|
completed_task_ids: list[StepByStepTourTaskId] = Field(default_factory=list)
|
|
manually_enabled_workspace_ids: list[str] = Field(default_factory=list)
|
|
manually_disabled_workspace_ids: list[str] = Field(default_factory=list)
|
|
updated_at: datetime | None = None
|
|
|
|
|
|
register_schema_models(console_ns, StepByStepTourStatePatchPayload)
|
|
register_response_schema_models(console_ns, StepByStepTourStateResponse)
|
|
|
|
|
|
@console_ns.route("/onboarding/step-by-step-tour/state")
|
|
class StepByStepTourStateApi(Resource):
|
|
@console_ns.doc("get_step_by_step_tour_state")
|
|
@console_ns.doc(description="Get account-level Step-by-step Tour state")
|
|
@console_ns.response(200, "Success", console_ns.models[StepByStepTourStateResponse.__name__])
|
|
@console_account_admission()
|
|
def get(self, request_context: RequestContext):
|
|
return dump_response(
|
|
StepByStepTourStateResponse,
|
|
application_services().step_by_step_tour.get_state(request_context),
|
|
)
|
|
|
|
@console_ns.doc("patch_step_by_step_tour_state")
|
|
@console_ns.doc(description="Update account-level Step-by-step Tour state")
|
|
@console_ns.expect(console_ns.models[StepByStepTourStatePatchPayload.__name__])
|
|
@console_ns.response(200, "Success", console_ns.models[StepByStepTourStateResponse.__name__])
|
|
@console_account_admission()
|
|
@model_validate(StepByStepTourStatePatchPayload)
|
|
def patch(self, req_data: StepByStepTourStatePatchPayload, request_context: RequestContext):
|
|
patch = StepByStepTourPatch(action=req_data.action, task_id=req_data.task_id)
|
|
return dump_response(
|
|
StepByStepTourStateResponse,
|
|
application_services().step_by_step_tour.patch_state(request_context, patch),
|
|
)
|