Skip to content

Mock overview

Mock responses let both clients work with realistic issue data before the production API is complete. The API namespace prefixes supported routes with /mock; Mock issues defines the initial read endpoints and examples.

  • Mock and corresponding API reads share the proposed fuller issue response. The existing minimum production milestone remains unchanged.
  • Use fixed data and stable string identifiers. Repeated requests return identical data in a fixed list order.
  • Represent timestamps as UTC strings ending in Z. Include nullable fields explicitly and use empty arrays for absent collections.
  • Keep status and interval relationships within the issue’s workspace. Comments and attachments reference the containing issue.
  • Closed issues have a nonblank resolution. Reported issues may have null resolution, assignee, and interval.
  • Use fictional display data. Do not include authentication identities, credentials, or role assignments in issue responses.

These pages specify future behavior and required HTTP tests. No mock endpoints or executable endpoint tests are implemented by this documentation update. Writes and other mock resources remain deferred.