All skills
simota avatar

/gateway

@e307415
by shingo imotasimota/agent-skills85 stars
15

Designing and reviewing APIs: OpenAPI spec generation, versioning strategy, breaking change detection, REST/GraphQL best practices. Use for API design or OpenAPI specs.

Use this Skill: https://skilld.dev/gh/simota/agent-skills/gateway

This session only. Nothing lands on disk.

referencebreaking-change-detection.md

≈463 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Breaking Change Detection

Detection Checklist

## API Change Impact Analysis

**Endpoint:** [METHOD /path]
**Change Type:** [Add/Modify/Remove]

### Field Changes
| Field | Before | After | Breaking? |
|-------|--------|-------|-----------|
| [field] | [type] | [type] | [Yes/No] |

### Request Changes
- [ ] Required field added → BREAKING
- [ ] Field type changed → BREAKING
- [ ] Field removed → BREAKING (if clients send it)
- [ ] Validation stricter → BREAKING
- [ ] Optional field added → Safe

### Response Changes
- [ ] Field removed → BREAKING
- [ ] Field type changed → BREAKING
- [ ] Field renamed → BREAKING
- [ ] New field added → Safe
- [ ] Null handling changed → Potentially breaking

### Behavioral Changes
- [ ] Error codes changed → Potentially breaking
- [ ] Pagination changed → BREAKING
- [ ] Rate limits changed → Potentially breaking
- [ ] Authentication changed → BREAKING

### Impact Assessment
**Affected Clients:** [List known consumers]
**Migration Effort:** [Low/Medium/High]
**Recommended Action:** [Version bump / Deprecate / Safe to deploy]

Compatibility Matrix

Before → After         Breaking?   Action Required
─────────────────────────────────────────────────
string → number        YES         New version
number → string        YES         New version
required → optional    NO          Safe
optional → required    YES         New version
field exists → removed YES         New version
null → non-null        YES         New version
non-null → nullable    NO          Safe (usually)
array → object         YES         New version
add enum value         NO*         Safe (lenient clients)
remove enum value      YES         New version

Source: SKILL.md on GitHub

No alerts13d5 checks · Risk SAFE
  • Gen Agent Trust Hub13d

    The skill is a comprehensive API design specialist focusing on OpenAPI, GraphQL, and REST best practices. It provides detailed guidance on versioning, security (OWASP Top 10), and error handling without any malicious code or unsafe operations.

  • Socket13d

    No alerts

  • Snyk13d

    Risk: LOW · No issues

  • Runlayer6mo

    2/14 files flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at e307415. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 2 days ago.

Activeupdated 2 weeks ago

README badge

README badge for simota/agent-skills/gateway