Skip to main content

LMS OpenAPI and Discovery

Summary​

Source-backed Draft reference for LMS OpenAPI and Discovery across the implemented Training Service and, where applicable, Gateway surface.

Audience​

API consumers, engineering, QA, support, architecture, security, product, and implementation reviewers.

Reference Content​

Confirmed behavior​

Training registers endpoint discovery and Swagger generation, then enables Swagger middleware and UI without an environment guard in the inspected Program. Minimal API request/response metadata is inferred from delegate signatures and results. The Training route group has one tag; process health has a health tag; the shared service-info route has an operation name.

No explicit operation names on LMS routes, response declarations, security scheme, XML documentation inclusion, API versioning, deprecation metadata, or production exposure control was found. Mixed result branches and anonymous projections may limit generated response-schema fidelity.

Endpoint discovery comes from mapped routes; there is no checked-in HTTP collection. The broad smoke script is an executable test asset, not an OpenAPI contract suite.

Public discovery exposure, security-scheme ownership, stable operation naming, schema review, and production Swagger policy require confirmation.

Source References​

  • microservices/src/training-service/Program.cs
  • microservices/src/training-service/Api/TrainingEndpoints.cs
  • microservices/src/shared-kernel/Extensions/EndpointRouteBuilderExtensions.cs
  • microservices/src/training-service/training-service.csproj

See Also​

Keywords​

  • LMS API
  • Training Service
  • Source-backed contract

Revision Information​

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