github.com/supabase/cli@v1.168.1/api/README.md (about)

     1  # Supabase OpenAPI Specification
     2  
     3  This directory contains the OpenAPI specification for Supabase Management APIs.
     4  
     5  It is used to automatically generate the Go [client](pkg/api/client.gen.go) and [types](pkg/api/types.gen.go).
     6  
     7  ## Updating the specification
     8  
     9  The specification yaml is generated from our NestJS middleware. The latest release is viewable as [Swagger UI](https://api.supabase.com/api/v1).
    10  
    11  To make a new release:
    12  
    13  1. Update `beta.yaml` with the latest version from local development
    14  
    15  ```bash
    16  curl -o api/beta.yaml http://127.0.0.1:8080/api/v1-yaml
    17  ```
    18  
    19  2. Regenerate the Go client and API types
    20  
    21  ```bash
    22  go generate tools/codegen/main.go
    23  ```
    24  
    25  3. [Optional] Manually add [properties](https://swagger.io/docs/specification/basic-structure/) not generated by NestJS