Home / github / awesome-copilot · skills/api-breaking-change-detector/SKILL.md · GitHub

api-breaking-change-detector skillA

api-breaking-change-detector is agent-read markdown (skill) from github/awesome-copilot: 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 drift in both directions: backend changes that break client applications (renamed/removed JSON keys, new required parameters, status code shifts) and frontend code sending fields the backend no longer reads. Works directly against source code, not exported OpenAPI spec files. Use w.

Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.

What the file says

# API Breaking Change Detector

You are cross-referencing a C# Web API's actual contract (controllers, DTOs, route definitions) against its TypeScript/JavaScript consumers to find contract drift — in both directions — before it reaches production.

## When to use this

Trigger when the user asks to:
- Check whether a DTO/controller change will break frontend or client applications
- Verify the client and backend API contract are still in sync
- Audit a specific endpoint, or the whole API surface, for breaking changes before a release

Do not use this for:
- Generating new API code from an OpenAPI spec (see `openapi-to-application-code`)
- Scaffolding new endpoints with OpenAPI docs (see `aspnet-minimal-api-openapi`)
- Comparing two OpenAPI spec *files* directly — this skill reads source code, not exported specs

## Process

1. **Discover Global JSON & Naming Policies:**
   - Check `Program.cs` or `Startup.cs` for active JSON options (e.g. `JsonNamingPolicy.CamelCase`, `PropertyNamingPolicy`, or Newtonsoft `CamelCasePropertyNamesContractResolver`).
…

Read the whole file at its exact version.

How to install

Latest version
mdr add github/awesome-copilot/api-breaking-change-detector@git:20260922.d672048
Exact content
mdr add github/awesome-copilot/api-breaking-change-detector@sha256:1fcd27dcb533c23b

Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_f6c4jgcwlt7vtxx2.svg)](https://markdownregistry.com/a/art_f6c4jgcwlt7vtxx2)

1 badge views in 30 days

Versions

versioncommittedcommitsizeaudit
git:20260922.d672048 latest2026-09-22 d672048 6,741 BA view

Audit of the latest version

A  17 of 17 checks passed. Deterministic, no model, same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (6741 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

github/awesome-copilot · 39,368 stars · license MIT · pushed 2026-09-25 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_f6c4jgcwlt7vtxx2
GET https://markdownregistry.com/api/v1/resolve?ref=github/awesome-copilot/api-breaking-change-detector
GET https://markdownregistry.com/api/v1/blob/1fcd27dcb533c23baaeef7a70089a8095fa0cc21425457b9a653535034d71a80

Your agent does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

More from github/awesome-copilot

agentic-workflows skill
github/awesome-copilot · .github/skills/agentic-workflows/SKILL.md · Route gh-aw workflow design/create/debug/upgrade requests to the right prompts.
git:20260923.d7e4ad9 · audit A · 39,368 stars
code-review skill
github/awesome-copilot · .github/skills/code-review/SKILL.md · Review pull requests for repository fit, meaningful value, trustworthy provenance, differentiation, and maintainability…
git:20260923.d7e4ad9 · audit A · 39,368 stars
create-canvas-extension skill
github/awesome-copilot · .github/skills/create-canvas-extension/SKILL.md · Create or register a canvas extension in the awesome-copilot repository. Use when asked to scaffold a new canvas…
git:20260824.37dcfd2 · audit A · 39,368 stars
AGENTS.md agents
github/awesome-copilot · AGENTS.md
git:20260908.a93a83b · audit A · 39,368 stars
acquire-codebase-knowledge skill
github/awesome-copilot · skills/acquire-codebase-knowledge/SKILL.md · Use this skill when the user explicitly asks to map, document, or onboard into an existing codebase. Trigger for…
v1.3 · audit B · 39,368 stars
acreadiness-assess skill
github/awesome-copilot · skills/acreadiness-assess/SKILL.md · Run the AgentRC readiness assessment on the current repository and produce a static HTML dashboard at…
git:20260504.ebd2249 · audit A · 39,368 stars
acreadiness-generate-instructions skill
github/awesome-copilot · skills/acreadiness-generate-instructions/SKILL.md · Generate tailored AI agent instruction files via AgentRC instructions command. Produces .github/copilot-instructions.md…
git:20260504.ebd2249 · audit A · 39,368 stars
acreadiness-policy skill
github/awesome-copilot · skills/acreadiness-policy/SKILL.md · Help the user pick, write, or apply an AgentRC policy. Policies customise readiness scoring by disabling irrelevant…
git:20260504.ebd2249 · audit A · 39,368 stars
ad-campaign-analyzer skill
github/awesome-copilot · skills/ad-campaign-analyzer/SKILL.md · Use this skill when the user shares ad campaign performance data and asks what to cut, scale, or test. Trigger for…
v1.0 · audit A · 39,368 stars
add-educational-comments skill
github/awesome-copilot · skills/add-educational-comments/SKILL.md · Add educational comments to the file specified, or prompt asking for file to comment if one is not provided.
git:20260224.caab1f6 · audit A · 39,368 stars
adobe-illustrator-scripting skill
github/awesome-copilot · skills/adobe-illustrator-scripting/SKILL.md · Write, debug, and optimize Adobe Illustrator automation scripts using ExtendScript (JavaScript/JSX). Use when creating…
git:20260528.9bdb742 · audit A · 39,368 stars
agent-architecture skill
github/awesome-copilot · skills/agent-architecture/SKILL.md · Design AI agent architectures through requirements discovery, or audit and diagnose architectural flaws in existing…
git:20260920.9bf465b · audit A · 39,368 stars

Every file in github/awesome-copilot

Browse by kind, by grade A, or by owner.