Notification API Documentation

Summary

Complete Draft API documentation for the source-backed Notification HTTP surfaces: 17 native Minimal API operations exposed by the extracted notification-service, 10 legacy compatibility operations on the monolith controllers, and the gateway routes that connect them.

Audience

API consumers, engineers, architects, QA, support, security reviewers, implementation partners and product owners.

Overview

The Notification HTTP surface is split across two implementations that coexist behind a gateway toggle.

The native surface belongs to notification-service, a .NET 8 Minimal API. It maps three route groups — an in-app inbox, template management, and administration plus test hooks — alongside two shared operational endpoints contributed by the shared kernel and health-check middleware. All native endpoints are anonymous in the reviewed source.

The compatibility surface belongs to the monolith NotificationsController and NotificationTemplatesController under /api/notifications and /api/notification-templates. Both controllers declare [Authorize] and resolve the caller from the authenticated principal. This is the surface the client portal calls today.

The two surfaces are not contract-compatible: they use different identifier types, different template models and different response shapes. The module is therefore classified Transitional.

Documentation map

Start with the API overview and the authoritative endpoint catalog. Per-family detail is in notification endpoints, template endpoints, administration endpoints, testing endpoints, health endpoints and service information.

Cross-cutting references cover gateway and compatibility, the DTO catalog, authentication, authorization, tenant context, validation, request lifecycle, response models, error handling, versioning, API testing, API limitations and the source map.

Classification

Implemented native surface; compatibility surface is Transitional; API versioning is Not implemented.

Requires confirmation

Which routes are approved for direct external consumption, whether the gateway enforces authentication for notification routes, and which of the two implementations is the canonical contract require confirmation.

Related Articles

• Notification API overview
• Notification endpoint catalog
• Notification technical documentation

See Also

• Notification business documentation
• API source map

Keywords

• Notification API
• Endpoint catalog
• Draft API documentation

Source References

• microservices/src/notification-service/Api/NotificationEndpoints.cs
• microservices/src/notification-service/Program.cs
• microservices/src/gateway-api/Program.cs
• Controllers/NotificationsController.cs
• Controllers/NotificationTemplatesController.cs

Revision Information

• Status: Draft
• Last reviewed: 2026-07-21
• Review cycle: Quarterly