Performance API Documentation
Summary
Complete Draft API documentation for the source-backed Performance native, reporting, diagnostic, Workflow, and compatibility HTTP surfaces.
Audience
API consumers, engineers, architects, QA, support, security reviewers, implementation partners, and product owners.
Overview
Performance uses ASP.NET Core 8 minimal APIs rather than Controllers. Source maps 23 native operations and four compatibility operations. The API is Transitional because Gateway cutover and legacy-shaped routes coexist with native routes, and authentication is registered without endpoint authorization requirements.
This section records route families, methods, source DTO names, response shapes, validation, error mapping, testing evidence, and limitations without publishing sensitive appraisal examples or environment-specific values.
Documentation map
- API overview
- Endpoint inventory
- Authentication and context
- Response and error model
- Review cycles
- Appraisals
- Workflow callbacks
- Reports
- Compatibility and routing
- API testing guide
Requires confirmation
Endpoint authorization, permissions, ownership rules, callback authentication, diagnostic exposure, response redaction, API versioning, Gateway cutover, compatibility retirement, and contract ownership require confirmation.
Source References
microservices/src/performance-service/Program.csmicroservices/src/performance-service/Api/PerformanceEndpoints.csmicroservices/src/performance-service/Api/PerformanceCompatEndpoints.csmicroservices/src/performance-service/Api/EndpointResults.csmicroservices/src/performance-service/Application/Dtos.csmicroservices/src/performance-service/Application/Compatibility/PerformanceCompatContracts.csmicroservices/src/gateway-api/Program.csmicroservices/scripts/smoke-performance.ps1
Related Articles
See Also
Keywords
- Performance API
- Minimal API
- API documentation
Revision Information
- Status: Draft
- Last reviewed: 2026-07-16
- Review cycle: Quarterly