Skip to content

[Docs] API docs: Add OpenAPI/Swagger docs for all service APIs #16

Description

@OneByJorah

API Documentation Checklist

  • Document all service endpoints:
    • SearXNG API (port 8080): , ,
    • Camofox API (port 9377): , , , , ,
    • Qdrant API (port 6333): , , ,
    • Honcho API (port 8081): , , ,
    • Obsidian API (port 8083): Web UI endpoints
  • Create OpenAPI/Swagger specs for each service
  • Generate API reference docs (Redoc/Stoplight)
  • Add API docs to repository (docs/api/)
  • Link API docs from README.md
  • Add API versioning strategy
  • Document authentication/authorization for each API
  • Add example requests/responses for each endpoint
  • Set up automated API doc generation in CI

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions