DEVELOPMENT WORKFLOW / GitHub community (awesome-copilot)
C# / TypeScript API Contract Drift
Compare C# controller and DTO contracts with TypeScript or JavaScript consumers in both directions.
“Cross-references C# Web API controllers/DTOs against their TypeScript/JavaScript consumers (React, Angular, Vue, Svelte, Node.js, or hand-written/auto-generated HTTP clients like Fetch, Axios, NSwag) to catch contract …”
01 / THE REASONING
Why this made the selection.
- It compares C# controller and DTO changes with TypeScript or JavaScript callers and writes a report instead of a patch.
- A missing static client is reported as not located, not as proof the endpoint is unused.
- The definition separates backend-to-client breakage from stale client-to-backend fields, and labels generated-client, normalized-route and unmatched cases.
- Locate renamed response fields still read by a client
02 / THE REVIEW RECORD
What we actually inspected.
Source review has boundaries.
A clear record is more useful than a “safe” badge.
Material inspected
- skills/api-breaking-change-detector/SKILL.md
- README.md
- LICENSE
Our findings
- The process inventories C# routes and DTOs, then searches fetch, axios, and HttpClient call sites.
- No code is modified; the deliverable is a report.
- A static miss is reported as no consumer located, and the skill says not to assume the endpoint is unused.
- Property names are not paired across C# and TypeScript without a JSON naming attribute or policy.
- The definition separates backend-to-client breakage from stale client-to-backend fields, and labels generated-client, normalized-route and unmatched cases.
- Bidirectional comparison explicitly distinguishes harmless dead request fields from client reads of removed response fields; the output separately lists unmatched endpoints needing manual confirmation.
Not established by this review
- The resource was not executed and its tools were not called.
- No skill execution, authenticated service operation, or outcome benchmark was performed.
- Not executed: it was not installed or run.
The review applies to the material and revision named here. A newer upstream release can change its behavior.
03 / PUT IT TO WORK
Add a skill to your workflow.
DOCUMENTED COMMAND
npx skills add github/awesome-copilot/skills/api-breaking-change-detector Run in your terminal to choose your AI tools, project or global scope, and installation method. This short command follows the current upstream version; the review covers the revision shown above.
Optional: install the reviewed revision
Keeps the original source and installer version where recorded, while leaving your AI tools and installation scope for you to choose.
npx skills add https://github.com/github/awesome-copilot/tree/f25421d3f1b8b3bb217f78a7c0567cf7ec117cd8/skills/api-breaking-change-detector - Install the pinned skill directory interactively, retaining its bundled references and scripts.
- Read controller routes and global JSON naming policy before mapping fields; include explicit JSON-name overrides and ignored properties.
- Compare old/new DTOs and client payloads, distinguish ignored extra request fields from missing response fields, and report the match method and confidence.
Before you start
- C# Web API source plus relevant JavaScript/TypeScript consumers
- Repository search access; no OpenAPI export is required
04 / FOLLOW THE EVIDENCE
The source trail.
Our notes are separate from the original resource.
Check upstream before adopting a new version.
- Pinned skill definition ↗Checked
https://github.com/github/awesome-copilot/blob/f25421d3f1b8b3bb217f78a7c0567cf7ec117cd8/skills/api-breaking-change-detector/SKILL.md
Supports: summary, whySelected, bestFor, limitations, install, access, review
https://github.com/github/awesome-copilot/blob/f25421d3f1b8b3bb217f78a7c0567cf7ec117cd8/README.md
Supports: install
- MIT licence ↗Checked
https://github.com/github/awesome-copilot/blob/f25421d3f1b8b3bb217f78a7c0567cf7ec117cd8/LICENSE
Supports: license
https://raw.githubusercontent.com/github/awesome-copilot/f25421d3f1b8b3bb217f78a7c0567cf7ec117cd8/skills/api-breaking-change-detector/SKILL.md
Supports: review.findings, bestFor, upstreamDescription