Skip to main content

OpenAPI and Discovery

Summary​

Swagger and OpenAPI registration, endpoint names, tags, and missing lifecycle features.

Audience​

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

Overview​

Startup registers the endpoint explorer and Swagger generation, then maps Swagger middleware and UI. Named native operations and endpoint tags contribute to generated discovery.

Endpoint family​

  • Native cycle, appraisal, Workflow, report, and diagnostic operations have explicit names.
  • Compatibility operations are tagged but unnamed.
  • Swagger is mapped without an environment guard.
  • XML documentation inclusion and API versioning are not configured.
  • No deprecation metadata or Performance-specific HTTP collection exists.

Classification​

Implemented basic discovery; versioning and richer contract documentation are Foundation.

Authentication and authorization​

Bearer authentication and tenant context are registered. No Performance endpoint in this family declares an authorization requirement unless explicitly stated above.

Requires confirmation​

Production discovery exposure, versioning, XML documentation, security descriptions, and contract ownership require confirmation.

See Also​

Keywords​

  • Performance API
  • OpenAPI and Discovery
  • Draft API documentation

Source References​

  • microservices/src/performance-service/Program.cs
  • microservices/src/performance-service/performance-service.csproj
  • microservices/src/performance-service/Api/PerformanceEndpoints.cs

Revision Information​

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