Skip to content
firmus.shdocs

Every page's text, headings and title. Code samples are not indexed.

Status

Current availability, and where incidents are published.

There is no status page yet. There will be one when availability is measured from outside this service; until then a green badge here would be a decoration. It will be linked from here and announced in the changelog.

You will not find an uptime percentage or a latency figure anywhere in this documentation either. Every number here can be checked against something; those two cannot be, yet.

Most of what looks like an outage is a refusal with a name on it, and the response says which — errors has the table. Anything that is not one of those carries an X-Request-Id; keep it in your logs, because it is the fastest way to find the request you are describing.

What is already published

  • RateLimit and RateLimit-Policy on every response, so a client can see how much of its allowance is left without being refused first. Rate limits explains the fields.
  • The contract at GET /v1/openapi, which needs no key — reachable even when your own credentials are the thing in doubt.
  • The register's own publication date on every record, as data_updated_at. If the question is "is the data stale", that field answers it directly and sources & coverage explains what to expect from it.