modify-api

Update API endpoint contracts, implementations, tests, and documentation.

Updated Jun 1, 2025

Search Tags:#documentation #api #migration #backward-compatibility #modify #contract #tests

Ready to run

npx skills add https://github.com/Yokhan/yokhanFitnessDocsWebsite --skill modify-api

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: modify-api
Source: https://github.com/Yokhan/yokhanFitnessDocsWebsite/tree/main/.claude/skills/modify-api
Command: npx skills add https://github.com/Yokhan/yokhanFitnessDocsWebsite --skill modify-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Safely modify an existing API endpoint by updating the contract, implementation, tests, and documentation.

Core Features & Use Cases

Backward-compatible changes with migration planning and deprecation notes.
Coordinated updates across contract-first and implementation-first changes with tests and docs.
Use case: when an endpoint contract changes, align client code and tests accordingly.

Quick Start

Update the API contract, propagate changes to the implementation and tests, and refresh the documentation.

Frequently Asked Questions about modify-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I safely modify an API endpoint without breaking backward compatibility?▼

To safely modify an API endpoint, enforce contractual updates first, coordinate backward-compatible changes, implement code adjustments, validate with tests, and publish updated documentation.

What is the correct order of operations when updating an API contract and implementation?▼

Updating an API contract requires a specific order: enforce contractual updates first, then implement code adjustments, validate changes with tests, and finally publish updated user-facing documentation.

How do I plan a migration and add deprecation notes when changing an API contract?▼

Plan an API migration by coordinating backward-compatible changes with migration planning and deprecation notes, ensuring client code and tests align with the updated endpoint contract.

How do I align client code and tests after an endpoint contract changes?▼

Align client code and tests after an endpoint contract changes by propagating the contract updates end-to-end, validating the implementation adjustments through tests, and refreshing documentation.

Can I coordinate implementation-first API changes with tests and docs using this approach?▼

Yes, you can coordinate implementation-first API changes by propagating updates across code, tests, and user-facing documentation to ensure the implementation and contract remain aligned.