Want to move to PlanetScale? Postgres migration assistance is now available. Get started
Navigation

Consistent path parameters in OpenAPI spec

We've cleaned up the path parameters in our OpenAPI spec to follow a consistent standard across all endpoints.

Previously, we used different parameter names for the same thing, such as organization, organization_name, and name all referring to the organization. Now we consistently use organization everywhere. Same goes for database and branch names.

Here's an example of what changed:

-  /organizations/{name}/cluster-size-skus
+  /organizations/{organization}/cluster-size-skus

- /organizations/{organization}/databases/{database_name}/cidrs
+ /organizations/{organization}/databases/{database}/cidrs

-  /organizations/{name}/regions:
+  /organizations/{organization}/databases:

This won't affect how you use the API, but if you're auto-generating API clients from the spec, you'll get cleaner, more consistent code.

Check out the OpenAPI spec to download the latest version.