mirror of
https://github.com/langgenius/dify.git
synced 2026-05-22 09:58:42 +08:00
35d9b6a0f8
Collapse the openapi-namespace per-app reads into one canonical endpoint
GET /openapi/v1/apps/<id>/describe[?fields=info,parameters,input_schema]
returning a single AppDescribeResponse with all blocks Optional and a new
JSON-Schema input_schema block derived server-side from user_input_form +
app mode.
- AppDescribeQuery (Pydantic, extra=forbid) parses the ?fields allow-list;
unknown member -> 422.
- _input_schema.build_input_schema(app) derives Draft 2020-12 JSON Schema:
chat-family modes carry top-level query (string, minLength=1, required);
workflow / completion only carry inputs. AppUnavailableError -> empty
sentinel (EMPTY_INPUT_SCHEMA).
- Drop AppByIdApi (/apps/<id>) and AppParametersApi (/apps/<id>/parameters)
route classes; delete app_info.py module + app_info_payload helper.
- AppDescribeResponse.{info,parameters,input_schema} now Optional[None].
Lock-step deploy with difyctl Phase B (/describe consumer migration).
56 lines
1.7 KiB
Python
56 lines
1.7 KiB
Python
"""Unit tests for app payload-rendering helpers — independent of
|
|
HTTP plumbing or DB. Pin the response shapes that are CLI contracts.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from types import SimpleNamespace
|
|
|
|
import pytest
|
|
|
|
from controllers.openapi.apps import ( # pyright: ignore[reportPrivateUsage]
|
|
_EMPTY_PARAMETERS,
|
|
parameters_payload,
|
|
)
|
|
from controllers.service_api.app.error import AppUnavailableError
|
|
|
|
|
|
def _fake_app(**overrides):
|
|
base = {
|
|
"id": "app1",
|
|
"name": "X",
|
|
"description": "d",
|
|
"mode": "chat",
|
|
"author_name": "alice",
|
|
"tags": [SimpleNamespace(name="prod")],
|
|
"updated_at": None,
|
|
"enable_api": True,
|
|
"workflow": None,
|
|
"app_model_config": None,
|
|
}
|
|
base.update(overrides)
|
|
return SimpleNamespace(**base)
|
|
|
|
|
|
def test_parameters_payload_raises_app_unavailable_when_no_config():
|
|
with pytest.raises(AppUnavailableError):
|
|
parameters_payload(_fake_app(mode="chat", app_model_config=None))
|
|
|
|
|
|
def test_empty_parameters_constant_matches_describe_fallback_shape():
|
|
"""The fallback dict served by /describe when an app has no config
|
|
must match the spec's stated keys (opening_statement, suggested_questions,
|
|
user_input_form, file_upload, system_parameters)."""
|
|
assert set(_EMPTY_PARAMETERS.keys()) == {
|
|
"opening_statement",
|
|
"suggested_questions",
|
|
"user_input_form",
|
|
"file_upload",
|
|
"system_parameters",
|
|
}
|
|
assert _EMPTY_PARAMETERS["suggested_questions"] == []
|
|
assert _EMPTY_PARAMETERS["user_input_form"] == []
|
|
assert _EMPTY_PARAMETERS["opening_statement"] is None
|
|
assert _EMPTY_PARAMETERS["file_upload"] is None
|
|
assert _EMPTY_PARAMETERS["system_parameters"] == {}
|