feat: update mgmt api docs

Author: pull[bot]

apps/docs/CONTRIBUTING.md

@@ -197,15 +197,19 @@ Keep code lines short to avoid scrolling. For example, you can split long shell
 
 Optionally specify a filename for the codeblock by including it after the opening backticks and language specifier:
 
-```md
+````md
 ```ts environment.ts
+
 ```
+````
 
 Optionally highlight lines by using `mark=${lineNumber}`.
 
-```md
+````md
 ```js mark=12:13
+
 ```
+````
 
 ### Footnotes
 
@@ -243,7 +247,7 @@ Don't nest lists more than two deep.
 3. List item
    - List item
    - List item
-   <!-- DON'T ADD ANOTHER LEVEL OF NESTING -->
+     <!-- DON'T ADD ANOTHER LEVEL OF NESTING -->
      - Overly nested list item
 ```
 

apps/docs/content/guides/self-hosting/docker.mdx

@@ -1,13 +1,14 @@
 ---
-title: "Self-Hosting with Docker"
-description: "Learn how to configure and deploy Supabase with Docker."
-subtitle: "Learn how to configure and deploy Supabase with Docker."
-tocVideo: "FqiQKRKsfZE"
+title: 'Self-Hosting with Docker'
+description: 'Learn how to configure and deploy Supabase with Docker.'
+subtitle: 'Learn how to configure and deploy Supabase with Docker.'
+tocVideo: 'FqiQKRKsfZE'
 ---
 
 Docker is the easiest way to get started with self-hosted Supabase. It should only take you a few minutes to get up and running. This guide assumes you are running the command from the machine you intend to host from.
 
 ## Contents
+
 1. [Before you begin](#before-you-begin)
 2. [Installing and running Supabase](#installing-and-running-supabase)
 3. [Accessing your services](#accessing-supabase-studio)
@@ -142,12 +143,14 @@ The default tenant ID is `your-tenant-id`, and the default password is `your-sup
 By default, the database is not accessible from outside the local machine but the pooler is. You can [change this](#exposing-your-postgres-database) by updating the `docker-compose.yml` file.
 
 ## Updating your services
+
 For security reasons, we "pin" the versions of each service in the docker-compose file (these versions are updated ~monthly). If you want to update any services immediately, you can do so by updating the version number in the docker compose file and then running `docker compose pull`. You can find all the latest docker images in the [Supabase Docker Hub](https://hub.docker.com/u/supabase).
 
 You should update your services frequently to get the latest features and bug fixes and security patches. Note that you will need to restart the services to pick up the changes, which will result in some downtime for your services.
 
 **Example**
 You'll want to update the Studio(Dashboard) frequently to get the latest features and bug fixes. To update the Dashboard:
+
 1. Visit the [supabase/studio](https://hub.docker.com/r/supabase/studio/tags) image in the [Supabase Docker Hub](https://hub.docker.com/u/supabase)
 2. Find the latest version (tag) number. It will look something like `20241029-46e1e40`
 3. Update the `image` field in the `docker-compose.yml` file to the new version. It should look like this: `image: supabase/studio:20241028-a265374`
@@ -158,6 +161,7 @@ You'll want to update the Studio(Dashboard) frequently to get the latest feature
 While we provided you with some example secrets for getting started, you should NEVER deploy your Supabase setup using the defaults we have provided. Please follow all of the steps in this section to ensure you have a secure setup, and then [restart all services](#restarting-all-services) to pick up the changes.
 
 ### Generate API keys
+
 We need to generate secure keys for accessing your services. We'll use the `JWT Secret` to generate `anon` and `service` API keys using the form below.
 
 1. **Obtain a Secret**: Use the 40-character secret provided, or create your own. If creating, ensure it's a strong, random string of 40 characters.
@@ -170,8 +174,8 @@ We need to generate secure keys for accessing your services. We'll use the `JWT
 
 Run this form twice to generate new `anon` and `service` API keys. Replace the values in the `./docker/.env` file:
 
-  - `ANON_KEY` - replace with an `anon` key
-  - `SERVICE_ROLE_KEY` - replace with a `service` key
+- `ANON_KEY` - replace with an `anon` key
+- `SERVICE_ROLE_KEY` - replace with a `service` key
 
 You will need to [restart](#restarting-all-services) the services for the changes to take effect.
 
@@ -191,19 +195,20 @@ You will need to [restart](#restarting-all-services) the services for the change
 
 The Dashboard is protected with basic authentication. The default user and password MUST be updated before using Supabase in production.
 Update the following values in the `./docker/.env` file:
- - `DASHBOARD_USERNAME`: The default username for the Dashboard
- - `DASHBOARD_PASSWORD`: The default password for the Dashboard
+
+- `DASHBOARD_USERNAME`: The default username for the Dashboard
+- `DASHBOARD_PASSWORD`: The default password for the Dashboard
 
 You can also add more credentials for multiple users in `./docker/volumes/api/kong.yml`. For example:
 
 ```yaml docker/volumes/api/kong.yml
 basicauth_credentials:
-- consumer: DASHBOARD
-  username: user_one
-  password: password_one
-- consumer: DASHBOARD
-  username: user_two
-  password: password_two
+  - consumer: DASHBOARD
+    username: user_one
+    password: password_one
+  - consumer: DASHBOARD
+    username: user_two
+    password: password_two
 ```
 
 You will need to [restart](#restarting-all-services) the services for the changes to take effect.
@@ -297,23 +302,22 @@ Each system has a number of configuration options which can be found in the rele
 - [Kong](https://docs.konghq.com/gateway/latest/install/docker/)
 - [Supavisor](https://supabase.github.io/supavisor/development/docs/)
 
- These configuration items are generally added to the `env` section of each service, inside the `docker-compose.yml` section. If these configuration items are sensitive, they should be stored in a [secret manager](/docs/guides/self-hosting#managing-your-secrets) or using an `.env` file and then referenced using the `${}` syntax.
-
+These configuration items are generally added to the `env` section of each service, inside the `docker-compose.yml` section. If these configuration items are sensitive, they should be stored in a [secret manager](/docs/guides/self-hosting#managing-your-secrets) or using an `.env` file and then referenced using the `${}` syntax.
 
 <CH.Code>
 
- ```yml docker-compose.yml
+```yml docker-compose.yml
 services:
   rest:
     image: postgrest/postgrest
     environment:
       PGRST_JWT_SECRET: ${JWT_SECRET}
- ```
+```
 
- ```bash .env
- ## Never check your secrets into version control
+```bash .env
+## Never check your secrets into version control
 `${JWT_SECRET}`
- ```
+```
 
 </CH.Code>
 
@@ -341,11 +345,10 @@ We recommend using [AWS SES](https://aws.amazon.com/ses/). It's extremely cheap
 By default all files are stored locally on the server. You can configure the Storage service to use S3 by updating the following environment variables:
 
 ```yaml docker-compose.yml
-  storage:
-    environment:
-      STORAGE_BACKEND=s3
-      GLOBAL_S3_BUCKET=name-of-your-s3-bucket
-      REGION=region-of-your-s3-bucket
+storage:
+  environment: STORAGE_BACKEND=s3
+    GLOBAL_S3_BUCKET=name-of-your-s3-bucket
+    REGION=region-of-your-s3-bucket
 ```
 
 You can find all the available options in the [storage repository](https://github.com/supabase/storage-api/blob/master/.env.sample). Restart the `storage` service to pick up the changes: `docker compose restart storage --no-deps`
@@ -369,9 +372,9 @@ If you need direct access to the Postgres database without going through Supavis
 #  supavisor:
 #    ports:
 # ...
-  db:
-    ports:
-      - ${POSTGRES_PORT}:${POSTGRES_PORT}
+db:
+  ports:
+    - ${POSTGRES_PORT}:${POSTGRES_PORT}
 ```
 
 This is less-secure, so please make sure you are running a firewall in front of your server.
@@ -394,7 +397,6 @@ All data in analytics will be deleted when you run the commands below.
 
 </Admonition>
 
-
 ```sh
 ### Destroy analytics to transition to postgres self hosted solution without other data loss
 
@@ -422,6 +424,7 @@ A minimal setup working on Ubuntu, hosted on DigitalOcean.
 </div>
 
 ### Demo using DigitalOcean
+
 1. A DigitalOcean Droplet with 1 GB memory and 25 GB solid-state drive (SSD) is sufficient to start
 2. To access the Dashboard, use the ipv4 IP address of your Droplet.
 3. If you're unable to access Dashboard, run `docker compose ps` to see if the Studio service is running and healthy.

apps/docs/spec/api_v1_openapi.json

@@ -336,6 +336,25 @@
         "operationId": "v1-list-all-snippets",
         "summary": "Lists SQL snippets for the logged in user",
         "parameters": [
+          { "name": "cursor", "required": false, "in": "query", "schema": { "type": "string" } },
+          {
+            "name": "limit",
+            "required": false,
+            "in": "query",
+            "schema": { "type": "string", "minimum": 1, "maximum": 100 }
+          },
+          {
+            "name": "sort_by",
+            "required": false,
+            "in": "query",
+            "schema": { "enum": ["name", "inserted_at"], "type": "string" }
+          },
+          {
+            "name": "sort_order",
+            "required": false,
+            "in": "query",
+            "schema": { "enum": ["asc", "desc"], "type": "string" }
+          },
           {
             "name": "project_ref",
             "required": false,
@@ -3062,7 +3081,8 @@
       "SnippetList": {
         "type": "object",
         "properties": {
-          "data": { "type": "array", "items": { "$ref": "#/components/schemas/SnippetMeta" } }
+          "data": { "type": "array", "items": { "$ref": "#/components/schemas/SnippetMeta" } },
+          "cursor": { "type": "string" }
         },
         "required": ["data"]
       },

apps/docs/spec/transforms/api_v1_openapi_deparsed.json

@@ -990,6 +990,42 @@
         "operationId": "v1-list-all-snippets",
         "summary": "Lists SQL snippets for the logged in user",
         "parameters": [
+          {
+            "name": "cursor",
+            "required": false,
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "limit",
+            "required": false,
+            "in": "query",
+            "schema": {
+              "type": "string",
+              "minimum": 1,
+              "maximum": 100
+            }
+          },
+          {
+            "name": "sort_by",
+            "required": false,
+            "in": "query",
+            "schema": {
+              "enum": ["name", "inserted_at"],
+              "type": "string"
+            }
+          },
+          {
+            "name": "sort_order",
+            "required": false,
+            "in": "query",
+            "schema": {
+              "enum": ["asc", "desc"],
+              "type": "string"
+            }
+          },
           {
             "name": "project_ref",
             "required": false,
@@ -1087,6 +1123,9 @@
                           "updated_by"
                         ]
                       }
+                    },
+                    "cursor": {
+                      "type": "string"
                     }
                   },
                   "required": ["data"]
@@ -10798,6 +10837,9 @@
                 "updated_by"
               ]
             }
+          },
+          "cursor": {
+            "type": "string"
           }
         },
         "required": ["data"]