Skip to main content

Review Cycle API

Summary

List, create, open, and close operations for review cycles.

Audience

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

Overview

The review-cycle family contains four native operations.

Endpoint family

FamilyRouteMethodsContract or purpose
List/performance/cyclesGETOptional textual status filter; ReviewCycleDto array
Create/performance/cyclesPOSTCreateCycleInput; Created ReviewCycleDto
Open/performance/cycles/{id}/openPOSTUpdated ReviewCycleDto
Close/performance/cycles/{id}/closePOSTUpdated ReviewCycleDto
  • CreateCycleInput carries optional name, period boundaries, and notes.
  • Creation validates tenant context, period ordering, and text limits.
  • Missing cycles return Not Found; invalid transitions return Bad Request.
  • An unrecognized list status is ignored rather than rejected.

Classification

Implemented native family; endpoint authorization remains Not implemented.

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

Cycle permissions, phase advancement, pagination, unknown-filter behavior, and close cascade require confirmation.

Diagram

See Also

Keywords

  • Performance API
  • Review Cycles
  • Draft API documentation

Source References

  • microservices/src/performance-service/Api/PerformanceEndpoints.cs
  • microservices/src/performance-service/Application/Dtos.cs
  • microservices/src/performance-service/Application/Commands/ReviewCycleCommands.cs
  • microservices/src/performance-service/Application/Queries/PerformanceQueries.cs

Revision Information

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