Docs update

This commit is contained in:
Wayne
2025-07-28 02:35:28 +03:00
parent a7e6b93c77
commit e68d9a338d
2 changed files with 25 additions and 2 deletions

View File

@@ -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' }
]
},
{

View File

@@ -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.