refactor: fix OpenAPI contract generation schemas (#37387)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

api/fields/app_fields.py

@@ -18,6 +18,24 @@ class JsonStringField(fields.Raw):
         return value
 
 
+class OpaqueRawField(fields.Raw):
+    @override
+    def schema(self) -> dict[str, object]:
+        return {"type": "object"}
+
+
+class StringListRawField(fields.Raw):
+    @override
+    def schema(self) -> dict[str, object]:
+        return {"type": "array", "items": {"type": "string"}}
+
+
+class ObjectListRawField(fields.Raw):
+    @override
+    def schema(self) -> dict[str, object]:
+        return {"type": "array", "items": {"type": "object"}}
+
+
 app_detail_kernel_fields = {
     "id": fields.String,
     "name": fields.String,
@@ -36,25 +54,25 @@ related_app_list = {
 
 model_config_fields = {
     "opening_statement": fields.String,
-    "suggested_questions": fields.Raw(attribute="suggested_questions_list"),
-    "suggested_questions_after_answer": fields.Raw(attribute="suggested_questions_after_answer_dict"),
-    "speech_to_text": fields.Raw(attribute="speech_to_text_dict"),
-    "text_to_speech": fields.Raw(attribute="text_to_speech_dict"),
-    "retriever_resource": fields.Raw(attribute="retriever_resource_dict"),
-    "annotation_reply": fields.Raw(attribute="annotation_reply_dict"),
-    "more_like_this": fields.Raw(attribute="more_like_this_dict"),
-    "sensitive_word_avoidance": fields.Raw(attribute="sensitive_word_avoidance_dict"),
-    "external_data_tools": fields.Raw(attribute="external_data_tools_list"),
-    "model": fields.Raw(attribute="model_dict"),
-    "user_input_form": fields.Raw(attribute="user_input_form_list"),
+    "suggested_questions": StringListRawField(attribute="suggested_questions_list"),
+    "suggested_questions_after_answer": OpaqueRawField(attribute="suggested_questions_after_answer_dict"),
+    "speech_to_text": OpaqueRawField(attribute="speech_to_text_dict"),
+    "text_to_speech": OpaqueRawField(attribute="text_to_speech_dict"),
+    "retriever_resource": OpaqueRawField(attribute="retriever_resource_dict"),
+    "annotation_reply": OpaqueRawField(attribute="annotation_reply_dict"),
+    "more_like_this": OpaqueRawField(attribute="more_like_this_dict"),
+    "sensitive_word_avoidance": OpaqueRawField(attribute="sensitive_word_avoidance_dict"),
+    "external_data_tools": ObjectListRawField(attribute="external_data_tools_list"),
+    "model": OpaqueRawField(attribute="model_dict"),
+    "user_input_form": ObjectListRawField(attribute="user_input_form_list"),
     "dataset_query_variable": fields.String,
     "pre_prompt": fields.String,
-    "agent_mode": fields.Raw(attribute="agent_mode_dict"),
+    "agent_mode": OpaqueRawField(attribute="agent_mode_dict"),
     "prompt_type": fields.String,
-    "chat_prompt_config": fields.Raw(attribute="chat_prompt_config_dict"),
-    "completion_prompt_config": fields.Raw(attribute="completion_prompt_config_dict"),
-    "dataset_configs": fields.Raw(attribute="dataset_configs_dict"),
-    "file_upload": fields.Raw(attribute="file_upload_dict"),
+    "chat_prompt_config": OpaqueRawField(attribute="chat_prompt_config_dict"),
+    "completion_prompt_config": OpaqueRawField(attribute="completion_prompt_config_dict"),
+    "dataset_configs": OpaqueRawField(attribute="dataset_configs_dict"),
+    "file_upload": OpaqueRawField(attribute="file_upload_dict"),
     "created_by": fields.String,
     "created_at": TimestampField,
     "updated_by": fields.String,
@@ -74,7 +92,7 @@ app_detail_fields = {
     "enable_api": fields.Boolean,
     "model_config": fields.Nested(model_config_fields, attribute="app_model_config", allow_null=True),
     "workflow": fields.Nested(workflow_partial_fields, allow_null=True),
-    "tracing": fields.Raw,
+    "tracing": OpaqueRawField,
     "use_icon_as_answer_icon": fields.Boolean,
     "created_by": fields.String,
     "created_at": TimestampField,
@@ -89,7 +107,7 @@ prompt_config_fields = {
 }
 
 model_config_partial_fields = {
-    "model": fields.Raw(attribute="model_dict"),
+    "model": OpaqueRawField(attribute="model_dict"),
     "pre_prompt": fields.String,
     "created_by": fields.String,
     "created_at": TimestampField,
@@ -100,7 +118,7 @@ model_config_partial_fields = {
 app_partial_fields = {
     "id": fields.String,
     "name": fields.String,
-    "max_active_requests": fields.Raw(),
+    "max_active_requests": OpaqueRawField(),
     "description": fields.String(attribute="desc_or_prompt"),
     "mode": fields.String(attribute="mode_compatible_with_agent"),
     "icon_type": fields.String,
@@ -222,7 +240,7 @@ app_site_fields = {
     "use_icon_as_answer_icon": fields.Boolean,
 }
 
-leaked_dependency_fields = {"type": fields.String, "value": fields.Raw, "current_identifier": fields.String}
+leaked_dependency_fields = {"type": fields.String, "value": OpaqueRawField, "current_identifier": fields.String}
 
 app_import_fields = {
     "id": fields.String,

api/fields/conversation_fields.py

@@ -179,15 +179,18 @@ class StatusCount(ResponseModel):
 
 class ModelConfig(ResponseModel):
     opening_statement: str | None = None
-    suggested_questions: JSONValue | None = None
-    model: JSONValue | None = None
-    user_input_form: JSONValue | None = None
+    suggested_questions: JSONValue | None = Field(default=None)
+    model: JSONValue | None = Field(default=None)
+    user_input_form: JSONValue | None = Field(default=None)
     pre_prompt: str | None = None
-    agent_mode: JSONValue | None = None
+    agent_mode: JSONValue | None = Field(default=None)
 
 
 class SimpleModelConfig(ResponseModel):
-    model: JSONValue | None = Field(default=None, validation_alias="model_dict")
+    model: JSONValue | None = Field(
+        default=None,
+        validation_alias="model_dict",
+    )
     pre_prompt: str | None = None
 
 

api/fields/message_fields.py

@@ -71,7 +71,10 @@ class MessageListItem(ResponseModel):
 
 
 class WebMessageListItem(MessageListItem):
-    metadata: JSONValueType | None = Field(default=None, validation_alias="message_metadata_dict")
+    metadata: JSONValueType | None = Field(
+        default=None,
+        validation_alias="message_metadata_dict",
+    )
 
 
 class MessageInfiniteScrollPagination(ResponseModel):

api/fields/snippet_fields.py

@@ -1,8 +1,17 @@
+from typing import override
+
 from flask_restx import fields
 
 from fields.member_fields import simple_account_fields
 from libs.helper import TimestampField
 
+
+class OpaqueRawField(fields.Raw):
+    @override
+    def schema(self) -> dict[str, object]:
+        return {"type": "object"}
+
+
 tag_fields = {"id": fields.String, "name": fields.String, "type": fields.String}
 
 # Snippet list item fields (lightweight for list display)
@@ -14,7 +23,7 @@ snippet_list_fields = {
     "version": fields.Integer,
     "use_count": fields.Integer,
     "is_published": fields.Boolean,
-    "icon_info": fields.Raw,
+    "icon_info": OpaqueRawField,
     "tags": fields.List(fields.Nested(tag_fields)),
     "created_by": fields.String,
     "author_name": fields.String,
@@ -32,9 +41,9 @@ snippet_fields = {
     "version": fields.Integer,
     "use_count": fields.Integer,
     "is_published": fields.Boolean,
-    "icon_info": fields.Raw,
-    "graph": fields.Raw(attribute="graph_dict"),
-    "input_fields": fields.Raw(attribute="input_fields_list"),
+    "icon_info": OpaqueRawField,
+    "graph": OpaqueRawField(attribute="graph_dict"),
+    "input_fields": OpaqueRawField(attribute="input_fields_list"),
     "tags": fields.List(fields.Nested(tag_fields)),
     "created_by": fields.Nested(simple_account_fields, attribute="created_by_account", allow_null=True),
     "created_at": TimestampField,

api/fields/workflow_fields.py

@@ -12,7 +12,33 @@ from ._value_type_serializer import serialize_value_type
 ENVIRONMENT_VARIABLE_SUPPORTED_TYPES = (SegmentType.STRING, SegmentType.NUMBER, SegmentType.SECRET)
 
 
+class OpaqueRawField(fields.Raw):
+    @override
+    def schema(self) -> dict[str, object]:
+        return {"type": "object"}
+
+
+class JsonValueRawField(fields.Raw):
+    @override
+    def schema(self) -> dict[str, object]:
+        return {
+            "anyOf": [
+                {"type": "string"},
+                {"type": "integer"},
+                {"type": "number"},
+                {"type": "boolean"},
+                {"type": "object", "additionalProperties": True},
+                {"type": "array", "items": {}},
+                {"type": "null"},
+            ]
+        }
+
+
 class EnvironmentVariableField(fields.Raw):
+    @override
+    def schema(self) -> dict[str, object]:
+        return {"type": "object"}
+
     @override
     def format(self, value):
         # Mask secret variables values in environment_variables
@@ -48,7 +74,7 @@ conversation_variable_fields = {
     "id": fields.String,
     "name": fields.String,
     "value_type": fields.String(attribute=serialize_value_type),
-    "value": fields.Raw,
+    "value": JsonValueRawField,
     "description": fields.String,
 }
 
@@ -60,7 +86,7 @@ pipeline_variable_fields = {
     "max_length": fields.Integer,
     "required": fields.Boolean,
     "unit": fields.String,
-    "default_value": fields.Raw,
+    "default_value": JsonValueRawField,
     "options": fields.List(fields.String),
     "placeholder": fields.String,
     "tooltips": fields.String,
@@ -71,8 +97,8 @@ pipeline_variable_fields = {
 
 workflow_fields = {
     "id": fields.String,
-    "graph": fields.Raw(attribute="graph_dict"),
-    "features": fields.Raw(attribute="features_dict"),
+    "graph": OpaqueRawField(attribute="graph_dict"),
+    "features": OpaqueRawField(attribute="features_dict"),
     "hash": fields.String(attribute="unique_hash"),
     "version": fields.String,
     "marked_name": fields.String,