From e1fb0cc719761635ca3b628bbab593856d2e5abd Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 28 Oct 2024 22:58:13 +0000 Subject: [PATCH] feat: update mgmt api docs (#30000) Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com> --- apps/docs/spec/api_v1_openapi.json | 8 +++----- apps/docs/spec/common-api-sections.json | 6 ++++++ .../spec/transforms/api_v1_openapi_deparsed.json | 16 +++------------- 3 files changed, 12 insertions(+), 18 deletions(-) diff --git a/apps/docs/spec/api_v1_openapi.json b/apps/docs/spec/api_v1_openapi.json index 4e1cf38665d..f8b3bbc4bc6 100644 --- a/apps/docs/spec/api_v1_openapi.json +++ b/apps/docs/spec/api_v1_openapi.json @@ -1570,8 +1570,7 @@ }, "500": { "description": "Failed to retrieve project's Postgres config" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "tags": ["Database"] }, "put": { "operationId": "v1-update-postgres-config", @@ -1605,8 +1604,7 @@ "403": { "description": "" }, "500": { "description": "Failed to update project's Postgres config" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "tags": ["Database"] } }, "/v1/projects/{ref}/config/database/pgbouncer": { @@ -1936,7 +1934,7 @@ }, "/v1/projects/{ref}/functions": { "post": { - "operationId": "createFunction", + "operationId": "v1-create-a-function", "summary": "Create a function", "description": "Creates a function and adds it to the specified project.", "parameters": [ diff --git a/apps/docs/spec/common-api-sections.json b/apps/docs/spec/common-api-sections.json index a6f799286de..0d323a5932c 100644 --- a/apps/docs/spec/common-api-sections.json +++ b/apps/docs/spec/common-api-sections.json @@ -225,6 +225,12 @@ "type": "category", "title": "Edge Functions", "items": [ + { + "id": "v1-create-a-function", + "title": "Create a function", + "slug": "v1-create-a-function", + "type": "operation" + }, { "id": "v1-delete-a-function", "title": "Delete a function", diff --git a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json index 0c4c9b65b7f..b8166df0a38 100644 --- a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json +++ b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json @@ -4604,12 +4604,7 @@ "description": "Failed to retrieve project's Postgres config" } }, - "tags": ["Database"], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Database"] }, "put": { "operationId": "v1-update-postgres-config", @@ -4814,12 +4809,7 @@ "description": "Failed to update project's Postgres config" } }, - "tags": ["Database"], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Database"] } }, "/v1/projects/{ref}/config/database/pgbouncer": { @@ -7832,7 +7822,7 @@ }, "/v1/projects/{ref}/functions": { "post": { - "operationId": "createFunction", + "operationId": "v1-create-a-function", "summary": "Create a function", "description": "Creates a function and adds it to the specified project.", "parameters": [