Skip to content

docs: add comprehensive API reference documentation#5289

Closed
Agolid wants to merge 48 commits intoMintplex-Labs:masterfrom
Agolid:docs/api-reference
Closed

docs: add comprehensive API reference documentation#5289
Agolid wants to merge 48 commits intoMintplex-Labs:masterfrom
Agolid:docs/api-reference

Conversation

@Agolid
Copy link
Copy Markdown

@Agolid Agolid commented Mar 28, 2026

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.

Agolid added 30 commits March 28, 2026 11:17
@timothycarambat
Copy link
Copy Markdown
Member

Closing simply because auto-updating this is going to be a super large chore to maintain and being able to just read or use the Swagger docs is exactly what this is for - mainting the MD files is just another chore that will grow stale

@Agolid
Copy link
Copy Markdown
Author

Agolid commented Mar 29, 2026

Closing simply because auto-updating this is going to be a super large chore to maintain and being able to just read or use the Swagger docs is exactly what this is for - mainting the MD files is just another chore that will grow stale

Totally fair point! Keeping a separate set of MD docs in sync with the API is indeed a losing battle — the Swagger UI is the right single source of truth here. Appreciate you taking the time to explain the reasoning rather than just silently closing it. Makes total sense. 🤝

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add comprehensive API reference documentation

2 participants