From f80ec998b3ebfb1b8acdf5b59c49bf8db6cc27ec Mon Sep 17 00:00:00 2001 From: Fendy Heryanto Date: Wed, 28 Jan 2026 10:15:30 +0000 Subject: [PATCH 1/3] remove api tokens from api docs --- packages/nocodb/src/schema/swagger-v3.json | 163 +-------------------- 1 file changed, 1 insertion(+), 162 deletions(-) diff --git a/packages/nocodb/src/schema/swagger-v3.json b/packages/nocodb/src/schema/swagger-v3.json index 6b027dee99..7423ad701a 100644 --- a/packages/nocodb/src/schema/swagger-v3.json +++ b/packages/nocodb/src/schema/swagger-v3.json @@ -19,8 +19,7 @@ "Fields", "View Filters", "View Sorts", - "Scripts", - "API Tokens" + "Scripts" ] }, { @@ -5602,166 +5601,6 @@ } } } - }, - "/api/v3/meta/tokens": { - "get": { - "summary": "List API tokens", - "description": "Retrieve a list of all API tokens for the organization.\n\n**Note**: \nAPI Token APIs are available only with self-hosted **Enterprise** plans and cloud-hosted **Enterprise** plans.\n> **Beta**: These APIs are currently in beta and subject to change in future releases.", - "tags": [ - "API Tokens" - ], - "security": [ - { - "xc-token": [] - } - ], - "responses": { - "200": { - "description": "List of API tokens", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApiTokenV3" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/UnauthorizedV3" - }, - "403": { - "$ref": "#/components/responses/ForbiddenV3" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorV3" - } - } - }, - "post": { - "summary": "Create API token", - "description": "Create a new API token for the organization.\n\n**Note**: API Token APIs are available only with self-hosted **Enterprise** plans and cloud-hosted **Enterprise** plans.\n> **Beta**: These APIs are currently in beta and subject to change in future releases.", - "tags": [ - "API Tokens" - ], - "security": [ - { - "xc-token": [] - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "title" - ], - "properties": { - "title": { - "type": "string", - "description": "Title / description for the API token", - "example": "Github Integration" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Created API token", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenWithTokenV3" - }, - "examples": { - "created": { - "value": { - "id": 5, - "title": "Github Integration", - "token": "wxAFzFO2wwOf9ozVRjragBJ7KPWMaW2OGpklGqHh", - "created_at": "2025-12-30 15:17:24+00:00", - "updated_at": "2025-12-30 15:17:24+00:00" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequestV3" - }, - "401": { - "$ref": "#/components/responses/UnauthorizedV3" - }, - "403": { - "$ref": "#/components/responses/ForbiddenV3" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorV3" - } - } - } - }, - "/api/v3/meta/tokens/{tokenId}": { - "delete": { - "summary": "Delete API token", - "description": "Delete an API token by its ID.\n\n**Note**: API Token APIs are available only with self-hosted **Enterprise** plans and cloud-hosted **Enterprise** plans.\n> **Beta**: These APIs are currently in beta and subject to change in future releases.", - "tags": [ - "API Tokens" - ], - "security": [ - { - "xc-token": [] - } - ], - "parameters": [ - { - "name": "tokenId", - "in": "path", - "required": true, - "description": "ID of the API token to delete", - "schema": { - "type": "string", - "example": "5" - } - } - ], - "responses": { - "200": { - "description": "Deleted API token", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenV3" - } - } - } - }, - "401": { - "$ref": "#/components/responses/UnauthorizedV3" - }, - "403": { - "$ref": "#/components/responses/ForbiddenV3" - }, - "404": { - "$ref": "#/components/responses/NotFoundV3" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorV3" - } - } - } } }, "components": { From fb5922a166dc4cba53b7cf92d004ebd16315af92 Mon Sep 17 00:00:00 2001 From: Fendy Heryanto Date: Wed, 28 Jan 2026 10:15:30 +0000 Subject: [PATCH 2/3] re-add paths --- packages/nocodb/src/schema/swagger-v3.json | 160 +++++++++++++++++++++ 1 file changed, 160 insertions(+) diff --git a/packages/nocodb/src/schema/swagger-v3.json b/packages/nocodb/src/schema/swagger-v3.json index 7423ad701a..1b82c32ff3 100644 --- a/packages/nocodb/src/schema/swagger-v3.json +++ b/packages/nocodb/src/schema/swagger-v3.json @@ -5603,6 +5603,166 @@ } } }, + "/api/v3/meta/tokens": { + "get": { + "summary": "List API tokens", + "description": "Retrieve a list of all API tokens for the organization.\n\n**Note**: \nAPI Token APIs are available only with self-hosted **Enterprise** plans and cloud-hosted **Enterprise** plans.\n> **Beta**: These APIs are currently in beta and subject to change in future releases.", + "tags": [ + "API Tokens" + ], + "security": [ + { + "xc-token": [] + } + ], + "responses": { + "200": { + "description": "List of API tokens", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiTokenV3" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/UnauthorizedV3" + }, + "403": { + "$ref": "#/components/responses/ForbiddenV3" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorV3" + } + } + }, + "post": { + "summary": "Create API token", + "description": "Create a new API token for the organization.\n\n**Note**: API Token APIs are available only with self-hosted **Enterprise** plans and cloud-hosted **Enterprise** plans.\n> **Beta**: These APIs are currently in beta and subject to change in future releases.", + "tags": [ + "API Tokens" + ], + "security": [ + { + "xc-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "title" + ], + "properties": { + "title": { + "type": "string", + "description": "Title / description for the API token", + "example": "Github Integration" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Created API token", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiTokenWithTokenV3" + }, + "examples": { + "created": { + "value": { + "id": 5, + "title": "Github Integration", + "token": "wxAFzFO2wwOf9ozVRjragBJ7KPWMaW2OGpklGqHh", + "created_at": "2025-12-30 15:17:24+00:00", + "updated_at": "2025-12-30 15:17:24+00:00" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/BadRequestV3" + }, + "401": { + "$ref": "#/components/responses/UnauthorizedV3" + }, + "403": { + "$ref": "#/components/responses/ForbiddenV3" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorV3" + } + } + } + }, + "/api/v3/meta/tokens/{tokenId}": { + "delete": { + "summary": "Delete API token", + "description": "Delete an API token by its ID.\n\n**Note**: API Token APIs are available only with self-hosted **Enterprise** plans and cloud-hosted **Enterprise** plans.\n> **Beta**: These APIs are currently in beta and subject to change in future releases.", + "tags": [ + "API Tokens" + ], + "security": [ + { + "xc-token": [] + } + ], + "parameters": [ + { + "name": "tokenId", + "in": "path", + "required": true, + "description": "ID of the API token to delete", + "schema": { + "type": "string", + "example": "5" + } + } + ], + "responses": { + "200": { + "description": "Deleted API token", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiTokenV3" + } + } + } + }, + "401": { + "$ref": "#/components/responses/UnauthorizedV3" + }, + "403": { + "$ref": "#/components/responses/ForbiddenV3" + }, + "404": { + "$ref": "#/components/responses/NotFoundV3" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorV3" + } + } + } + }, "components": { "schemas": { "Base": { From fd7c5d1d36ab1b9b7674dfdc8fbf091e08d29584 Mon Sep 17 00:00:00 2001 From: Fendy Heryanto Date: Wed, 28 Jan 2026 10:15:30 +0000 Subject: [PATCH 3/3] fix formatting --- packages/nocodb/src/schema/swagger-v3.json | 276 ++++++++++----------- 1 file changed, 138 insertions(+), 138 deletions(-) diff --git a/packages/nocodb/src/schema/swagger-v3.json b/packages/nocodb/src/schema/swagger-v3.json index 1b82c32ff3..1324bc5e7e 100644 --- a/packages/nocodb/src/schema/swagger-v3.json +++ b/packages/nocodb/src/schema/swagger-v3.json @@ -5601,164 +5601,164 @@ } } } - } - }, - "/api/v3/meta/tokens": { - "get": { - "summary": "List API tokens", - "description": "Retrieve a list of all API tokens for the organization.\n\n**Note**: \nAPI Token APIs are available only with self-hosted **Enterprise** plans and cloud-hosted **Enterprise** plans.\n> **Beta**: These APIs are currently in beta and subject to change in future releases.", - "tags": [ - "API Tokens" - ], - "security": [ - { - "xc-token": [] - } - ], - "responses": { - "200": { - "description": "List of API tokens", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApiTokenV3" + }, + "/api/v3/meta/tokens": { + "get": { + "summary": "List API tokens", + "description": "Retrieve a list of all API tokens for the organization.\n\n**Note**: \nAPI Token APIs are available only with self-hosted **Enterprise** plans and cloud-hosted **Enterprise** plans.\n> **Beta**: These APIs are currently in beta and subject to change in future releases.", + "tags": [ + "API Tokens" + ], + "security": [ + { + "xc-token": [] + } + ], + "responses": { + "200": { + "description": "List of API tokens", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiTokenV3" + } } } } } } - } - }, - "401": { - "$ref": "#/components/responses/UnauthorizedV3" - }, - "403": { - "$ref": "#/components/responses/ForbiddenV3" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorV3" - } - } - }, - "post": { - "summary": "Create API token", - "description": "Create a new API token for the organization.\n\n**Note**: API Token APIs are available only with self-hosted **Enterprise** plans and cloud-hosted **Enterprise** plans.\n> **Beta**: These APIs are currently in beta and subject to change in future releases.", - "tags": [ - "API Tokens" - ], - "security": [ - { - "xc-token": [] - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "title" - ], - "properties": { - "title": { - "type": "string", - "description": "Title / description for the API token", - "example": "Github Integration" - } - } - } + }, + "401": { + "$ref": "#/components/responses/UnauthorizedV3" + }, + "403": { + "$ref": "#/components/responses/ForbiddenV3" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorV3" } } }, - "responses": { - "200": { - "description": "Created API token", + "post": { + "summary": "Create API token", + "description": "Create a new API token for the organization.\n\n**Note**: API Token APIs are available only with self-hosted **Enterprise** plans and cloud-hosted **Enterprise** plans.\n> **Beta**: These APIs are currently in beta and subject to change in future releases.", + "tags": [ + "API Tokens" + ], + "security": [ + { + "xc-token": [] + } + ], + "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ApiTokenWithTokenV3" - }, - "examples": { - "created": { - "value": { - "id": 5, - "title": "Github Integration", - "token": "wxAFzFO2wwOf9ozVRjragBJ7KPWMaW2OGpklGqHh", - "created_at": "2025-12-30 15:17:24+00:00", - "updated_at": "2025-12-30 15:17:24+00:00" + "type": "object", + "required": [ + "title" + ], + "properties": { + "title": { + "type": "string", + "description": "Title / description for the API token", + "example": "Github Integration" } } } } } }, - "400": { - "$ref": "#/components/responses/BadRequestV3" - }, - "401": { - "$ref": "#/components/responses/UnauthorizedV3" - }, - "403": { - "$ref": "#/components/responses/ForbiddenV3" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorV3" - } - } - } - }, - "/api/v3/meta/tokens/{tokenId}": { - "delete": { - "summary": "Delete API token", - "description": "Delete an API token by its ID.\n\n**Note**: API Token APIs are available only with self-hosted **Enterprise** plans and cloud-hosted **Enterprise** plans.\n> **Beta**: These APIs are currently in beta and subject to change in future releases.", - "tags": [ - "API Tokens" - ], - "security": [ - { - "xc-token": [] - } - ], - "parameters": [ - { - "name": "tokenId", - "in": "path", - "required": true, - "description": "ID of the API token to delete", - "schema": { - "type": "string", - "example": "5" - } - } - ], - "responses": { - "200": { - "description": "Deleted API token", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenV3" + "responses": { + "200": { + "description": "Created API token", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiTokenWithTokenV3" + }, + "examples": { + "created": { + "value": { + "id": 5, + "title": "Github Integration", + "token": "wxAFzFO2wwOf9ozVRjragBJ7KPWMaW2OGpklGqHh", + "created_at": "2025-12-30 15:17:24+00:00", + "updated_at": "2025-12-30 15:17:24+00:00" + } + } + } } } + }, + "400": { + "$ref": "#/components/responses/BadRequestV3" + }, + "401": { + "$ref": "#/components/responses/UnauthorizedV3" + }, + "403": { + "$ref": "#/components/responses/ForbiddenV3" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorV3" + } + } + } + }, + "/api/v3/meta/tokens/{tokenId}": { + "delete": { + "summary": "Delete API token", + "description": "Delete an API token by its ID.\n\n**Note**: API Token APIs are available only with self-hosted **Enterprise** plans and cloud-hosted **Enterprise** plans.\n> **Beta**: These APIs are currently in beta and subject to change in future releases.", + "tags": [ + "API Tokens" + ], + "security": [ + { + "xc-token": [] + } + ], + "parameters": [ + { + "name": "tokenId", + "in": "path", + "required": true, + "description": "ID of the API token to delete", + "schema": { + "type": "string", + "example": "5" + } + } + ], + "responses": { + "200": { + "description": "Deleted API token", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiTokenV3" + } + } + } + }, + "401": { + "$ref": "#/components/responses/UnauthorizedV3" + }, + "403": { + "$ref": "#/components/responses/ForbiddenV3" + }, + "404": { + "$ref": "#/components/responses/NotFoundV3" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorV3" } - }, - "401": { - "$ref": "#/components/responses/UnauthorizedV3" - }, - "403": { - "$ref": "#/components/responses/ForbiddenV3" - }, - "404": { - "$ref": "#/components/responses/NotFoundV3" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorV3" } } }