API quality · v1.0.0

API Contract Verifier

Analyze API documentation and perform safe real-request verification of documented contracts.

Public artifact available
The downloadable bundle is tied to the source revision and checksum shown on this page.

The outcome

Compare documented behavior with observed responses without turning verification into load or penetration testing.

Use it when

  • Use when API documentation in Markdown, Office, text, or OpenAPI form must be verified.
  • Use when safe GET or HEAD checks are needed to confirm reachability, fields, types, and examples.

It does not do

  • Does not replace the user’s final authorization for project scope, account access, external changes, or business consequences.
  • Does not represent repository static checks as runtime certification across every platform, provider account, or production environment.

Inputs

  • API documentation and target environment
  • Approved authentication material and test boundaries, if needed

Outputs

  • Contract extraction and verification report
  • Evidence, discrepancies, and bounded recommendations

Natural-language triggers

Use $api-contract-verifier to compare an OpenAPI document with safe responses from the staging service.

Permission map

FilesWrite

May read supplied documents and write sanitized verification records.

CommandsExecute

May run safe HTTP and document-inspection commands.

NetworkExecute

Sends bounded requests only to user-authorized API endpoints.

AccountsRead

May use an existing authorized credential channel without copying its secret.

BrowserRead

May inspect API documentation in a browser without changing account state.

External changesNone

Defaults to safe read-only requests and does not perform business mutations.

Environment & requirements

Agents

  • Codex
  • Claude Code

Platforms

  • macOS
  • Linux
  • Windows

Required tools

  • HTTP client
  • authorized API documentation

Data handling

Processes authorized API documents, test requests, and sanitized responses; tokens, cookies, personal data, and full production responses are not persisted by default.

Credential handling

Uses only existing secure credential channels authorized by the user; tokens, keys, cookies, private keys, and real user data must not be copied into the Skill, logs, reports, or public artifacts.

Verification evidence

Version 1.0.0 completed document extraction, OpenAPI normalization, real loopback HTTP requests, discrepancy classification, and credential-leak checks in an isolated macOS environment; verification excludes third-party production services and real customer data.

Level
Verified
Checked
2026-10-12
Expires
2027-01-10
Source revision
fac86e9d2646

Environment

  • macOS 26.2
  • Python 3.9.6
  • Local isolated HTTP fixture on 127.0.0.1

Targets checked

  • Markdown, HTML, PDF, and OpenAPI JSON extraction
  • OpenAPI normalization and normalized-contract validation
  • GET and HEAD requests with no retry or redirect
  • PASS, WARNING, ERROR, and BLOCKED comparison outcomes
  • Credential redaction from retained evidence

Evidence IDs

  • api-contract-verifier-self-test
  • api-contract-verifier-unit-tests
  • api-contract-verifier-document-extraction
  • api-contract-verifier-loopback-probe
  • api-contract-verifier-secret-redaction

Limits & support

Known limitations

  • Verification applies only to the exact artifact, source revision, environment, and test scope recorded; it does not certify every provider account, region, or future version.
  • Agents, platforms, and provider interfaces continue to change; each run must inspect current state and respect explicit confirmation gates.
  • Live network verification used an isolated local fixture and did not call a third-party production API.
  • The script execution chain was verified; natural-language routing is not certified for every Agent version.
  • Scanned-PDF OCR, legacy DOC/PPT, and authenticated remote APIs still require project-specific verification.

Permission changes

  • No permission change is declared for this release; for a first public release, the permission map on this page is authoritative.

Channel
Submit through support@xiaoyuelabs.com or the on-site inquiry form.

Response target
Receipt is acknowledged within two business days; remediation timing is confirmed after reproduction and scope review.

Scope
Free support covers download integrity, documentation errors, and reproducible Skill defects; project adaptation, managed operation, and ongoing maintenance are separate services.

Release notes

v1.0.0
  • Imported the canonical package from YW1975/margay-team-share at commit 2ab685569c74c7f65208607582e78274972ff1f2.
  • Added bilingual catalog documentation, usage examples, source provenance, and independent semantic version history.

Install & verify

Release access

Download the verified release

v1.0.0

The private artifact is delivered through the gated download API. Verify the checksum before extraction and inspect the enclosed license and SKILL.md before installation.

File
api-contract-verifier-1.0.0.zip
Size
44.5 KB
SHA-256
7dfd8ce7ab72126f6c9ed493eb8726d6b89c8260aea631d5bf695f9f070589cc