Skip to main content

LMS API Testing Guide

Summary​

Source-backed Draft reference for LMS API Testing Guide across the implemented Training Service and, where applicable, Gateway surface.

Audience​

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

Reference Content​

Existing evidence​

A broad PowerShell smoke asset exercises Training health/data, course lifecycle, nested course content, materials, paths, enrollment lifecycle, attempts, certificates, sessions, reports, dashboard, import/export, audit/timeline, outbox intent, notification resolution, and selected tenant isolation. An ESS smoke asset covers Gateway degradation behavior. No dedicated Training unit-test project, API integration suite, contract suite, security suite, UI suite, or HTTP collection was found.

Test layerExistingRecommended coverage
SmokeYesPreserve lifecycle, file, reporting, evidence, and tenant checks
Unit/domainNot foundValue records, parsing, lifecycle helpers, aggregate calculations
API integrationNot foundEvery catalog route and confirmed status branch
Contract/OpenAPINot foundDTO/schema stability, files, Gateway envelopes
GatewayESS smoke onlyContext forwarding, timeout/degradation, ownership
Document integrationOptional smoke pathUnavailable/missing/orphan compensation cases
SecurityNot foundAuthentication, authorization, subject ownership, diagnostic exposure
Import/exportSmoke coverageMalformed rows, duplicates, limits, transactional failure
End-to-endBroad smoke approximationNon-production environment across Gateway, Training, Documents, notifications

Tests should use synthetic data in isolated non-production services. Do not place personal records, assessment content, results, certificates, credentials, or environment configuration in fixtures or reports.

Source References​

  • microservices/scripts/smoke-training.ps1
  • microservices/scripts/smoke-ess.ps1
  • microservices/src/training-service/training-service.csproj
  • microservices/src/training-service/Api/TrainingEndpoints.cs

See Also​

Keywords​

  • LMS API
  • Training Service
  • Source-backed contract

Revision Information​

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