Payroll OpenAPI and Discovery

Summary

Payroll registers endpoint discovery, Swagger generation, and runtime Swagger UI, but no committed OpenAPI artifact or URL versioning is present.

Audience

Frontend and backend developers, QA and support engineers, architects, security reviewers, and implementation partners.

Reference Content

Capability	Confirmed status
Minimal API endpoint discovery	Registered
Runtime Swagger generation	Registered
Runtime Swagger UI	Registered
Environment restriction around Swagger	Not confirmed in Payroll startup
Committed OpenAPI JSON/YAML	Not present
XML documentation generation	Not configured in the Payroll project
URL/header API versioning	Not present
Useful committed HTTP examples	Current .http file is an unmaintained template and not authoritative

Swagger discovery should be limited to approved environments. A future generated reference can be produced from verified runtime metadata, but this epic does not create a speculative specification.

Source References

• microservices/src/payroll-service/Program.cs
• microservices/src/payroll-service/payroll-service.http
• microservices/src/payroll-service/Api/PayrollRunEndpoints.cs
• microservices/src/payroll-service/Api/PayrollOutputEndpoints.cs
• microservices/src/payroll-service/Api/PayrollCompatEndpoints.cs

Related Articles

• Payroll API
• Payroll technical documentation

See Also

• Payroll business documentation
• Payroll module

Keywords

• Payroll API
• Payroll OpenAPI and Discovery

Revision Information

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