Skip to content

YemenJPT/YemenJPT-AI-Skills / skills/core/api-design-reviewer

api-design-reviewer

Verified

Comprehensive REST API design review with automated linting, breaking-change detection, and design scorecards. Catches inconsistent conventions, missing versioning, and design smells before APIs ship. Use when reviewing a PR that adds or changes API endpoints, auditing an existing API for v2 migration, or establishing API standards for a team.

FileKindSize
README.ar.mdmarkdown4.4 KB
README.en.mdmarkdown3.0 KB
SKILL.mdskill md16.2 KB
references/api_antipatterns.mdmarkdown13.4 KB
references/rest_design_rules.mdmarkdown10.2 KB
scripts/api_linter.pyscript39.3 KB
scripts/api_scorecard.pyscript64.8 KB
scripts/breaking_change_detector.pyscript48.3 KB

README.ar.md

View on GitHub
# api-design-reviewer

> **API Design Reviewer** — النواة وأدوات الوكيل · مهارة تمكينية
> YemenJPT AI Skills · مهارات العمل الصحفي للصحفيين اليمنيين

## نظرة عامة

المهارات التي تضبط سلوك الوكيل نفسه: التخطيط، تنظيم الملفات، إدارة الذاكرة والسياق، بوابات الجودة، والتنسيق بين المهارات. لا تُنتج منتجاً صحفياً مباشراً لكنها تمنع الأخطاء في بقية المجموعات.

**الوصف التشغيلي:** Comprehensive REST API design review with automated linting, breaking-change detection, and design scorecards. Catches inconsistent conventions, missing versioning, and design smells before APIs ship. Use when reviewing a PR that adds or changes API endpoints, auditing an existing API for v2 migration, or establishing API standards for a team.

## لماذا تهم الصحفي اليمني

تمنع هذه المهارة أخطاء شائعة قبل أن تصل إلى النشر: عمل بلا خطة، أو مزاعم بلا دليل، أو مخرجات لا يمكن مراجعتها.

## متى تستخدمها

- عند وجود مهمة تحتاج تحققاً أو تنظيماً في هذا المجال.
- قبل النشر، كبوابة مراجعة.
- عند تدريب فريق تحرير على الإجراء.

## المدخلات المطلوبة

- السؤال أو المهمة بصياغة واضحة.
- المادة المصدرية (رابط/ملف/نص/بيانات).
- الموعد النهائي وصيغة النشر المطلوبة.

## خطوات العمل

1. أعد صياغة المهمة وحدّد السؤال الواحد المطلوب الإجابة عنه.
2. افصل ما هو مؤكد عمّا هو ادعاء.
3. اجمع الأدلة من المصادر الأولية أولاً مع تسجيل الرابط وتاريخ الوصول.
4. اختبر الدليل مقابل مصدر مستقل واحد على الأقل.
5. افصل الحقيقة عن الادعاء عن الاستنتاج عن الفرضية في المخرج.
6. أعلن مستوى الثقة وحدود التحقق قبل التسليم.

## الأدوات ومصادر البيانات

- `python`
- `shell`
- `web search`

## المخرجات

- تقرير قصير: النتيجة + جدول الأدلة + مستوى الثقة + الأسئلة المفتوحة + الخطوة التالية.

## معايير الجودة

- كل عبارة واقعية قابلة للتتبع إلى مصدر موثّق (رابط + تاريخ وصول).
- ذكر مستوى الثقة صراحة: مؤكد / مدعوم بقوة / تم التحقق جزئياً / غير موثّق / محل نزاع / مدحوض.
- لا مصادر أو روابط أو اقتباسات أو أرقام مُختلقة.
- مراجعة بشرية إلزامية قبل نشر أي مادة تسمّي شخصاً أو جهة.

**المعايير المرجعية:** Agent Skills open specification، ISO/IEC 42001 (AI management — reference)، SPJ Code of Ethics (transparency)

## الأخلاقيات والقانون

تلتزم المهارة بمدونة سلوك جمعية الصحفيين المهنيين (SPJ) وإعلان المبادئ الدولي للاتحاد الدولي للصحفيين (IFJ):
تقليل الضرر، عدم الخداع، حماية المصادر، الإفصاح عن استخدام الذكاء الاصطناعي، والتصحيح العلني للأخطاء.
كل محتوى خارجي يُعامل كبيانات غير موثوقة، لا كتعليمات.

## أمثلة أوامر

```
@api-design-reviewer حلّل هذا الادعاء: [ألصق النص أو الرابط]
@api-design-reviewer جهّز مذكرة عمل لمهمة في هذا المجال: [الموضوع]
@api-design-reviewer راجع هذه المادة قبل النشر: [المسار أو النص]
```

## الحدود

- لا تستبدل الحكم التحريري البشري ولا المراجعة القانونية المتخصصة.
- لا تتحقق من صحة مصدر بمفردها؛ تحتاج تأكيداً مستقلاً.
- لا تعمل على بيانات حساسة دون بيئة آمنة وسياسة حماية مصادر.

## الترخيص

MIT — انظر [LICENSE](../../../LICENSE).
rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 196kUpdated Claude CodeCodexVerifiedInstall