Skip to content

docs(api): add end-user lookup#684

Open
BeautyyuYanli wants to merge 1 commit intolanggenius:mainfrom
BeautyyuYanli:yanli/service-api-end-user-docs
Open

docs(api): add end-user lookup#684
BeautyyuYanli wants to merge 1 commit intolanggenius:mainfrom
BeautyyuYanli:yanli/service-api-end-user-docs

Conversation

@BeautyyuYanli
Copy link

@BeautyyuYanli BeautyyuYanli commented Feb 11, 2026

Adds Service API end-user lookup endpoint to the OpenAPI specs: GET /end-users/{end_user_id}.

Copilot AI review requested due to automatic review settings February 11, 2026 03:57
@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Feb 11, 2026
@github-actions
Copy link
Contributor

⏸️ Documentation sync is pending approval

This PR requires approval from a maintainer before automatic synchronization can proceed.

Once approved, the documentation will be automatically translated and synchronized.

@dosubot dosubot bot added the documentation Improvements or additions to documentation label Feb 11, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request adds a new end-user lookup endpoint to the OpenAPI specifications for the Dify Service API, enabling retrieval of end-user details by ID. This is useful for resolving end-user IDs returned by other APIs (e.g., the created_by field from File Upload responses). The changes are related to the merged backend implementation in langgenius/dify#32015.

Changes:

  • Added GET /end-users/{end_user_id} endpoint to all four OpenAPI specs (Chat, Chatflow, Workflow, Completion)
  • Added EndUserDetail schema definition with properties including id, tenant_id, app_id, type, external_user_id, name, is_anonymous, session_id, created_at, and updated_at
  • Added EndUserNotFound error response (404) and "End Users" tag to all specs

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
en/api-reference/openapi_workflow.json Added end-user lookup endpoint with $ref-based error responses, EndUserDetail schema, EndUserNotFound response component, and End Users tag
en/api-reference/openapi_completion.json Added end-user lookup endpoint with inline error responses (matching file's existing pattern), EndUserDetail schema, and End Users tag
en/api-reference/openapi_chatflow.json Added end-user lookup endpoint with $ref-based error responses, EndUserDetail schema, EndUserNotFound response component, and End Users tag
en/api-reference/openapi_chat.json Added end-user lookup endpoint with $ref-based error responses, EndUserDetail schema, EndUserNotFound response component, and End Users tag

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant