diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 953f731..163486d 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -30,7 +30,13 @@ export default defineConfig({ text: 'API Reference', items: [ { text: 'Overview', link: '/api/' }, - { text: 'Ingestion API', link: '/api/ingestion' } + { text: 'Authentication', link: '/api/authentication' }, + { text: 'Auth', link: '/api/auth' }, + { text: 'Archived Email', link: '/api/archived-email' }, + { text: 'Dashboard', link: '/api/dashboard' }, + { text: 'Ingestion', link: '/api/ingestion' }, + { text: 'Search', link: '/api/search' }, + { text: 'Storage', link: '/api/storage' } ] }, { diff --git a/docs/api/index.md b/docs/api/index.md index c67872c..bfd8a0f 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1 +1,18 @@ -# API documentation +# API Overview + +Welcome to the Open Archiver API documentation. This section provides detailed information about the available API endpoints. + +All API endpoints are prefixed with `/api/v1`. + +## Authentication + +Before making requests to protected endpoints, you must authenticate with the API. See the [Authentication Guide](./authentication.md) for details on how to obtain and use API tokens. + +## API Services + +- [**Auth Service**](./auth.md): Handles user authentication. +- [**Archived Email Service**](./archived-email.md): Manages archived emails. +- [**Dashboard Service**](./dashboard.md): Provides data for the main dashboard. +- [**Ingestion Service**](./ingestion.md): Manages email ingestion sources. +- [**Search Service**](./search.md): Handles email search functionality. +- [**Storage Service**](./storage.md): Manages file storage and downloads.