API change checklist template

For engineers adding or changing an API. The design is reviewed before build, the change stays backward compatible or ships as a new version, every new endpoint gets an auth check, and the API reference is updated.

App: Checklist Flow for Jira
Category: Software delivery
Edition: Needs a paid licence; without one it shows with a Pro badge and a preview
Items: 10 items, 5 required
Suggested for: Story, Task

Items

Design

Item	Required
API design reviewed before implementation	Required
Change is backward compatible, or a new version is introduced	Required
Naming follows the existing API conventions	Optional
Error responses are documented	Optional

Build

Item	Required
Contract or integration tests cover the new behaviour	Required
Authentication and authorisation checked for every new endpoint	Required
Rate limits and payload size limits set	Optional

Communicate

Item	Required
API reference documentation updated	Required
Changelog entry published	Optional
Known consumers told, with a deprecation date for anything removed	Optional

Use it

In a Jira work item, open the Checklist Flow panel, then Template library in the Templates section. Find the template under its category, use Preview to see the items and Install to add it to your site's templates. From then on you can apply it to any work item, or, with a paid licence, have it added automatically by issue type.

Checklist Flow for Jira documentation
Jira checklist templates: all 49 templates