Skip to main content

Notification Service Information Endpoint

Summary​

Program.cs calls the shared-kernel extension MapHrSuitServiceInfo, which maps GET / and names the endpoint. It is the only Notification endpoint that returns the platform's standard ApiResponse<T> envelope.

Audience​

DevOps engineers, engineers, architects, QA, support and security reviewers.

Reference Content​

The verified reference material for this topic is set out in the sections below.

GET /​

Verified response body: an ApiResponse<ServiceInfoResponse> produced by the Ok factory. The envelope carries a success flag, a message that defaults to the literal success text, the data payload, and the correlation identifier read from the request context. The errors dictionary is null on this path.

Verified ServiceInfoResponse fields: the service name, a description, the resolved environment name, and the current instant.

The name and description passed at the call site identify the service and summarise its role — consuming integration events, resolving tenant-aware templates and delivering across the supported channels with retry, idempotency and audit.

Environment resolution: the environment field is read from the standard ASP.NET Core environment variable and falls back to the production literal when unset. This is the only environment value the API discloses; no host names, connection strings or configuration values are returned.

Declared authentication and authorization: none.

Correlation identifier​

The correlation identifier embedded in the envelope is placed in the request context by the correlation middleware, which runs ahead of endpoint execution. The same value is echoed on the response header for every request, not only this one. See request lifecycle.

API discovery​

Program.cs registers the endpoints API explorer and Swagger generation, and enables both the Swagger document and its UI unconditionally — the calls are not wrapped in a development-environment check.

The generated document reflects the mapped routes and endpoint names. No OpenAPI metadata is declared on the endpoints themselves: no Produces, no ProducesProblem, no WithSummary, no WithDescription and no WithOpenApi call appears in the reviewed source. Response schemas in the generated document are therefore inferred, and the anonymous projections that most handlers return are not described as named schemas.

Verified absence​

There is no versioned discovery document, no service-registry registration performed by this endpoint, and no build or commit identifier in the response.

Classification​

Implemented; unconditional Swagger exposure is recorded as a limitation.

Requires confirmation​

Whether the Swagger UI is intended to be reachable in production requires confirmation.

See Also​

Keywords​

  • Notification API
  • Service Information
  • Draft API documentation

Source References​

  • microservices/src/notification-service/Program.cs
  • microservices/src/shared-kernel/Extensions/EndpointRouteBuilderExtensions.cs
  • microservices/src/contracts/Common/ApiResponse.cs
  • microservices/src/shared-kernel/Middleware/CorrelationIdMiddleware.cs

Revision Information​

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