StatusMate - Status Page

Main

Reference

API docs: spec import

The API reference is rendered from an OpenAPI 3.0 or 3.1 document. Every attempt to bring one in is an import: it is validated on a worker, an import is inert until you select it, and a selection is inert until the version is published. Versions and publishing are covered in

API docs: versions and publishing

Upload or paste the document

Open a version, go to

Spec imports

and click

Import spec

. Either

Upload file

Paste document

— JSON or YAML, UTF‑8, up to 5 MiB. The import is accepted at once and validated in the background; the list refreshes itself until the report is in.

Read the validation report

An import ends up Ready or Failed. Open its report to see the title, contract version, the number of operations and schemas, the servers and tags, and the issues found — errors first, then warnings. Things worth knowing:

Possible credential — the document looks like it contains a real API key. Everything in the contract is visible to readers, so check before publishing.
No servers — without a servers block the reference cannot show a base URL and the “Try it” console cannot be offered.
Duplicate operationIds and invalid JSON, YAML or OpenAPI structure are errors: the import fails.
Security schemes are rendered as documentation, not enforced; webhooks and callbacks are rendered but not as first‑class navigation; x- extensions are kept but not shown.

The document as uploaded is shown to editors only — a rejected upload often holds exactly what should not be published.

Select it for the next publish

On a ready import, click

Use for next publish

. Nothing changes for readers yet: the

Publish

tab now names this spec under “what goes out” and shows the structural changes against the live contract — operations added, removed or with a changed signature. That list is not a breaking‑change report: whether a caller breaks depends on how the API is used. Publish the version to put the new contract live.

Poll a remote source

Instead of uploading by hand, the

Remote source

tab can fetch the document from a Git repository or a URL on a schedule. Choose the Provider, fill in the URL or the Repository, Branch and Path in the repository, and — for a private source — the Auth header and Access token. The token is stored and never shown again; leave the field empty on later saves to keep it.

Poll every (minutes) — at most once every 15 minutes. Polling enabled off keeps the settings but stops the schedule;
Fetch now
still works.
Each fetch produces an import exactly like an upload — same validation, same inertness.
Select a successful fetch automatically — a validated fetch also becomes the selected import for the next publish. It still does not publish anything: putting it in front of readers takes a person pressing Publish.

The contract is in — select it and publish the version 🚀

Next 🤓

API docs: guidesMarkdown pages beside the reference — nesting, order and revisions.