mirror of
https://github.com/langgenius/dify.git
synced 2026-06-17 06:21:07 +08:00
f5c5dbaed5
Install OpenApiErrorFormatter on the openapi blueprint's ExternalApi so
all non-2xx responses from /openapi/v1 carry the canonical ErrorBody shape
(code, message, status, optional details/hint). RFC 8628 device-flow
endpoints are unaffected — their flat {error: ...} shape is passed through
unchanged.
Also: set catch_all_404s=True when a formatter is present so unknown
routes return canonical JSON 404s (not Flask's default HTML 404).
Override _help_on_404 to suppress route suggestions, which would corrupt
the JSON contract and enumerate routes to unauthenticated callers.
Both behaviours are scoped by formatter presence — other blueprints that
construct ExternalApi without error_body_formatter are byte-identical.
Wire-level tests added to TestWireContract (3 tests, 18 total):
- 422 from @accepts validation carries code/status/details
- unknown-route 404 is canonical JSON without route suggestions
- device token POST returns RFC 8628 flat shape untouched by formatter
153 lines
3.4 KiB
Python
153 lines
3.4 KiB
Python
from flask import Blueprint
|
|
from flask_restx import Namespace
|
|
|
|
from controllers.openapi._errors import OpenApiErrorFormatter
|
|
from libs.device_flow_security import attach_anti_framing
|
|
from libs.external_api import ExternalApi
|
|
|
|
bp = Blueprint("openapi", __name__, url_prefix="/openapi/v1")
|
|
attach_anti_framing(bp)
|
|
|
|
api = ExternalApi(
|
|
bp,
|
|
version="1.0",
|
|
title="OpenAPI",
|
|
description="User-scoped programmatic API (bearer auth)",
|
|
error_body_formatter=OpenApiErrorFormatter(),
|
|
)
|
|
|
|
openapi_ns = Namespace("openapi", description="User-scoped operations", path="/")
|
|
|
|
# Register response/query models BEFORE importing controller modules so that
|
|
# @openapi_ns.response / @openapi_ns.expect decorators can resolve model names.
|
|
from controllers.common.schema import register_response_schema_models, register_schema_models
|
|
from controllers.openapi._models import (
|
|
AccountPayload,
|
|
AccountResponse,
|
|
AppDescribeInfo,
|
|
AppDescribeQuery,
|
|
AppDescribeResponse,
|
|
AppInfoResponse,
|
|
AppListQuery,
|
|
AppListResponse,
|
|
AppListRow,
|
|
AppRunRequest,
|
|
DeviceCodeRequest,
|
|
DeviceCodeResponse,
|
|
DeviceLookupQuery,
|
|
DeviceLookupResponse,
|
|
DeviceMutateRequest,
|
|
DeviceMutateResponse,
|
|
DevicePollRequest,
|
|
FormSubmitResponse,
|
|
HealthResponse,
|
|
MemberActionResponse,
|
|
MemberInvitePayload,
|
|
MemberInviteResponse,
|
|
MemberListQuery,
|
|
MemberListResponse,
|
|
MemberResponse,
|
|
MemberRoleUpdatePayload,
|
|
MessageMetadata,
|
|
PermittedExternalAppsListQuery,
|
|
PermittedExternalAppsListResponse,
|
|
RevokeResponse,
|
|
ServerVersionResponse,
|
|
SessionListQuery,
|
|
SessionListResponse,
|
|
SessionRow,
|
|
TagItem,
|
|
TaskStopResponse,
|
|
UsageInfo,
|
|
WorkflowRunData,
|
|
WorkspaceDetailResponse,
|
|
WorkspaceListResponse,
|
|
WorkspacePayload,
|
|
WorkspaceSummaryResponse,
|
|
)
|
|
from fields.file_fields import FileResponse
|
|
|
|
register_schema_models(
|
|
openapi_ns,
|
|
AppDescribeQuery,
|
|
AppListQuery,
|
|
AppRunRequest,
|
|
DeviceCodeRequest,
|
|
DevicePollRequest,
|
|
DeviceLookupQuery,
|
|
DeviceMutateRequest,
|
|
MemberInvitePayload,
|
|
MemberListQuery,
|
|
MemberRoleUpdatePayload,
|
|
PermittedExternalAppsListQuery,
|
|
SessionListQuery,
|
|
)
|
|
register_response_schema_models(
|
|
openapi_ns,
|
|
TagItem,
|
|
UsageInfo,
|
|
MessageMetadata,
|
|
AppListRow,
|
|
AppListResponse,
|
|
AppInfoResponse,
|
|
AppDescribeInfo,
|
|
AppDescribeResponse,
|
|
WorkflowRunData,
|
|
AccountPayload,
|
|
WorkspacePayload,
|
|
AccountResponse,
|
|
SessionRow,
|
|
SessionListResponse,
|
|
PermittedExternalAppsListResponse,
|
|
RevokeResponse,
|
|
WorkspaceSummaryResponse,
|
|
WorkspaceListResponse,
|
|
WorkspaceDetailResponse,
|
|
MemberResponse,
|
|
MemberListResponse,
|
|
MemberInviteResponse,
|
|
MemberActionResponse,
|
|
TaskStopResponse,
|
|
FormSubmitResponse,
|
|
DeviceCodeResponse,
|
|
DeviceLookupResponse,
|
|
DeviceMutateResponse,
|
|
FileResponse,
|
|
ServerVersionResponse,
|
|
HealthResponse,
|
|
)
|
|
|
|
from . import (
|
|
_meta,
|
|
account,
|
|
app_run,
|
|
apps,
|
|
apps_permitted_external,
|
|
files,
|
|
human_input_form,
|
|
index,
|
|
oauth_device,
|
|
oauth_device_sso,
|
|
workflow_events,
|
|
workspaces,
|
|
)
|
|
|
|
# Request models are imported from _models.py and registered above.
|
|
|
|
__all__ = [
|
|
"_meta",
|
|
"account",
|
|
"app_run",
|
|
"apps",
|
|
"apps_permitted_external",
|
|
"files",
|
|
"human_input_form",
|
|
"index",
|
|
"oauth_device",
|
|
"oauth_device_sso",
|
|
"workflow_events",
|
|
"workspaces",
|
|
]
|
|
|
|
api.add_namespace(openapi_ns)
|