supabase-cli/api/README.md

Supabase OpenAPI Specification

This directory contains the OpenAPI specification for Supabase Management APIs.

It is used to automatically generate the Go client and types.

Updating the specification

The specification yaml is generated from our NestJS middleware. The latest release is viewable as Swagger UI.

To make a new release:

1. Update beta.yaml with the latest version from local development

curl -o api/beta.yaml http://127.0.0.1:8080/api/v1-yaml

2. Regenerate the Go client and API types

go generate

3. [Optional] Manually add properties not generated by NestJS