mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
Miranda Limonczenko
abbf667084
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## Problem The Docs E2E link checker found broken links throughout docs, starting with `phone-login.mdx` pointing to `/docs/guides/cli/config` (404). Old links like `/docs/guides/cli/config` still work on the live site because `supabase.com` has redirects set up for them, but these links break on the docs preview site, which is what the E2E check tests against. These issues look clean on the live site, and I didn't catch them in my first pass because I was testing production instead of the preview. The E2E check only tests the ~20 pages a given PR happens to touch, so fixing the pages it flagged kept exposing more of the same problem one page at a time as each fix pulled in a new file. To stop chasing this incrementally, I cross-referenced every `/docs/guides/*` and `/docs/reference/*` redirect source in `apps/www/lib/redirects.js` against actual usage across all of `apps/docs`, and verified each candidate against the live preview. ## Solution Rather than updating the Docs E2E link checker, this PR resolves the links. **Why:** we own these docs, so keeping the links clean without redirects is keeping the house maintained. See [Broken Window Theory](https://blog.codinghorror.com/the-broken-window-theory/). Updated every link still using an old path to point straight at the current page instead of relying on a redirect. This covers old links like: - `/docs/guides/cli/config` → `/docs/guides/local-development/cli/config` - `/docs/guides/cli/getting-started` → `/docs/guides/local-development/cli/getting-started` - `/docs/guides/cli/local-development` → `/docs/guides/local-development/database-migrations` - `/docs/guides/cli/managing-environments` → `/docs/guides/deployment/managing-environments` - `/docs/guides/cli/seeding-your-database` → `/docs/guides/local-development/seeding-your-database` - bare `/docs/guides/cli` → `/docs/guides/local-development` - `/docs/guides/platform/compute-add-ons` → `/docs/guides/platform/compute-and-disk` - `/docs/guides/platform/shared-responsibility-model` → `/docs/guides/deployment/shared-responsibility-model` - `/docs/guides/database` → `/docs/guides/database/overview` - `/docs/reference/javascript`, `/docs/reference/dart`, `/docs/reference/kotlin`, `/docs/reference/python`, `/docs/reference/csharp` → their `/introduction` pages (the redirect's own destination, `/start`, turned out to be dead even on production — a separate bug in `redirects.js` I didn't touch here) - and about 35 more of the same pattern, listed in the commit messages Also fixed a handful of dead heading anchors found along the way (links that resolve to the right page but point at a `#section` that got renamed or moved), including the original `#bigquery` anchor and a few in `connecting-to-postgres.mdx` where content moved to its own dedicated page. Left alone on purpose: - `content/guides/cli.mdx` — this page has no route in the docs app at all (no `app/guides/cli/` directory), so it 404s even in production before the `www` redirect ever fires. Fixing its internal link wouldn't change that; it needs an actual routing/content decision, not a link fix. - A few candidates that already resolve fine as-is (`pg_partman`, bare `/docs/reference/api`, bare `/docs/reference/cli`) — confirmed via curl, left untouched. ## Manual testing 1. Confirmed every new link target actually exists by checking the destination file/page and matching heading anchors. 2. Cross-referenced every `/docs/guides/*` and `/docs/reference/*` redirect source in `apps/www/lib/redirects.js` against real usage in `apps/docs`, and curl-verified each old path (404) and new path (200) against the live PR preview before fixing it. 3. Ran the Docs E2E link checker locally against changed pages. 4. Spot-checked the original broken link from CI (`/docs/guides/cli/config`) to confirm it now points to a working page.
74 lines
3.4 KiB
Plaintext
74 lines
3.4 KiB
Plaintext
---
|
|
title = "HTTP status codes"
|
|
topics = [ "platform" ]
|
|
keywords = [ "HTTP" ]
|
|
database_id = "b98c7288-8c38-4dc2-8591-d18ea9eb4cbc"
|
|
|
|
[[errors]]
|
|
http_status_code = 402
|
|
message = "service restriction"
|
|
|
|
[[errors]]
|
|
http_status_code = 540
|
|
message = "project paused"
|
|
|
|
[[errors]]
|
|
http_status_code = 544
|
|
message = "project API gateway timeout"
|
|
|
|
[[errors]]
|
|
http_status_code = 546
|
|
message = "Edge Functions resource limit"
|
|
---
|
|
|
|
The Supabase platform offers several HTTP APIs for each project. These APIs can use the status codes to indicate the state of the project, and the request being processed. The status codes returned for requests can be access via the [logs explorer](../telemetry/logs#logs-explorer).
|
|
|
|
## 2XX success
|
|
|
|
2XX status codes indicate that the request was processed successfully.
|
|
|
|
## 3XX redirects
|
|
|
|
3XX status codes indicate that the client must initiate another course of action to have the request processed successfully. The most popular usage of 3XX codes is to redirect the client to a different location.
|
|
|
|
## 4XX client errors
|
|
|
|
4XX status codes indicate an issue on the client's end with the request being made. These could include missing or invalid auth information, a malformed request, making too many requests in too short a time period ("rate limiting"), or a network issue on the client's end.
|
|
|
|
### 402 service restriction
|
|
|
|
In case the Fair Use Policy is applied, the projects of your organization may be restricted from processing requests. If service restrictions are applied, projects will return a 402 status code together with a description of why the project is restricted. The description can contain one or more of the following codes:
|
|
|
|
- `exceeded_*` indicates that the project has continued to exceeded the usage limits of its quota, e.g. `exceed_egress_quota`, `exceed_db_size_quota`.
|
|
- `overdue_payment` indicates that the organization has overdue bills.
|
|
|
|
You will still have access to your data through the Supabase dashboard when the Fair Use Policy is applied.
|
|
|
|
See the [Fair Use Policy](/docs/guides/platform/billing-faq#fair-use-policy) section to learn more about the restrictions and how to remove them.
|
|
|
|
## 5XX server or project errors
|
|
|
|
5XX status codes indicate that the project was unable to process the request successfully, but not because of an issue with the client's request.
|
|
|
|
5XX status codes can be the result of the project not having enough [compute](/docs/guides/platform/compute-and-disk) to process a complex request being made by a client or not being able to keep up with the volume of requests made against the project.
|
|
|
|
### 54X project errors
|
|
|
|
54X status codes are custom codes used by the Supabase platform to indicate the state of the project.
|
|
|
|
#### 540 project paused
|
|
|
|
The project the request was being made against has been paused. The project cannot process requests until it is un-paused by the owner.
|
|
|
|
Free Plan projects may be paused due to inactivity, on request by the owner, or in rare instances, due to abuse.
|
|
|
|
#### 544 project API gateway timeout
|
|
|
|
The request is not completed within the configured time limit.
|
|
|
|
The timeout limit is set to prevent long-running queries which can cause performance issues, increase latency, and potentially even crash the project.
|
|
|
|
#### 546 Edge Functions resource limit
|
|
|
|
Applies only to Edge Functions. Function execution was stopped due to a resource limit (`WORKER_RESOURCE_LIMIT`). Edge Function logs should provide which [resource limit](/docs/guides/functions/limits) was exceeded.
|