Live productapi.acme.com · observed on v2.8.0
shipped Sep 04, 2026
shipped Sep 04, 2026
POST /v1/subscriptionsprice_idstringrequiredrenamed from plan_id
trial_periodintegeroptionalrenamed from trial_days
seatsintegerrequiredadded, no default
Know when your documentation stops matching your product.
LiveParity compares your published docs against your live API and flags what has drifted — before your users find it.
Read-only. Connect a docs source and an API spec in under five minutes.
In parity
Published documentationdocs/billing/subscriptions.md
last edited May 12, 2026
last edited May 12, 2026
curl -X POST https://api.acme.com/v1/subscriptions \\n -H "Authorization: Bearer $KEY" \\n -d plan_id=pro_monthly \\n -d trial_days=14
Published documentationdocs/billing/subscriptions.md
last edited May 12, 2026
last edited May 12, 2026
curl -X POST https://api.acme.com/v1/subscriptions \\n -H "Authorization: Bearer $KEY" \\n -d plan_id=pro_monthly \\n -d trial_days=14
Docs don't break loudly. They go quiet and stay wrong.
May 14v2.6.0 shipsProduct release
May 14docs unchangedNo matching documentation update
May 28six billing ticketsUsers surface the mismatch
Jul 02integration guide still wrongDrift remains unresolved
How it works
01
Connect
Point LiveParity at your docs and your OpenAPI spec, repo, or live endpoints.
Connection established09:08:11
Docssourcegithub.com/acme/docsbranchmainpathdocs/**scopecontents:read
APIspecapi.acme.com/openapi.jsonversionv2.8.0moderead-only
02
Compare
Every deploy triggers a structural comparison: endpoints, fields, auth, error codes, rate limits.
POST /v1/subscriptions- plan_id string required+ price_id string required- trial_days integer optional+ trial_period integer optional+ seats integer required
3 structural differences · compared 09:13:42
03
Flag
Differences land in Slack or a pull request, scoped to the page that owns them.
#docs-drift09:14
LiveParityDrift detected · Billing
docs/billing/subscriptions.md
3 differences after v2.8.0
plan_id → price_id
trial_days → trial_period
seats added · required
What LiveParity compares
Endpoints & methodsAdded, removed, renamed, or remapped HTTP operations.
Request fieldsRequired status, names, types, defaults, and newly introduced fields.
Response shapesObject structure, returned fields, types, and response contracts.
Auth flowsHeaders, token schemes, OAuth scopes, and authentication requirements.
Error codesDocumented status codes and the response bodies returned with them.
Rate limitsPublished quotas against observed limit headers and endpoint rules.
SDK snippetsCalls and parameter names that no longer match the current API contract.
UI copy & labelsProcedural text that references labels or controls no longer present.
Audit report
Documentation Audit Report
Authentication3 differences
Authentication header changed
GET /v1/account - X-API-Key: $KEY+ Authorization: Bearer $KEYRequired OAuth scope changed
POST /v1/subscriptions - account:write+ billing:write401 response shape changed
- { "error": "unauthorized" }+ { "code": "invalid_token", "message": "The access token is invalid or expired." }Billing3 differences
plan_id → price_id
trial_days → trial_period
seats added, required, no default
API ReferenceIn parity
No structural differences found in the validated reference.
WebhooksIn parity
No structural differences found in the validated reference.
Rate Limits1 difference
120 requests/min → 60 requests/min
Documentation Health
A live view of which documented workflows still match the product you shipped.
Document status and finding count are separate: one drifting document can contain several differences.
24Total docs
22In parity
1Needs review
1Drift detected
Docs in parity (%)92% in parity
docs/billing/subscriptions.md1 drift detected
92% in parity1 drift detectedData handling
The pilot is deliberately narrow: enough access to verify drift, no broader permissions than the audit requires.
What is processedOnly the documentation, API contracts, and endpoint responses needed to run the selected audit.
AccessRead-only only. LiveParity does not request write scopes for source repositories or APIs during the pilot.
RetentionThe validation pilot avoids persistent ingestion. Temporary working copies used for an audit are deleted after report delivery.
HostingContinuous monitoring infrastructure is not live yet. Hosting region and subprocessors will be published before persistent monitoring is offered.
Questions before an audit
How do you handle false positives?
Every pilot finding includes the source evidence behind it. Ambiguous cases stay Needs review rather than being presented as confirmed drift.
What if our docs are handwritten and not generated from a spec?
That is supported when a documented workflow can be mapped to an API contract or observed behavior. Prose that cannot be verified structurally is separated for manual review.
Does this work with private APIs?
For the validation pilot, only when you can provide a read-only spec, test environment, or scoped endpoint access. We do not ask for production write access.
What happens on a breaking change we made on purpose?
An intentional product change can still leave documentation out of parity. The audit shows the difference; once the owning page is updated, the workflow can be re-checked.
Pricing
Run a free audit
Start with a small evidence check. Move to a paid pilot only when the first findings justify a deeper audit.
| Free audit | Pilot audit | Monitoring | |
|---|---|---|---|
| Price | €0private validation | €250one-time | Contactdesign partner only |
| Scope | 2–3 public workflows | 10–15 selected workflows | Defined after a successful pilot |
| Access | Public docs and public API contract | Read-only scoped sources if required | Persistent access only after explicit agreement |
| Deliverable | Short evidence summary | Prioritized Documentation Audit Report | Re-check cadence and drift notifications |
Free audit€0
private validationScope2–3 public workflows
AccessPublic docs and public API contract
DeliverableShort evidence summary
Pilot audit€250
one-timeScope10–15 selected workflows
AccessRead-only scoped sources if required
DeliverablePrioritized Documentation Audit Report
MonitoringContact
design partner onlyScopeDefined after a successful pilot
AccessPersistent access only after explicit agreement
DeliverableRe-check cadence and drift notifications
Private validation intake is handled manually before any persistent connection is enabled.