← SkillSafe
Reference Census

For teams that publish an API reference

Reference CensusAudit your API reference against its own OpenAPI contract, so an integrator never has to guess.

Paste your OpenAPI spec (JSON or YAML) and the operations your published reference shows. Your browser builds the census both ways - live but undocumented, documented but removed - and grades every operation: a description, every parameter with type, required-ness, description and example, at least one 4xx, every error with its cause and fix, request and response examples, a snippet per shipped language. It measures coverage, ranks the remediation tier and writes a Spectral ruleset for the lint gate. The spec never leaves the page. Then the audit report, and the plan that keeps it complete.

Try a sample:

The API, and a short interview free

Your OpenAPI spec, and what the reference lists free

CI and the path to a standing gate free

The census free

What the page flags

Coverage

Since the last saved census

Every operation, both ways

Area by area

A lint gate to start from free

A Spectral ruleset for the completeness gate, every rule at warn as the skill starts it - flip to error once the spec is clean.

.spectral.yaml


    

The audit report

Pricing as soon as the session is ready...

NOT RUN YET

The page's check of this reply

    Saved references

    How it works - and what is sourced

    The rubric follows the skill: every operation needs a description, every parameter its type, required-ness, description and example, every response code including at least one 4xx, every error response its cause and fix (a bare status name such as "Bad Request" does not count), request and response examples, a snippet per shipped SDK language (relabelled curl is not parity) and, on state-changing calls, an idempotency note. The census diffs the spec against the published reference in both directions; path parameters are matched by position, so /charges/{id} and /charges/{charge} meet. Local $ref pointers are resolved; one that does not resolve is a blocker. The YAML reader follows YAML 1.2 and does not support anchors, aliases or tags - paste such specs as JSON.

    The completeness score is this page's own weighted coverage, not a RateMyOpenAPI score. The rankings follow the skill: a lint gate plus contract tests by default, a lint gate only without a safely-callable environment or under a hard deadline, the generated-docs migration for a hand-maintained reference, a scheduled platform change or a docs-platform team; five stages, strictly ordered.