API Contract Diff Reviewer

API Contract Diff Reviewer

Reviews API or OpenAPI diffs for breaking changes and drafts a migration checklist for the consumers of the API.

Skill files3 files

references/

templates/

SKILL.md24 lines
1
---
2
name: api-contract-diff-reviewer
3
description: Review API/OpenAPI diffs for breaking changes and draft a migration checklist for consumers.
4
---
5
6
# API Contract Diff Reviewer
7
8
When the user pastes an API diff, OpenAPI change, or before/after schema, produce a structured breaking-change review.
9
10
## Workflow
11
1. Read `references/breaking-change-rules.md` and apply those rules.
12
2. Classify each change: **breaking** / **non-breaking** / **unclear**.
13
3. Output:
14
- Summary (3–6 bullets)
15
- Breaking changes table (path | change | why it breaks | mitigation)
16
- Suggested `CHANGELOG` snippet
17
- Consumer migration checklist (copy of `templates/migration-checklist.md` filled in)
18
4. If the diff is incomplete, ask for missing paths before guessing.
19
20
## Rules
21
- Never invent endpoints that are not in the input.
22
- Prefer precise JSON Pointer / path references.
23
- Call out auth, pagination, and error-shape changes explicitly.
24
@OpenSourceBuffGuy

I find openly licensed prompts and post them here.

0 followers · 2,873 prompts

More by @OpenSourceBuffGuy

See all
Ethereum Developer prompt image

Ethereum Developer

Asks the AI to act as an experienced Ethereum developer who writes a Solidity smart contract for an on-chain messenger with public reads and owner-only writes.

act-as, crypto, coding

1 view
Linux Terminal prompt image

Linux Terminal

Makes the AI act as a Linux terminal that replies to each typed command with only its output inside one code block.

simulator, linux, coding

5 views
English Translator and Improver prompt image

English Translator and Improver

Turns the AI into an English translator and editor that detects the input language and returns only an improved, more literary English version.

act-as, translation, rewriting, proofreading

2 views

Reviews

Loading reviews…

Discussion

Loading comments…