Skip to main content
ApiGlow v0.1.0
EN
FEATURE 04 / 11

An OpenAPI audit, run where the schema already is.

Your documentation already downloaded the schema — so it can tell you what’s wrong with it. Open #/audit and the loaded document is analyzed in place: 38 rules as of v0.1.0, five categories, a letter grade. It addresses the API’s author, not its readers.

demo.apiglow.dev/#/audit · petstore.yaml
The schema audit report: grade A at 92/100, category score bars, and the document's operation, webhook and schema counts. The schema audit report: grade A at 92/100, category score bars, and the document's operation, webhook and schema counts.

REAL SCREENSHOT, SHOWN AT 1:1

38 rules, five categories.

Correctness, documentation completeness, deprecation hygiene, consistency — and “docs readiness”, the category no generic linter has: what will actually degrade in this rendered documentation. A missing operation summary is an abstract style point in a linter; here it is the blank line your readers will see in the nav.
The A grade at 92/100 and the five per-category score bars, from correctness to docs readiness. The A grade at 92/100 and the five per-category score bars, from correctness to docs readiness.
[01]THE FIVE CATEGORIES, AND THE GRADE THEY COMPOSE

A grade you can act on.

Each category gets a score and the document gets a letter grade, A to F. Every finding states its rationale and links straight to the operation or schema it concerns — you read the finding, you click, you are looking at the problem.

A report you can file.

The report exports as Markdown, ready to paste into an issue or a review. And when the finding is in a schema you don’t own, overlays fix it at load time — audit, patch, reload, re-audit.
The report's Copy as Markdown button. The report's Copy as Markdown button.
[03]ONE BUTTON, THE REPORT IN THE CLIPBOARD

In the browser, for the author.

Nothing is computed until someone opens #/audit, and nothing is sent anywhere — the analysis runs on the schema the page already downloaded. Because it targets the author, there is no nav entry; the single entry point sits at the bottom of the settings drawer, out of your readers’ way. Once the schema improves, change highlights show your readers what moved.

Installs that want none of it set one key — the route, the settings block and every computation disappear.

Removing the audit entirely 
{ "features": { "audit": false } }

See it in the live demo.

Open the live demo Read the schema audit guide