mirror of
https://github.com/langgenius/dify.git
synced 2026-05-20 08:46:57 +08:00
069fdd4894
Adds AppListRow, AppInfoResponse, AppDescribeInfo, AppDescribeResponse per spec docs/specs/v1.0/server/endpoints.md (every response a typed Pydantic model). Adopts PEP 695 generic syntax for PaginationEnvelope (drops legacy TypeVar + UP046 noqa). Centralizes the per-endpoint limit cap as MAX_PAGE_LIMIT = 200.
67 lines
1.6 KiB
Python
67 lines
1.6 KiB
Python
"""Shared response substructures for openapi endpoints."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import Any
|
|
|
|
from pydantic import BaseModel
|
|
|
|
# Server-side cap on `limit` query param for any /openapi/v1/* list endpoint.
|
|
# Sibling endpoints (`/apps`, `/account/sessions`, future routes) all clamp to
|
|
# this; do not introduce per-endpoint caps without raising the constant.
|
|
MAX_PAGE_LIMIT = 200
|
|
|
|
|
|
class UsageInfo(BaseModel):
|
|
prompt_tokens: int = 0
|
|
completion_tokens: int = 0
|
|
total_tokens: int = 0
|
|
|
|
|
|
class MessageMetadata(BaseModel):
|
|
usage: UsageInfo | None = None
|
|
retriever_resources: list[dict[str, Any]] = []
|
|
|
|
|
|
class PaginationEnvelope[T](BaseModel):
|
|
"""Canonical pagination envelope for `/openapi/v1/*` list endpoints."""
|
|
|
|
page: int
|
|
limit: int
|
|
total: int
|
|
has_more: bool
|
|
data: list[T]
|
|
|
|
@classmethod
|
|
def build(cls, *, page: int, limit: int, total: int, items: list[T]) -> PaginationEnvelope[T]:
|
|
return cls(page=page, limit=limit, total=total, has_more=page * limit < total, data=items)
|
|
|
|
|
|
class AppListRow(BaseModel):
|
|
id: str
|
|
name: str
|
|
description: str | None = None
|
|
mode: str
|
|
tags: list[dict[str, str]] = []
|
|
updated_at: str | None = None
|
|
created_by_name: str | None = None
|
|
|
|
|
|
class AppInfoResponse(BaseModel):
|
|
id: str
|
|
name: str
|
|
description: str | None = None
|
|
mode: str
|
|
author: str | None = None
|
|
tags: list[dict[str, str]] = []
|
|
|
|
|
|
class AppDescribeInfo(AppInfoResponse):
|
|
updated_at: str | None = None
|
|
service_api_enabled: bool
|
|
|
|
|
|
class AppDescribeResponse(BaseModel):
|
|
info: AppDescribeInfo
|
|
parameters: dict[str, Any]
|