api-spec-gate-quality

You can evaluate API spec drafts by running them against a quality gate that checks clarity, structure, and template fidelity. This process assesses the spec against a defined rubric to catch template drift and misnamed items.

An API spec quality gate evaluates drafted specifications and workbooks to ensure deliverables meet standards. It checks naming, hierarchy, and readability, outputting a structured JSON report containing status, blocking issues, and findings.

You can check workbooks for readability and hierarchy by submitting them to a postcheck gate. This gate evaluates presentation, indentation, and structure, returning a structured JSON report to confirm if the workbook meets approval standards.

Yes, the API quality gate supports checking Japanese naming conventions where applicable. It evaluates spec content alignment with template requirements and specific naming rules before you export the final API design.

The API spec quality report uses a structured JSON format. This JSON output includes the approval status, blocking issues, a summary, and detailed findings to communicate whether the spec passes the quality gate.