w-api-docs
Refresh API Docs from Source Schemas
API documentation can drift from the schemas and routes that define actual behavior. This skill guides updates from the owning source and keeps generated artifacts out of manual edits.
التثبيت باستخدام Agent لدي
انسخ هذا الطلب إلى Agent لديك. يتضمن صفحة Skill المعتمدة وملف manifest.
Review the Skillstore skill "w-api-docs" from https://skillstore.io/skills/blockmatic-w-api-docs.md and its manifest at https://skillstore.io/api/skills/blockmatic-w-api-docs/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.يجب أن يواصل Agent عرض خطته وطلب أي تأكيد تفرضه سياسة الأمان.
موارد مهيّأة لـ Agents
استخدم هذه الروابط عندما يحتاج AI Agent أو crawler أو script إلى سياق نظيف بدلًا من قراءة الصفحة كاملة.
اختبرها
جارٍ استخدام "w-api-docs". An endpoint response changed and the generated API reference is outdated.
النتيجة المتوقعة:
The response schema or route is the likely source of truth. Update that source, run the repository generator, check for drift, and revise adopter documentation only when behavior changed.
جارٍ استخدام "w-api-docs". A contributor proposes editing the generated OpenAPI file directly.
النتيجة المتوقعة:
Redirect the change to the owning schema or route. Regenerate the OpenAPI artifact using the documented workflow, then review the generated diff.
التدقيق الأمني
آمنThe only static finding is a false positive. The referenced text is a Markdown command reference, not Ruby or shell execution, and no prompt injection or data-exfiltration intent is evident.
عوامل الخطر
⚙️ الأوامر الخارجية (1)
شارك واستشهد بهذا التقرير
شارك تقرير التقييم المرتبط بالإصدار والشارة المحايدة وبطاقة التضمين والاستشهادات. تعرض Skillstore الأدلة من دون أن تقرر ما إذا كانت هذه المهارة آمنة.
نسخ رابط التقرير
https://skillstore.io/skills/blockmatic-w-api-docs/audits/1?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportشارة Markdown
[](https://skillstore.io/skills/blockmatic-w-api-docs?utm_source=security_passport_badge)شارة HTML
<a href="https://skillstore.io/skills/blockmatic-w-api-docs?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/blockmatic-w-api-docs/security.svg" alt="Skillstore security assessment" loading="lazy"></a>بطاقة قابلة للتضمين
<iframe src="https://skillstore.io/embed/skills/blockmatic-w-api-docs.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>الاستشهادات الأكاديمية (APA · BibTeX · CFF)
اقتباس APA
blockmatic. (2026). w-api-docs security audit report (audit version 1) [Author version unspecified]. Skillstore. https://skillstore.io/skills/blockmatic-w-api-docs/audits/1اقتباس BibTeX
@techreport{blockmatic-blockmatic-w-api-docs-2026,
author = {blockmatic},
title = {w-api-docs security audit report (audit version 1)},
institution = {Skillstore},
year = {2026},
number = {1},
url = {https://skillstore.io/skills/blockmatic-w-api-docs/audits/1},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "w-api-docs security audit report (audit version 1)"
version: "unspecified"
type: report
authors:
- name: "blockmatic"
date-released: "2026-09-20"
url: "https://skillstore.io/skills/blockmatic-w-api-docs/audits/1"
identifiers:
- type: other
value: "skillstore:blockmatic-w-api-docs:audit:1"
description: "Skillstore immutable audit report identifier"
تقييم Skillstore
سبب هذا التقييم موثوقية الأدلة: متوسطما الذي يمكنك بناؤه
Maintain OpenAPI References
Use the workflow to trace an endpoint change to its owning schema, regenerate the documentation, and check for drift.
Review Documentation Changes
Use the workflow to confirm that API docs describe implemented behavior without hand-editing generated files.
Coordinate Schema Updates
Use the workflow to plan source changes, generated documentation updates, and adopter MDX changes in one review.
جرّب هذه الموجّهات
Trace this API documentation change to its owning schema, route, or documented generator. List the files and the evidence for each relationship.
Review the requested API behavior change and produce a concise update plan. Separate source changes, generation steps, drift checks, and adopter documentation.
Inspect the repository workflow for generating API documentation. Identify the documented command, expected outputs, and available drift checks, then report any missing evidence.
Analyze this API change across schemas, routes, generated documentation, and adopter MDX. Recommend only source-owned edits and flag undocumented policy assumptions.
أفضل الممارسات
- Trace every documentation change to an owning schema, route, or documented generator.
- Run the repository generation and drift checks after changing API behavior.
- Document only verified behavior and clearly separate evidence from assumptions.
تجنب
- Do not hand-edit generated OpenAPI files or generated clients.
- Do not invent authentication, rate-limit, or versioning policy.
- Do not update adopter documentation when the API behavior has not changed.
الأسئلة المتكررة
What problem does this skill solve?
Should I edit generated OpenAPI files directly?
What sources can own an API change?
Does this skill run the generator?
Does it define authentication or rate limits?
When should adopter MDX change?
تفاصيل المطور
المؤلف
blockmaticالترخيص
MIT
مراجعة Skillstore
r1
تنبيه الإصدار
لم يعلن المؤلف عن إصدار.
مرجع
da80e8e31e67c66709203bc863d62c9424451362
حداثة الصيانة
٢٠/٩/٢٠٢٦
الاستخدام
0 تنزيلات · 0 مشاهدات
بنية الملفات
📄 SKILL.md