issuetracker / API / API Documentation
DocsGeneric Issue TrackerAPIAPI Documentation

API Documentation

This directory documents the repository's externally visible application interfaces.

1 min readApplies to v0.6.0
On this page ▾
  1. API documentation checklist
  2. API design principle

Use the project source and generated API documentation as the authoritative contract for exact request/response schemas.

API documentation checklist

  • Authentication and authorization
  • Projects
  • Issues
  • Issue status and priority
  • Comments
  • Attachments
  • Users and memberships
  • Search/filtering
  • Pagination
  • Error responses
  • Health/readiness endpoints

API design principle

Keep transport concerns in API/view/controller modules and keep domain rules in application/service modules where the project already provides that separation.