dify - 💡(How to fix) Fix [Refactor/Chore] Add OpenAPI annotations for simple deterministic API responses [1 pull requests]

Self Checks

• I have read the Contributing Guide and Language Policy.
• This is only for refactors or chores; if you would like to ask a question, please head to Discussions.
• I have searched for existing issues search for existing issues, including closed ones.
• I confirm that I am using English to submit this report, otherwise it will be closed.
• 【中文用户 & Non English User】请使用英语提交，否则会被关闭 ：）
• Please do not modify this template :) and fill in all the required fields.

Description

The generated API contracts in packages/contracts rely on backend OpenAPI annotations to determine whether an operation is safe to migrate to. Many endpoints are currently marked as not ready because they either lack documented 2xx responses or use loose object response types.

These operations receive the warning:

Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.

Some of these endpoints have simple, deterministic response shapes and can be annotated safely without changing runtime behavior.

Scope Focus only on low-risk endpoints with clear response shapes:

• Fixed small objects, such as { "message": "..." } or { "data": ... }
• Existing DTO / ResponseModel types that can be reused directly
• Simple success responses such as { "result": "success" }
• 204 / bodyless success responses

Do not include endpoints with complex, ambiguous, or business-branch-dependent response structures.

Expected Outcome

• Add accurate OpenAPI request/response schemas for simple deterministic endpoints.
• Regenerate packages/contracts/generated/api/*.
• Update the readiness snapshot in packages/contracts/README.md.
• Reduce the number of not-ready generated contract operations.
• Avoid any runtime API behavior changes.

Acceptance Criteria

• Only high-confidence response schemas are annotated.
• pnpm -C packages/contracts gen-api-contract succeeds.
• packages/contracts/README.md reflects the updated readiness numbers.
• No tests are required unless behavior changes are introduced.

Motivation

No response

Additional Context

No response