[PR #5289] [CLOSED] docs: add comprehensive API reference documentation #5398

Closed
opened 2026-06-05 15:21:13 -04:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/Mintplex-Labs/anything-llm/pull/5289
Author: @Agolid
Created: 3/27/2026
Status: Closed

Base: masterHead: docs/api-reference


📝 Commits (10+)

  • d38907b docs: add API reference documentation
  • ef9f39d docs: add API reference documentation
  • 232ff13 docs: add API reference documentation
  • 00ed914 docs: add API reference documentation
  • ed10c84 docs: add API reference documentation
  • 7441091 docs: add API reference documentation
  • 782bfe7 docs: add API reference documentation
  • 19ecda4 docs: add API reference documentation
  • 372d544 docs: add API reference documentation
  • c0e6a52 docs: add API reference documentation

📊 Changes

12 files changed (+5931 additions, -0 deletions)

View changed files

server/API_REFERENCE/API.md (+2953 -0)
server/API_REFERENCE/README.md (+45 -0)
server/API_REFERENCE/Schemas.md (+93 -0)
server/API_REFERENCE/admin.md (+600 -0)
server/API_REFERENCE/authentication.md (+45 -0)
server/API_REFERENCE/documents.md (+582 -0)
server/API_REFERENCE/embed.md (+279 -0)
server/API_REFERENCE/openai-compatible-endpoints.md (+184 -0)
server/API_REFERENCE/system-settings.md (+262 -0)
server/API_REFERENCE/user-management.md (+90 -0)
server/API_REFERENCE/workspace-threads.md (+294 -0)
server/API_REFERENCE/workspaces.md (+504 -0)

📄 Description

Summary

Adds auto-generated API reference documentation from the existing OpenAPI spec (server/swagger/openapi.json).

Closes #5288

Changes

  • Added server/API_REFERENCE/ with 12 markdown files
  • 58 API endpoints documented across 9 categories:
    • Authentication
    • Admin
    • Documents
    • Workspaces
    • Workspace Threads
    • System Settings
    • User Management
    • OpenAI Compatible Endpoints
    • Embed
  • Includes README, full API Reference, and Data Schemas

Generated with

api-doc-sync from server/swagger/openapi.json (OpenAPI 3.0)

Note

The documentation is placed in server/API_REFERENCE/ to keep it close to the source spec. If you prefer a different location (e.g. docs/), I am happy to move it.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/Mintplex-Labs/anything-llm/pull/5289 **Author:** [@Agolid](https://github.com/Agolid) **Created:** 3/27/2026 **Status:** ❌ Closed **Base:** `master` ← **Head:** `docs/api-reference` --- ### 📝 Commits (10+) - [`d38907b`](https://github.com/Mintplex-Labs/anything-llm/commit/d38907b33ef8bae300eb113dbd7cf20e5b8b04b0) docs: add API reference documentation - [`ef9f39d`](https://github.com/Mintplex-Labs/anything-llm/commit/ef9f39da7cf22eff119ed2623794c96f09689610) docs: add API reference documentation - [`232ff13`](https://github.com/Mintplex-Labs/anything-llm/commit/232ff13fe960d365de8354bf40047cc5c223a9e7) docs: add API reference documentation - [`00ed914`](https://github.com/Mintplex-Labs/anything-llm/commit/00ed91475c23c3ee81f95a09f84bb36059476851) docs: add API reference documentation - [`ed10c84`](https://github.com/Mintplex-Labs/anything-llm/commit/ed10c841acdd91130d9a2f21f0d1b585b3b4d62c) docs: add API reference documentation - [`7441091`](https://github.com/Mintplex-Labs/anything-llm/commit/7441091087ae6a255c505e548128703878dbdd73) docs: add API reference documentation - [`782bfe7`](https://github.com/Mintplex-Labs/anything-llm/commit/782bfe7a2c8cee43b07d3d31e84e9451cad355a4) docs: add API reference documentation - [`19ecda4`](https://github.com/Mintplex-Labs/anything-llm/commit/19ecda4ac5109fa776fa6e3a3cf9d04c3151b29a) docs: add API reference documentation - [`372d544`](https://github.com/Mintplex-Labs/anything-llm/commit/372d5447e4ff41ecd13a595c6a9cb6e992b0bb0a) docs: add API reference documentation - [`c0e6a52`](https://github.com/Mintplex-Labs/anything-llm/commit/c0e6a52a53a5e8c38bd61c76bdbbcc67c27409b0) docs: add API reference documentation ### 📊 Changes **12 files changed** (+5931 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `server/API_REFERENCE/API.md` (+2953 -0) ➕ `server/API_REFERENCE/README.md` (+45 -0) ➕ `server/API_REFERENCE/Schemas.md` (+93 -0) ➕ `server/API_REFERENCE/admin.md` (+600 -0) ➕ `server/API_REFERENCE/authentication.md` (+45 -0) ➕ `server/API_REFERENCE/documents.md` (+582 -0) ➕ `server/API_REFERENCE/embed.md` (+279 -0) ➕ `server/API_REFERENCE/openai-compatible-endpoints.md` (+184 -0) ➕ `server/API_REFERENCE/system-settings.md` (+262 -0) ➕ `server/API_REFERENCE/user-management.md` (+90 -0) ➕ `server/API_REFERENCE/workspace-threads.md` (+294 -0) ➕ `server/API_REFERENCE/workspaces.md` (+504 -0) </details> ### 📄 Description ## Summary Adds auto-generated API reference documentation from the existing OpenAPI spec (`server/swagger/openapi.json`). Closes #5288 ## Changes - Added `server/API_REFERENCE/` with 12 markdown files - 58 API endpoints documented across 9 categories: - Authentication - Admin - Documents - Workspaces - Workspace Threads - System Settings - User Management - OpenAI Compatible Endpoints - Embed - Includes README, full API Reference, and Data Schemas ## Generated with [api-doc-sync](https://github.com/Agolid/API-Doc-Sync) from `server/swagger/openapi.json` (OpenAPI 3.0) ## Note The documentation is placed in `server/API_REFERENCE/` to keep it close to the source spec. If you prefer a different location (e.g. `docs/`), I am happy to move it. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-06-05 15:21:13 -04:00
yindo closed this issue 2026-06-05 15:21:14 -04:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Mintplex-Labs/anything-llm#5398